Get a campaign
get
/services/rest/connect/v1.4/campaigns/{id}
Request
Path Parameters
-
id(required): integer
The unique identifier of the campaign.
Response
Default Response
Root Schema : campaigns
Type:
object
The information on email marketing campaigns created in Oracle B2C Service Outreach Cloud Service.
Show Source
-
actualCost:
object campaigns-actualCost
The monetary value that consists of currency, exchange rate, and value.
-
actualLeads:
[
"integer",
"null"
]
Minimum Value:
0
Maximum Value:2147483647
The number of actual leads generated from the campaign. -
actualOpportunities:
[
"integer",
"null"
]
Minimum Value:
0
Maximum Value:2147483647
The number of actual opportunities generated from the campaign. -
actualSales:
object campaigns-actualSales
The monetary value that consists of currency, exchange rate, and value.
-
assignedToAccount:
[
"object",
"null"
]
The account represents a staff member in Oracle B2C Service. Examples of staff members are customer sales representatives, sales agents, site administrators, and so on. It is the reference to a resource in 'accounts' collection. Only ID or lookupName can be provided to specify the resource.
-
budget:
object campaigns-budget
The monetary value that consists of currency, exchange rate, and value.
-
campaignEndTime:
[
"string",
"null"
]
The date and time when the campaign ends.
-
campaignStartTime:
[
"string",
"null"
]
The date and time when the campaign begins.
-
createdByAccount:
[
"object",
"null"
]
The account represents a staff member in Oracle B2C Service. Examples of staff members are customer sales representatives, sales agents, site administrators, and so on. It is the reference to a resource in 'accounts' collection. Only ID or lookupName can be provided to specify the resource.
-
createdTime:
string
The date and time when the campaign was created. This attribute is read-only.
-
expectedCost:
object campaigns-expectedCost
The monetary value that consists of currency, exchange rate, and value.
-
expectedLeads:
[
"integer",
"null"
]
Minimum Value:
0
Maximum Value:2147483647
The number of expected leads generated from the campaign. -
expectedOpportunities:
[
"integer",
"null"
]
Minimum Value:
0
Maximum Value:2147483647
The number of expected opportunities generated from the campaign. -
expectedSales:
object campaigns-expectedSales
The monetary value that consists of currency, exchange rate, and value.
-
flow:
object namedIDs-campaigns-flow
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.
-
folder:
object campaigns-folder
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.
-
id:
integer
Minimum Value:
1
Maximum Value:9223372036854776000
The unique identifier of the campaign. -
interface:
object interface
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.
-
isSingleExecute:
boolean
Indicates whether the contacts are allowed to flow through the recurring campaign only one time. This attribute does not have a default value.
-
lookupName:
string
Maximum Length:
255
The name used to look up the campaign. -
name:
string
Maximum Length:
80
Pattern:^[^ ]*$
The name of the campaign. -
objectivesSummary:
[
"string",
"null"
]
Maximum Length:
1333
The summary of the objectives specified for the campaign. -
updatedByAccount:
[
"object",
"null"
]
The account represents a staff member in Oracle B2C Service. Examples of staff members are customer sales representatives, sales agents, site administrators, and so on. It is the reference to a resource in 'accounts' collection. Only ID or lookupName can be provided to specify the resource.
-
updatedTime:
string
The date and time when the campaign was last updated. This attribute is read-only.
Nested Schema : campaigns-actualCost
Type:
object
The monetary value that consists of currency, exchange rate, and value.
Show Source
-
currency:
object namedIDs-campaigns-actualCost-currency
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.
-
exchangeRate:
object namedIDs-campaigns-actualCost-exchangeRate
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.
-
value:
number
The value of the currency.
Nested Schema : campaigns-actualSales
Type:
object
The monetary value that consists of currency, exchange rate, and value.
Show Source
-
currency:
object namedIDs-campaigns-actualSales-currency
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.
-
exchangeRate:
object namedIDs-campaigns-actualSales-exchangeRate
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.
-
value:
number
The value of the currency.
Nested Schema : campaigns-budget
Type:
object
The monetary value that consists of currency, exchange rate, and value.
Show Source
-
currency:
object namedIDs-campaigns-budget-currency
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.
-
exchangeRate:
object namedIDs-campaigns-budget-exchangeRate
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.
-
value:
number
The value of the currency.
Nested Schema : campaigns-expectedCost
Type:
object
The monetary value that consists of currency, exchange rate, and value.
Show Source
-
currency:
object namedIDs-campaigns-expectedCost-currency
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.
-
exchangeRate:
object namedIDs-campaigns-expectedCost-exchangeRate
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.
-
value:
number
The value of the currency.
Nested Schema : campaigns-expectedSales
Type:
object
The monetary value that consists of currency, exchange rate, and value.
Show Source
-
currency:
object namedIDs-campaigns-expectedSales-currency
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.
-
exchangeRate:
object namedIDs-campaigns-expectedSales-exchangeRate
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.
-
value:
number
The value of the currency.
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
-
id:
integer
Minimum Value:
0
ID value -
lookupName:
string
Maximum Length:
255
Name used to lookup this object
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
-
id:
integer
Minimum Value:
1
ID value -
lookupName:
string
Maximum Length:
255
Name used to lookup this object -
parents:
object campaigns-folder-parents
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.
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
-
id:
integer
Minimum Value:
0
ID value -
lookupName:
string
Maximum Length:
255
Name used to lookup this object
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
-
id:
integer
Minimum Value:
0
ID value -
lookupName:
string
Maximum Length:
255
Name used to lookup this object
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
-
id:
integer
Minimum Value:
0
ID value -
lookupName:
string
Maximum Length:
255
Name used to lookup this object
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
-
id:
integer
Minimum Value:
0
ID value -
lookupName:
string
Maximum Length:
255
Name used to lookup this object
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
-
id:
integer
Minimum Value:
0
ID value -
lookupName:
string
Maximum Length:
255
Name used to lookup this object
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
-
id:
integer
Minimum Value:
0
ID value -
lookupName:
string
Maximum Length:
255
Name used to lookup this object
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
-
id:
integer
Minimum Value:
0
ID value -
lookupName:
string
Maximum Length:
255
Name used to lookup this object
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
-
id:
integer
Minimum Value:
0
ID value -
lookupName:
string
Maximum Length:
255
Name used to lookup this object
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
-
id:
integer
Minimum Value:
0
ID value -
lookupName:
string
Maximum Length:
255
Name used to lookup this object
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
-
id:
integer
Minimum Value:
0
ID value -
lookupName:
string
Maximum Length:
255
Name used to lookup this object
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
-
id:
integer
Minimum Value:
1
ID value. Read-only -
lookupName:
string
Maximum Length:
255
Name used to lookup this object
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"
}
]
}