Get a campaign

get

/services/rest/connect/v1.4/campaigns/{id}

Request

Path Parameters
Back to Top

Response

Default Response

Body ()
Root Schema : campaigns
Type: object
The information on email marketing campaigns created in Oracle B2C Service Outreach Cloud Service.
Show Source
Nested Schema : campaigns-actualCost
Type: object
The monetary value that consists of currency, exchange rate, and value.
Show Source
Nested Schema : campaigns-actualSales
Type: object
The monetary value that consists of currency, exchange rate, and value.
Show Source
Nested Schema : campaigns-budget
Type: object
The monetary value that consists of currency, exchange rate, and value.
Show Source
Nested Schema : campaigns-expectedCost
Type: object
The monetary value that consists of currency, exchange rate, and value.
Show Source
Nested Schema : campaigns-expectedSales
Type: object
The 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 : interface
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. It is the reference to a resource in 'siteInterfaces' collection. Only ID or lookupName can be provided to specify the resource.
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 : 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
Back to Top

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"
    }
  ]
}
Back to Top