Retrieve an instance of campaigns

get

/services/rest/connect/latest/campaigns/{id}

Request

Path Parameters

Response

Supported Media Types

Default Response

Body ()
Contains information on email marketing campaigns created in Oracle Service Cloud Outreach Cloud Service.
Root Schema : campaigns
Type: object
Contains information on email marketing campaigns created in Oracle Service Cloud Outreach Cloud Service.
Show Source
Nested Schema : campaigns-actualCost
Type: object
Monetary value that consists of currency, exchange rate, and value.
Show Source
Nested Schema : campaigns-actualSales
Type: object
Monetary value that consists of currency, exchange rate, and value.
Show Source
Nested Schema : accounts
Type: object
An account generated for a staff member in the system. Staff accounts are used by CSRs, sales agents, site administrators, etc.
Show Source
Nested Schema : campaigns-budget
Type: object
Monetary value that consists of currency, exchange rate, and value.
Show Source
Nested Schema : campaigns-expectedCost
Type: object
Monetary value that consists of currency, exchange rate, and value.
Show Source
Nested Schema : campaigns-expectedSales
Type: object
Monetary value that consists of currency, exchange rate, and value.
Show Source
Nested Schema : namedIDs-campaigns-flow
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
Nested Schema : campaigns-folder
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
Nested Schema : siteInterfaces
Type: object
The console, windows, and pages used by staff members and customers to access the application and interact with a single knowledge base. The interface name determines the URL for the web site, the name of the system executables, and the .cfg directory name.
Show Source
Nested Schema : namedIDs-campaigns-actualCost-currency
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
Nested Schema : namedIDs-campaigns-actualCost-exchangeRate
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
Nested Schema : namedIDs-campaigns-actualSales-currency
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
Nested Schema : namedIDs-campaigns-actualSales-exchangeRate
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
Nested Schema : accounts-attributes
Type: object
Group of flags which enable certain features or special behaviors on an Account
Show Source
  • Temporarily locks the staff account. You might choose to do this if, for example, a staff member takes a leave of absence. This will also be set automatically if a staff member has exceeded the number of invalid logins or has an expired password.
  • Enables the staff account to modify the email signature.
  • Forces the staff member to change her password the next time she logs in. Note: This flag remains true until the staff member changes her password.
  • Flag that indicates if the staff account is considered an infrequent user seat, as opposed to a full seat.
  • Disables password expiration. This will override any system-wide password expiration configurations.
  • Permanently disables the staff account (for example, when a staff member leaves your organization). Note: The staff account will continue to appear in the tree of the Staff Accounts management console if the Show Disabled setting is on, but you will not be able to clear the Permanently Disable check box if you edit the account. You can reuse the login name of a permanently disabled staff account for a different staff account.
  • Prevents the staff account from being assigned to incidents, answers, opportunities, and tasks
  • Prevents the staff account from being included in the list for filters in reports
  • Flag indicating if the account is a Virtual Account. Read-only
Nested Schema : countries
Type: object
Represents a country object defined in the system.
Show Source
  • Maximum Length: 3
    Pattern: ^[A-Z]{2,3}$
    The two or three character abbreviation for this country.
  • Creation date and time. Read-only
  • Minimum Value: 1
    Maximum Value: 2147483647
    The position of the country in the Countries/Provinces tree and drop-down menu.
  • Minimum Value: 1
    Maximum Value: 9.223372036854776E18
    Primary key identifier
  • Maximum Length: 2
    Pattern: ^[A-Z]{2}$
    The ISO 3166 country code.
  • Maximum Length: 255
    Name used to lookup this object
  • Maximum Length: 80
    Name of the Country in the current interface's language. Read-only.
  • countries-names
    Strings that are language-specific, allowing localization of fields. Like the Label class, but the label text cannot be empty or null. Labels will be assembled in a list that is associated with one particular text field
  • Maximum Length: 10
    Pattern: ^[][+0-9a-zA-Z[:blank:].,()#-/]*$
    used by the Click-to-Dial feature."
  • Maximum Length: 80
    Pattern: ^(([U|L|M][#|A|L|C])|(F.))+$
    A string of twice as many characters as found in the phone number. Two (2) characters are needed to represent every digit or character in the phone number. The first character of the mask describes the target character and the second constrains its type.
  • Maximum Length: 20
    Pattern: ^(([U|L|M][#|A|L|C])|(F.))+$
    A string of twice as many characters as found in the postal code (target). Two (2) characters are needed to represent every digit or character in the postal code. The first character of the mask describes the target character and the second constrains its type.
  • countries-provinces
    Contains information about the provinces in the Countries/Provinces customizable menu.
  • Last updated date and time. Read-only
Nested Schema : namedIDs-accounts-emailNotification
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
Nested Schema : accounts-emails
Type: object
Email address and associated information
Show Source
  • Maximum Length: 80
    Pattern: ^((([-_!#$%&'*+/=?^~`{|}\w]+(\.[.]?[-_!#$%&'*+/=?^~`{|}\w]+)*)|("[^"]+"))@[0-9A-Za-z]+([\-]+[0-9A-Za-z]+)*(\.[0-9A-Za-z]+([\-]+[0-9A-Za-z]+)*)+[; ]*)$
    Email address string
  • namedIDs-accounts-emails-addressType
    An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
  • Maximum Length: 1333
    Pattern: ^( | )*[-]+BEGIN CERTIFICATE[-]+[0-9a-zA-Z+/= ]*[-]+END CERTIFICATE[-]+( | )*$
    Associated public email certificate, used to encrypt outgoing email.
  • Disables the email address
Nested Schema : accounts-name
Type: object
A person's first and last name where both are required
Show Source
  • Maximum Length: 80
    Pattern: ^[^ ]*$
    Given or first name
  • Maximum Length: 80
    Pattern: ^[^ ]*$
    Surname or last name
Nested Schema : accounts-nameFurigana
Type: object
A person's first and last name
Show Source
Nested Schema : accounts-phones
Type: object
A phone number and its ancillary data
Show Source
  • Maximum Length: 40
    Pattern: ^[][+0-9a-zA-Z[:blank:].,()#-/]*$
    Free-form phone number
  • namedIDs-accounts-phones-phoneType
    An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
  • Maximum Length: 40
    Automatically populated with the numerical data from the Number; i.e. if Number contained "1 (406) 522-4200", this field would contain "14065224200". Read-only
Nested Schema : namedIDs-accounts-profile
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
Nested Schema : accounts-salesSettings
Type: object
Sales related information for the account
Show Source
Nested Schema : accounts-serviceSettings
Type: object
Service related information for the account
Show Source
  • Minimum Value: 1
    Maximum Value: 65535
    Port number on which to listen for screen pop alerts destined for the staff account. Used in Citrix and Terminal Services environments where there are multiple agents logged in to different sessions on the same machine.
Nested Schema : namedIDs-accounts-staffGroup
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
Nested Schema : countries-names
Type: object
Strings that are language-specific, allowing localization of fields. Like the Label class, but the label text cannot be empty or null. Labels will be assembled in a list that is associated with one particular text field
Show Source
Nested Schema : countries-provinces
Type: object
Contains information about the provinces in the Countries/Provinces customizable menu.
Show Source
  • Minimum Value: 1
    Maximum Value: 32767
    Display position relative to other provinces associated with the same country.
  • Minimum Value: 1
    Maximum Value: 9.223372036854776E18
    The Province ID.
  • Maximum Length: 255
    The name of the province in the current interface's language. Read-only.
  • countries-provinces-names
    Strings that are language-specific, allowing localization of fields. Like the Label class, but the label text cannot be empty or null. Labels will be assembled in a list that is associated with one particular text field
Nested Schema : namedIDs-countries-names-language
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
Nested Schema : countries-provinces-names
Type: object
Strings that are language-specific, allowing localization of fields. Like the Label class, but the label text cannot be empty or null. Labels will be assembled in a list that is associated with one particular text field
Show Source
Nested Schema : namedIDs-countries-provinces-names-language
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
Nested Schema : namedIDs-accounts-emails-addressType
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
Nested Schema : namedIDs-accounts-phones-phoneType
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
Nested Schema : namedIDs-accounts-salesSettings-defaultCurrency
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
Nested Schema : salesTerritories
Type: object
A specific geographical sales region
Show Source
Nested Schema : namedIDs-salesTerritories-adminVisibleInterfaces
Type: object
Named ID that can be included in a list
Show Source
  • Minimum Value: 1
    Maximum Value: 9.223372036854776E18
    ID value. This is the key for the list entry.
  • Maximum Length: 255
    Name used to lookup this object
Nested Schema : salesTerritories-names
Type: object
Strings that are language-specific, allowing localization of fields. Like the Label class, but the label text cannot be empty or null. Labels will be assembled in a list that is associated with one particular text field
Show Source
Nested Schema : namedIDs-salesTerritories-names-language
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
Nested Schema : namedIDs-campaigns-budget-currency
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
Nested Schema : namedIDs-campaigns-budget-exchangeRate
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
Nested Schema : namedIDs-campaigns-expectedCost-currency
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
Nested Schema : namedIDs-campaigns-expectedCost-exchangeRate
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
Nested Schema : namedIDs-campaigns-expectedSales-currency
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
Nested Schema : namedIDs-campaigns-expectedSales-exchangeRate
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
Nested Schema : campaigns-folder-parents
Type: object
NamedID in which the ID is read-only. Used for hierarchies, where caller can specify the parents by name, but cannot specify the parent IDs.
Show Source
Nested Schema : namedIDs-siteInterfaces-language
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source

Examples

Use GET with the following syntax to retrieve data for a campaign object:

https://your_site_interface/services/rest/connect/version/campaigns/campaign_id

Request URI example

https://mysite.example.com/services/rest/connect/v1.4/campaigns/1

Response body example

{
  "id": 1,
  "lookupName": "Campaign",
  "createdTime": "2008-04-18T16:09:51.000Z",
  "updatedTime": "2008-04-18T16:09:51.000Z",
  "actualCost": {
    "currency": {
      "id": 1,
      "lookupName": "USD"
    },
    "exchangeRate": null
  },
  "actualLeads": null,
  "actualOpportunities": null,
  "actualSales": {
    "currency": {
      "id": 1,
      "lookupName": "USD"
    },
    "exchangeRate": null
  },
  "assignedToAccount": {
    "links": [
      {
        "rel": "self",
        "href": "https://mysite.example.com/services/rest/connect/latest/accounts/2"
      },
      {
        "rel": "canonical",
        "href": "https://mysite.example.com/services/rest/connect/latest/accounts/2"
      },
      {
        "rel": "describedby",
        "href": "https://mysite.example.com/services/rest/connect/latest/metadata-catalog/accounts",
        "mediaType": "application/schema+json"
      }
    ]
  },
  "budget": {
    "currency": {
      "id": 1,
      "lookupName": "USD"
    },
    "exchangeRate": null
  },
  "campaignStartTime": null,
  "campaignEndTime": null,
  "createdByAccount": {
    "links": [
      {
        "rel": "self",
        "href": "https://mysite.example.com/services/rest/connect/latest/accounts/2"
      },
      {
        "rel": "canonical",
        "href": "https://mysite.example.com/services/rest/connect/latest/accounts/2"
      },
      {
        "rel": "describedby",
        "href": "https://mysite.example.com/services/rest/connect/latest/metadata-catalog/accounts",
        "mediaType": "application/schema+json"
      }
    ]
  },
  "expectedCost": {
    "currency": {
      "id": 1,
      "lookupName": "USD"
    },
    "exchangeRate": null
  },
  "expectedLeads": null,
  "expectedOpportunities": null,
  "expectedSales": {
    "currency": {
      "id": 1,
      "lookupName": "USD"
    },
    "exchangeRate": null
  },
  "flow": {
    "id": 2,
    "lookupName": "2"
  },
  "folder": null,
  "interface": {
    "links": [
      {
        "rel": "self",
        "href": "https://mysite.example.com/services/rest/connect/latest/siteInterfaces/1"
      },
      {
        "rel": "canonical",
        "href": "https://mysite.example.com/services/rest/connect/latest/siteInterfaces/1"
      },
      {
        "rel": "describedby",
        "href": "https://mysite.example.com/services/rest/connect/latest/metadata-catalog/siteInterfaces",
        "mediaType": "application/schema+json"
      }
    ]
  },
  "isSingleExecute": false,
  "name": "Campaign",
  "objectivesSummary": null,
  "updatedByAccount": {
    "links": [
      {
        "rel": "self",
        "href": "https://mysite.example.com/services/rest/connect/latest/accounts/2"
      },
      {
        "rel": "canonical",
        "href": "https://mysite.example.com/services/rest/connect/latest/accounts/2"
      },
      {
        "rel": "describedby",
        "href": "https://mysite.example.com/services/rest/connect/latest/metadata-catalog/accounts",
        "mediaType": "application/schema+json"
      }
    ]
  },
  "links": [
    {
      "rel": "self",
      "href": "https://mysite.example.com/services/rest/connect/latest/campaigns/1"
    },
    {
      "rel": "canonical",
      "href": "https://mysite.example.com/services/rest/connect/latest/campaigns/1"
    },
    {
      "rel": "describedby",
      "href": "https://mysite.example.com/services/rest/connect/latest/metadata-catalog/campaigns",
      "mediaType": "application/schema+json"
    }
  ]
}