Jump to

• Request
• Response
• Examples

Get all campaigns

get

/crmRestApi/resources/11.13.18.05/campaigns

Request

Query Parameters

• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • CampaignNumberAltKey: Finds a campaign with the specified alternate key.
    Finder Variables:
    • CampaignNumber; string; The alternate key identifier of the campaign.
  • PrimaryKey: Finds a campaign with the specified primary key.
    Finder Variables:
    • CampaignId; integer; The unique identifier of the campaign.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • ActualCost; number; The actual cost of the campaign.
  • BudgetedCost; number; The budgeted cost of the campaign.
  • CampaignCategory; string; The category of the campaign.
  • CampaignCreatedBy; string; The user who created the campaign record.
  • CampaignCreationDate; string; The date when the campaign record was created.
  • CampaignId; integer; The unique identifier of the campaign.
  • CampaignLastUpdateDate; string; The date when the campaign record was last updated.
  • CampaignLastUpdatedBy; string; The user who last updated the campaign record.
  • CampaignName; string; The name of the campaign.
  • CampaignNumber; string; The alternate key identifier of the campaign.
  • CampaignOrigin; string; The origin of the campaign.
  • CampaignType; string; The type of the campaign.
  • CampaignTypeMeaning; string; The display value of the type of the campaign.
  • CreatedByModule; string; The module through which the campaign was created.
  • CreationDate; string; The date when the campaign was created.
  • CurrencyCode; string; The code indicating the currency associated with the campaign, such as USD or GBP.
  • EndDate; string; The date when campaign ended.
  • LastUpdateDate; string; The date when the campaign was last updated.
  • OwnerId; integer; The unique identifier of the owner of the campaign.
  • OwnerPartyNumber; string; The unique alternate identifier of the owner of the campaign.
  • ParentCampaignId; integer; The unique identifier of the parent campaign.
  • ParentCampaignName; string; The name of the parent of the campaign.
  • ParentCampaignNumber; string; The unique alternate identifier of the parent of the campaign.
  • ProductDescription; string; A brief description of the product of the campaign.
  • RegionCode; string; The code indicating the region of the campaign.
  • SalesTargetCampaignStage; string; The code indicating the stage of sales target campaign.
  • SourceSystemCampaignId; string; The unique identifier of the campaign in the source system.
  • StartDate; string; The date when the campaign started.
  • Status; string; The status of the campaign.
  • StatusLookupMeaning; string; The display label of the status of the campaign.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : campaigns

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/campaigns-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"OEC"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object campaigns-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/campaigns-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : campaigns-item-response

Type: object

Show Source

• ActualCost: number
  Title: Actual Cost

  The actual cost of the campaign.
• BudgetedCost: number
  Title: Budgeted Cost

  The budgeted cost of the campaign.
• CampaignAccountAttributionCriteria: array Campaign Account Attribution Criteria
  Title: Campaign Account Attribution Criteria

  The campaign account attribution criteria resource is used to view, create, update, and delete the campaign accounts attribution criteria associated with a sales target campaign.
• CampaignAccounts: array Campaign Accounts
  Title: Campaign Accounts

  The campaign accounts resource is used to view, create, update, and delete the accounts associated with a sales target campaign.
• CampaignCategory: string
  Title: Category

  Maximum Length: 30

  Default Value: ORA_MARKETING

  The category of the campaign.
• CampaignCreatedBy: string
  Title: Campaign Created By

  Maximum Length: 64

  The user who created the campaign record.
• CampaignCreationDate: string (date-time)
  Title: Campaign Creation Date

  The date when the campaign record was created.
• CampaignId: integer (int64)
  Title: Campaign ID

  The unique identifier of the campaign.
• CampaignLastUpdateDate: string (date-time)
  Title: Campaign Last Update Date

  The date when the campaign record was last updated.
• CampaignLastUpdatedBy: string
  Title: Campaign Last Updated By

  Maximum Length: 64

  The user who last updated the campaign record.
• CampaignName: string
  Title: Name

  Maximum Length: 100

  The name of the campaign.
• CampaignNumber: string
  Title: Campaign Number

  Maximum Length: 30

  The alternate key identifier of the campaign.
• CampaignOrigin: string
  Title: Origin

  Maximum Length: 30

  Default Value: MKT_CAMPAIGN

  The origin of the campaign.
• CampaignProducts: array Campaign Products
  Title: Campaign Products

  The campaign products resource is used to view, create, update, and delete the products or product groups associated with a sales target campaign.
• CampaignRollup: array Campaign Rollups
  Title: Campaign Rollups

  The campaign rollup resource is used to view a campaign rollup.
• CampaignTeam: array Campaign Teams
  Title: Campaign Teams

  The campaign teams resource is used to view, create, update, and delete the resources associated with a sales target campaign.
• CampaignType: string
  Title: Type

  Maximum Length: 30

  The type of the campaign.
• CampaignTypeMeaning: string
  Title: Type

  Read Only: true

  Maximum Length: 80

  The display value of the type of the campaign.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the campaign.
• CreatedByModule: string
  Title: Created by Module

  Maximum Length: 60

  Default Value: ORA_WS

  The module through which the campaign was created.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the campaign was created.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 15

  The code indicating the currency associated with the campaign, such as USD or GBP.
• DeleteFlag: boolean
  Title: Can Be Deleted

  Read Only: true

  Indicates whether the campaign can be deleted by the logged in user.
• Description: string
  Title: Description

  Maximum Length: 2000

  A brief description of the campaign.
• EndDate: string (date-time)
  Title: End Date

  The date when campaign ended.
• LastUpdateDate: string (date-time)
  Title: Last Updated

  Read Only: true

  The date when the campaign was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the campaign.
• LastUpdateLogin: string
  Title: Last Updated Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the campaign.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MktCampaignMembers: array Campaign Members
  Title: Campaign Members

  The campaign members resource is used to view the members associated with a sales campaign.
• NumberOfAssociatedAccounts: number
  Title: Number of Accounts

  The number of accounts associated to sales target campaign.
• NumberOfLeadsErrored: number
  Title: Number of Lead Generation Errors

  The number of leads errored for a given sales target campaign.
• NumberOfLeadsGenerated: number
  Title: Number of Leads Generated

  The number of leads generated for a given sales target campaign.
• OwnerId: integer (int64)
  Title: Owner ID

  The unique identifier of the owner of the campaign.
• OwnerPartyName: string
  Title: Owner

  Maximum Length: 360

  The name of the party associated with the campaign owner.
• OwnerPartyNumber: string
  Title: Owner Number

  Read Only: true

  Maximum Length: 30

  The unique alternate identifier of the owner of the campaign.
• ParentCampaignId: integer (int64)
  Title: Parent Campaign ID

  The unique identifier of the parent campaign.
• ParentCampaignName: string
  Title: Parent Campaign Name

  Read Only: true

  Maximum Length: 100

  The name of the parent of the campaign.
• ParentCampaignNumber: string
  Title: Parent Campaign Number

  Read Only: true

  Maximum Length: 30

  The unique alternate identifier of the parent of the campaign.
• ProductDescription: string
  Title: Product Description

  Maximum Length: 100

  A brief description of the product of the campaign.
• RegionCode: string
  Title: Region Code

  Maximum Length: 100

  The code indicating the region of the campaign.
• SalesContents: array Sales Contents
  Title: Sales Contents

  The sales contents resource is used to view, create, update, and delete the sales content associated with a sales target campaign.
• SalesTargetCampaignDaysToVerify: integer (int32)
  Title: Validation Period in Days

  The period in days during which the generated sales target leads should be validated.
• SalesTargetCampaignEloquaSyncDate: string (date-time)
  Title: Last Sync to Marketing Date

  The date on which this sales target campaign is synced to Eloqua for the first time.
• SalesTargetCampaignStage: string
  Title: Stage

  Maximum Length: 32

  The code indicating the stage of sales target campaign.
• SalesTargetLeadsCreationDate: string (date-time)
  Title: Last Lead Generation Date

  The date on which the sales target leads for this campaign was last generated.
• smartActions: array Smart Actions
  Title: Smart Actions

  The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
• SourceSystemCampaignId: string
  Title: Source System Campaign ID

  Maximum Length: 100

  The unique identifier of the campaign in the source system.
• SourceSystemEmailId: integer (int64)
  The unique identifier of the Email in the source system.
• SourceSystemLandingPageId: integer (int64)
  The unique identifier of the Landing Page in the source system.
• SourceSystemSegmentId: integer (int64)
  The unique identifier of the Segment in the source system.
• SourceSystemSharedListId: integer (int64)
  The unique identifier of the Shared List in the source system.
• StartDate: string (date-time)
  Title: Start Date

  The date when the campaign started.
• Status: string
  Title: Status

  Maximum Length: 30

  Default Value: ORA_DRAFT

  The status of the campaign.
• StatusLookupMeaning: string
  Title: Status

  Read Only: true

  Maximum Length: 80

  The display label of the status of the campaign.
• UpdateFlag: boolean
  Title: Can Be Updated

  Read Only: true

  Indicates whether the campaign can be updated by the logged in user.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the campaign was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RegionCode":{
            "title":"Region Code",
            "maxLength":"100",
            "type":"string",
            "description":"The code indicating the region of the campaign.",
            "nullable":true,
            "x-queryable":true
        },
        "NumberOfAssociatedAccounts":{
            "title":"Number of Accounts",
            "type":"number",
            "description":"The number of accounts associated to sales target campaign.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceSystemLandingPageId":{
            "type":"integer",
            "description":"The unique identifier of the Landing Page in the source system.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "CampaignCreationDate":{
            "title":"Campaign Creation Date",
            "type":"string",
            "description":"The date when the campaign record was created.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "smartActions":{
            "title":"Smart Actions",
            "type":"array",
            "description":"The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
            "items":{
                "$ref":"#/components/schemas/campaigns-smartActions-item-response"
            }
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The code indicating the currency associated with the campaign, such as USD or GBP.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the campaign started.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "SourceSystemSegmentId":{
            "type":"integer",
            "description":"The unique identifier of the Segment in the source system.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ParentCampaignName":{
            "title":"Parent Campaign Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the parent of the campaign.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesTargetLeadsCreationDate":{
            "title":"Last Lead Generation Date",
            "type":"string",
            "description":"The date on which the sales target leads for this campaign was last generated.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "CampaignNumber":{
            "title":"Campaign Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the campaign.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CreatedByModule":{
            "title":"Created by Module",
            "maxLength":"60",
            "type":"string",
            "description":"The module through which the campaign was created.",
            "nullable":false,
            "default":"ORA_WS",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SourceSystemCampaignId":{
            "title":"Source System Campaign ID",
            "maxLength":"100",
            "type":"string",
            "description":"The unique identifier of the campaign in the source system.",
            "nullable":true,
            "x-queryable":true
        },
        "CampaignProducts":{
            "title":"Campaign Products",
            "type":"array",
            "description":"The campaign products resource is used to view, create, update, and delete the products or product groups associated with a sales target campaign.",
            "items":{
                "$ref":"#/components/schemas/campaigns-CampaignProducts-item-response"
            }
        },
        "BudgetedCost":{
            "title":"Budgeted Cost",
            "type":"number",
            "description":"The budgeted cost of the campaign.",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "scale":"2"
            },
            "x-queryable":true
        },
        "CampaignType":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the campaign.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the campaign.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ParentCampaignNumber":{
            "title":"Parent Campaign Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unique alternate identifier of the parent of the campaign.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the campaign.",
            "nullable":false,
            "default":"ORA_DRAFT",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SalesContents":{
            "title":"Sales Contents",
            "type":"array",
            "description":"The sales contents resource is used to view, create, update, and delete the sales content associated with a sales target campaign.",
            "items":{
                "$ref":"#/components/schemas/campaigns-SalesContents-item-response"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the campaign.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CampaignRollup":{
            "title":"Campaign Rollups",
            "type":"array",
            "description":"The campaign rollup resource is used to view a campaign rollup.",
            "items":{
                "$ref":"#/components/schemas/campaigns-CampaignRollup-item-response"
            },
            "x-cardinality":"1"
        },
        "OwnerPartyName":{
            "title":"Owner",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the party associated with the campaign owner.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "NumberOfLeadsErrored":{
            "title":"Number of Lead Generation Errors",
            "type":"number",
            "description":"The number of leads errored for a given sales target campaign.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceSystemSharedListId":{
            "type":"integer",
            "description":"The unique identifier of the Shared List in the source system.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "CampaignAccounts":{
            "title":"Campaign Accounts",
            "type":"array",
            "description":"The campaign accounts resource is used to view, create, update, and delete the accounts associated with a sales target campaign.",
            "items":{
                "$ref":"#/components/schemas/campaigns-CampaignAccounts-item-response"
            }
        },
        "DeleteFlag":{
            "title":"Can Be Deleted",
            "type":"boolean",
            "description":"Indicates whether the campaign can be deleted by the logged in user.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CampaignTeam":{
            "title":"Campaign Teams",
            "type":"array",
            "description":"The campaign teams resource is used to view, create, update, and delete the resources associated with a sales target campaign.",
            "items":{
                "$ref":"#/components/schemas/campaigns-CampaignTeam-item-response"
            }
        },
        "LastUpdateLogin":{
            "title":"Last Updated Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the campaign.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Description":{
            "title":"Description",
            "maxLength":"2000",
            "type":"string",
            "description":"A brief description of the campaign.",
            "nullable":true,
            "x-queryable":false
        },
        "OwnerPartyNumber":{
            "title":"Owner Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unique alternate identifier of the owner of the campaign.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CampaignTypeMeaning":{
            "title":"Type",
            "maxLength":"80",
            "type":"string",
            "description":"The display value of the type of the campaign.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesTargetCampaignDaysToVerify":{
            "title":"Validation Period in Days",
            "type":"integer",
            "description":"The period in days during which the generated sales target leads should be validated.",
            "format":"int32",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "CampaignName":{
            "title":"Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the campaign.",
            "nullable":false,
            "x-queryable":true
        },
        "SalesTargetCampaignEloquaSyncDate":{
            "title":"Last Sync to Marketing Date",
            "type":"string",
            "description":"The date on which this sales target campaign is synced to Eloqua for the first time.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "CampaignCategory":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"The category of the campaign.",
            "nullable":true,
            "default":"ORA_MARKETING",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CampaignCreatedBy":{
            "title":"Campaign Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the campaign record.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "<",
                    "<=",
                    ">",
                    ">=",
                    "BETWEEN",
                    "NOTBETWEEN",
                    "CONTAINS",
                    "DOESNOTCONTAIN"
                ]
            },
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Can Be Updated",
            "type":"boolean",
            "description":"Indicates whether the campaign can be updated by the logged in user.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OwnerId":{
            "title":"Owner ID",
            "type":"integer",
            "description":"The unique identifier of the owner of the campaign.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "RecentItemEntityName":"resources"
            },
            "x-queryable":true
        },
        "CampaignId":{
            "title":"Campaign ID",
            "type":"integer",
            "description":"The unique identifier of the campaign.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ParentCampaignId":{
            "title":"Parent Campaign ID",
            "type":"integer",
            "description":"The unique identifier of the parent campaign.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CampaignLastUpdatedBy":{
            "title":"Campaign Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the campaign record.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "<",
                    "<=",
                    ">",
                    ">=",
                    "BETWEEN",
                    "NOTBETWEEN",
                    "CONTAINS",
                    "DOESNOTCONTAIN"
                ]
            },
            "x-queryable":true
        },
        "MktCampaignMembers":{
            "title":"Campaign Members",
            "type":"array",
            "description":"The campaign members resource is used to view the members associated with a sales campaign.",
            "items":{
                "$ref":"#/components/schemas/campaigns-MktCampaignMembers-item-response"
            }
        },
        "StatusLookupMeaning":{
            "title":"Status",
            "maxLength":"80",
            "type":"string",
            "description":"The display label of the status of the campaign.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NumberOfLeadsGenerated":{
            "title":"Number of Leads Generated",
            "type":"number",
            "description":"The number of leads generated for a given sales target campaign.",
            "nullable":true,
            "x-queryable":false
        },
        "CampaignOrigin":{
            "title":"Origin",
            "maxLength":"30",
            "type":"string",
            "description":"The origin of the campaign.",
            "nullable":true,
            "default":"MKT_CAMPAIGN",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CampaignAccountAttributionCriteria":{
            "title":"Campaign Account Attribution Criteria",
            "type":"array",
            "description":"The campaign account attribution criteria resource is used to view, create, update, and delete the campaign accounts attribution criteria associated with a sales target campaign.",
            "items":{
                "$ref":"#/components/schemas/campaigns-CampaignAccountAttributionCriteria-item-response"
            }
        },
        "SalesTargetCampaignStage":{
            "title":"Stage",
            "maxLength":"32",
            "type":"string",
            "description":"The code indicating the stage of sales target campaign.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ActualCost":{
            "title":"Actual Cost",
            "type":"number",
            "description":"The actual cost of the campaign.",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "scale":"2"
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when campaign ended.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "SourceSystemEmailId":{
            "type":"integer",
            "description":"The unique identifier of the Email in the source system.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "CampaignLastUpdateDate":{
            "title":"Campaign Last Update Date",
            "type":"string",
            "description":"The date when the campaign record was last updated.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ProductDescription":{
            "title":"Product Description",
            "maxLength":"100",
            "type":"string",
            "description":"A brief description of the product of the campaign.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated",
            "type":"string",
            "description":"The date when the campaign was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Campaign Account Attribution Criteria

Type: array

Title: Campaign Account Attribution Criteria

The campaign account attribution criteria resource is used to view, create, update, and delete the campaign accounts attribution criteria associated with a sales target campaign.

Show Source

• Array of: object campaigns-CampaignAccountAttributionCriteria-item-response

{
    "title":"Campaign Account Attribution Criteria",
    "type":"array",
    "description":"The campaign account attribution criteria resource is used to view, create, update, and delete the campaign accounts attribution criteria associated with a sales target campaign.",
    "items":{
        "$ref":"#/components/schemas/campaigns-CampaignAccountAttributionCriteria-item-response"
    }
}

Nested Schema : Campaign Accounts

Type: array

Title: Campaign Accounts

The campaign accounts resource is used to view, create, update, and delete the accounts associated with a sales target campaign.

Show Source

• Array of: object campaigns-CampaignAccounts-item-response

{
    "title":"Campaign Accounts",
    "type":"array",
    "description":"The campaign accounts resource is used to view, create, update, and delete the accounts associated with a sales target campaign.",
    "items":{
        "$ref":"#/components/schemas/campaigns-CampaignAccounts-item-response"
    }
}

Nested Schema : Campaign Products

Type: array

Title: Campaign Products

The campaign products resource is used to view, create, update, and delete the products or product groups associated with a sales target campaign.

Show Source

• Array of: object campaigns-CampaignProducts-item-response

{
    "title":"Campaign Products",
    "type":"array",
    "description":"The campaign products resource is used to view, create, update, and delete the products or product groups associated with a sales target campaign.",
    "items":{
        "$ref":"#/components/schemas/campaigns-CampaignProducts-item-response"
    }
}

Nested Schema : Campaign Rollups

Type: array

Title: Campaign Rollups

The campaign rollup resource is used to view a campaign rollup.

Show Source

• Array of: object campaigns-CampaignRollup-item-response

{
    "title":"Campaign Rollups",
    "type":"array",
    "description":"The campaign rollup resource is used to view a campaign rollup.",
    "items":{
        "$ref":"#/components/schemas/campaigns-CampaignRollup-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Campaign Teams

Type: array

Title: Campaign Teams

The campaign teams resource is used to view, create, update, and delete the resources associated with a sales target campaign.

Show Source

• Array of: object campaigns-CampaignTeam-item-response

{
    "title":"Campaign Teams",
    "type":"array",
    "description":"The campaign teams resource is used to view, create, update, and delete the resources associated with a sales target campaign.",
    "items":{
        "$ref":"#/components/schemas/campaigns-CampaignTeam-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Campaign Members

Type: array

Title: Campaign Members

The campaign members resource is used to view the members associated with a sales campaign.

Show Source

• Array of: object campaigns-MktCampaignMembers-item-response

{
    "title":"Campaign Members",
    "type":"array",
    "description":"The campaign members resource is used to view the members associated with a sales campaign.",
    "items":{
        "$ref":"#/components/schemas/campaigns-MktCampaignMembers-item-response"
    }
}

Nested Schema : Sales Contents

Type: array

Title: Sales Contents

The sales contents resource is used to view, create, update, and delete the sales content associated with a sales target campaign.

Show Source

• Array of: object campaigns-SalesContents-item-response

{
    "title":"Sales Contents",
    "type":"array",
    "description":"The sales contents resource is used to view, create, update, and delete the sales content associated with a sales target campaign.",
    "items":{
        "$ref":"#/components/schemas/campaigns-SalesContents-item-response"
    }
}

Nested Schema : Smart Actions

Type: array

Title: Smart Actions

The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.

Show Source

• Array of: object campaigns-smartActions-item-response

{
    "title":"Smart Actions",
    "type":"array",
    "description":"The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
    "items":{
        "$ref":"#/components/schemas/campaigns-smartActions-item-response"
    }
}

Nested Schema : campaigns-CampaignAccountAttributionCriteria-item-response

Type: object

Show Source

• CampaignAccountAttrCriteriaId: integer (int64)
  Title: Campaign Attribution Criteria ID

  The unique identifier of the campaign account attribution criterion.
• CampaignAccountAttrCriteriaNumber: string
  Title: Campaign Attribution Criteria Number

  Maximum Length: 30

  The alternate key identifier of the account attribution criterion.
• CampaignCampaignNumber: string
  Title: Campaign Number

  Read Only: true

  Maximum Length: 30

  The unique identifier of the campaign to which the campaign account attribution criterion belongs to.
• CampaignId: integer (int64)
  Title: Campaign Identifier

  The unique identifier of the campaign account.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the campaign account attribution criteria.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the campaign account attribution criteria was created.
• CriteriaExpression: string (byte)
  Title: Criteria Expression

  This contains the query expression of criteria chosen on UI.
• CriteriaType: string
  Title: Criteria Type

  Maximum Length: 30

  Indicates whether the criteria defined is inclusion or exclusion.
• ExclusionCriteriaFlag: boolean
  Title: Is Exclusion Criteria

  Maximum Length: 1

  Default Value: false

  Indicates whether the Account Attribution criteria is for excluding any account or not.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the campaign account attribution criteria was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the campaign account attribution criteria.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SourceObjectAttr: string
  Title: Source Object Attribute

  Maximum Length: 150

  The attribute that holds source object Id value.
• SourceObjectCode: string
  Title: Source Object

  Maximum Length: 30

  The language independent code for an object name.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the campaign account attribution criteria.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the campaign account attribution criteria was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the campaign account attribution criteria.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CampaignAccountAttrCriteriaNumber":{
            "title":"Campaign Attribution Criteria Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the account attribution criterion.",
            "nullable":false,
            "x-queryable":true
        },
        "ExclusionCriteriaFlag":{
            "title":"Is Exclusion Criteria",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the Account Attribution criteria is for excluding any account or not.",
            "nullable":true,
            "default":false,
            "x-queryable":false
        },
        "CriteriaExpression":{
            "title":"Criteria Expression",
            "type":"string",
            "description":"This contains the query expression of criteria chosen on UI.",
            "format":"byte",
            "nullable":false,
            "x-queryable":false
        },
        "CampaignId":{
            "title":"Campaign Identifier",
            "type":"integer",
            "description":"The unique identifier of the campaign account.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SourceObjectCode":{
            "title":"Source Object",
            "maxLength":"30",
            "type":"string",
            "description":"The language independent code for an object name.",
            "nullable":false,
            "x-queryable":true
        },
        "CampaignCampaignNumber":{
            "title":"Campaign Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the campaign to which the campaign account attribution criterion belongs to.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CriteriaType":{
            "title":"Criteria Type",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates whether the criteria defined is inclusion or exclusion.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SourceObjectAttr":{
            "title":"Source Object Attribute",
            "maxLength":"150",
            "type":"string",
            "description":"The attribute that holds source object Id value.",
            "nullable":false,
            "x-queryable":true
        },
        "CampaignAccountAttrCriteriaId":{
            "title":"Campaign Attribution Criteria ID",
            "type":"integer",
            "description":"The unique identifier of the campaign account attribution criterion.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the campaign account attribution criteria was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : campaigns-CampaignAccounts-item-response

Type: object

Show Source

• AccountCountry: string
  Title: Country

  Read Only: true

  The country of the account.
• AccountId: integer (int64)
  Title: Campaign Account Party ID

  The unique identifier of the account associated with the campaign account.
• AccountIndustryClassCode: string
  Title: Primary Industry

  Read Only: true

  The primary industry class code for the account.
• AccountName: string
  Title: Name

  Read Only: true

  Maximum Length: 360

  The name of the account party associated with the campaign account.
• AccountPartyNumber: string
  Title: Registry ID

  Read Only: true

  Maximum Length: 30

  The unique alternate identifier of the account associated with the campaign account.
• AccountState: string
  Title: State

  Read Only: true

  Maximum Length: 60

  The state of the account.
• AccountTotalEmployees: number
  Title: Company Size

  Read Only: true

  The total number of employees for the account.
• CampaignAccountId: integer (int64)
  Title: Campaign Account ID

  The unique identifier of the campaign account.
• CampaignAccountNumber: string
  Title: Campaign Account Number

  Maximum Length: 30

  The alternate key identifier of the campaign account.
• CampaignId: integer (int64)
  Title: Campaign Identifier

  The unique identifier of the campaign.
• CampaignNumber: string
  Title: Campaign Number

  Maximum Length: 30

  The unique identifier of the campaign to which the campaign account belongs to.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the campaign accounts.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the campaign account was created.
• ErrorDescription: string
  Title: Error Description

  Maximum Length: 2000

  This contains the error message generated during lead generation of this account.
• LastUpdateDate: string (date-time)
  Title: Last Updated

  Read Only: true

  The date when the campaign account was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the campaign account.
• LeadId: integer (int64)
  Title: Lead ID

  The unique identifier of the lead associated with the campaign account.
• LeadName: string
  Title: Lead Name

  Read Only: true

  Maximum Length: 250

  The name of the lead associated with the campaign account.
• LeadNumber: string
  Title: Lead Number

  Maximum Length: 30

  The unique alternate identifier of the lead associated with the campaign account.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• QueryCriteriaType: string
  Title: Query Criteria Type

  Maximum Length: 10

  Default Value: MANUAL

  This indicates whether the account is added by query builder or manually.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the campaign account.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ErrorDescription":{
            "title":"Error Description",
            "maxLength":"2000",
            "type":"string",
            "description":"This contains the error message generated during lead generation of this account.",
            "nullable":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the campaign account was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountCountry":{
            "title":"Country",
            "type":"string",
            "description":"The country of the account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "AccountCountryCode"
                ]
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the campaign accounts.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "AccountId":{
            "title":"Campaign Account Party ID",
            "type":"integer",
            "description":"The unique identifier of the account associated with the campaign account.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LeadNumber":{
            "title":"Lead Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unique alternate identifier of the lead associated with the campaign account.",
            "nullable":false,
            "x-queryable":true
        },
        "AccountState":{
            "title":"State",
            "maxLength":"60",
            "type":"string",
            "description":"The state of the account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"PartySiteEO.State",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"State"
            }
        },
        "QueryCriteriaType":{
            "title":"Query Criteria Type",
            "maxLength":"10",
            "type":"string",
            "description":"This indicates whether the account is added by query builder or manually.",
            "nullable":false,
            "default":"MANUAL",
            "x-queryable":false
        },
        "AccountIndustryClassCode":{
            "title":"Primary Industry",
            "type":"string",
            "description":"The primary industry class code for the account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AccountPartyNumber":{
            "title":"Registry ID",
            "maxLength":"30",
            "type":"string",
            "description":"The unique alternate identifier of the account associated with the campaign account.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CampaignAccountNumber":{
            "title":"Campaign Account Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the campaign account.",
            "nullable":false,
            "x-queryable":true
        },
        "CampaignId":{
            "title":"Campaign Identifier",
            "type":"integer",
            "description":"The unique identifier of the campaign.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CampaignNumber":{
            "title":"Campaign Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the campaign to which the campaign account belongs to.",
            "nullable":false,
            "x-queryable":true
        },
        "CampaignAccountId":{
            "title":"Campaign Account ID",
            "type":"integer",
            "description":"The unique identifier of the campaign account.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LeadId":{
            "title":"Lead ID",
            "type":"integer",
            "description":"The unique identifier of the lead associated with the campaign account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LeadName":{
            "title":"Lead Name",
            "maxLength":"250",
            "type":"string",
            "description":"The name of the lead associated with the campaign account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated",
            "type":"string",
            "description":"The date when the campaign account was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountName":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the account party associated with the campaign account.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountTotalEmployees":{
            "title":"Company Size",
            "type":"number",
            "description":"The total number of employees for the account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : campaigns-CampaignProducts-item-response

Type: object

Show Source

• CampaignId: integer (int64)
  Title: Campaign ID

  The unique identifier of the campaign.
• CampaignNumber: string
  Title: Campaign Number

  Maximum Length: 30

  The unique identifier of the campaign to which the campaign product belongs to.
• CampaignProductId: integer (int64)
  Title: Campaign Product ID

  The unique identifier of the campaign product.
• CampaignProductNumber: string
  Title: Campaign Product Number

  Maximum Length: 30

  The alternate key identifier of the campaign product.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the campaign products.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the campaign product was created.
• InventoryItemId: integer (int64)
  Title: Campaign Inventory Item ID

  The unique inventory item identifier associated with the campaign product.
• InventoryOrgId: integer (int64)
  Title: Campaign Inventory Org ID

  The unique inventory organization identifier associated with this campaign product.
• ItemName: string
  Title: Item Description

  Read Only: true

  Maximum Length: 240

  The product description where the product is associated with the campaign.
• ItemNumber: string
  Title: Item Number

  Read Only: true

  Maximum Length: 300

  The alternate key for referenced inventory item.
• LastUpdateDate: string (date-time)
  Title: Last Updated

  Read Only: true

  The date when the campaign product was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the campaign product.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProductGroupId: integer (int64)
  Title: Campaign Product Group ID

  The unique identifier of the product group.
• ProductGroupName: string
  Title: Display

  Read Only: true

  Maximum Length: 250

  The description of the product group where the product group is associated with the campaign.
• ProductGroupNumber: string
  Title: Reference Number

  Maximum Length: 50

  The alternate key for referenced product group.
• ProductType: string
  Title: Product Type

  The type of the product, such as item or product group.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the campaign product.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the campaign product was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductGroupId":{
            "title":"Campaign Product Group ID",
            "type":"integer",
            "description":"The unique identifier of the product group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "RecentItemEntityName":"CRMProductGroup"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the campaign products.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "InventoryItemId":{
            "title":"Campaign Inventory Item ID",
            "type":"integer",
            "description":"The unique inventory item identifier associated with the campaign product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "RecentItemEntityName":"CRMProduct"
            },
            "x-queryable":true
        },
        "ProductType":{
            "title":"Product Type",
            "type":"string",
            "description":"The type of the product, such as item or product group.",
            "nullable":true,
            "x-queryable":false
        },
        "InventoryOrgId":{
            "title":"Campaign Inventory Org ID",
            "type":"integer",
            "description":"The unique inventory organization identifier associated with this campaign product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ProductGroupName":{
            "title":"Display",
            "maxLength":"250",
            "type":"string",
            "description":"The description of the product group where the product group is associated with the campaign.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "title":"Item Number",
            "maxLength":"300",
            "type":"string",
            "description":"The alternate key for referenced inventory item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CampaignId":{
            "title":"Campaign ID",
            "type":"integer",
            "description":"The unique identifier of the campaign.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CampaignNumber":{
            "title":"Campaign Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the campaign to which the campaign product belongs to.",
            "nullable":false,
            "x-queryable":true
        },
        "ItemName":{
            "title":"Item Description",
            "maxLength":"240",
            "type":"string",
            "description":"The product description where the product is associated with the campaign.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CampaignProductId":{
            "title":"Campaign Product ID",
            "type":"integer",
            "description":"The unique identifier of the campaign product.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CampaignProductNumber":{
            "title":"Campaign Product Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the campaign product.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ProductGroupNumber":{
            "title":"Reference Number",
            "maxLength":"50",
            "type":"string",
            "description":"The alternate key for referenced product group.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated",
            "type":"string",
            "description":"The date when the campaign product was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : campaigns-CampaignRollup-item-response

Type: object

Show Source

• CampaignId: integer (int64)
  Title: Campaign Identifier

  Read Only: true

  The unique identifier of the campaign.
• CorpCurrencyCode: string
  Title: Corporate Currency Code

  Read Only: true

  Maximum Length: 15

  The corporate currency code for campaign rollups.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the row.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the row was created.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the row was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NumberOfConvertedLeads: number
  Title: Total Converted Leads

  Read Only: true

  The total number of converted leads associated with the campaign.
• NumberOfLeads: number
  Title: Total Leads

  Read Only: true

  The total number of leads associated with the campaign.
• NumberOfOpenHotLeads: number
  Title: Total Hot Open Leads

  Read Only: true

  The total number of unqualified or qualified leads ranked as hot that are associated with the campaign.
• NumberOfOpenLeads: number
  Title: Total Open Leads

  Read Only: true

  The total number of unqualified or qualified open leads associated with the campaign.
• NumberOfOpenOpportunities: number
  Title: Total Open Opportunities

  Read Only: true

  The total number of open opportunities associated with the campaign.
• NumberOfOpportunities: number
  Title: Total Opportunities

  Read Only: true

  The total number of opportunities associated with the campaign.
• NumberOfWonOpportunities: number
  Title: Total Won Opportunities

  Read Only: true

  The total won opportunities associated with the campaign.
• SumOfAllOpportunitiesRevenue: number
  Title: Total Revenue from Opportunities

  Read Only: true

  The total revenue of opportunities associated with the campaign.
• SumOfOpenLeadAmount: number
  Title: Total Revenue from Open Leads

  Read Only: true

  The total amount of the unqualified and qualified leads associated with the campaign.
• SumOfOpenOpportunitiesRevenue: number
  Title: Total Revenue from Open Opportunities

  Read Only: true

  The total revenue of the open opportunities associated with the campaign.
• SumOfWonOpportunitiesRevenue: number
  Title: Total Revenue from Won Opportunities

  Read Only: true

  The total revenue of the won opportunities associated with the campaign.

{
    "type":"object",
    "properties":{
        "NumberOfOpenLeads":{
            "title":"Total Open Leads",
            "type":"number",
            "description":"The total number of unqualified or qualified open leads associated with the campaign.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NumberOfOpenHotLeads":{
            "title":"Total Hot Open Leads",
            "type":"number",
            "description":"The total number of unqualified or qualified leads ranked as hot that are associated with the campaign.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "SumOfWonOpportunitiesRevenue":{
            "title":"Total Revenue from Won Opportunities",
            "type":"number",
            "description":"The total revenue of the won opportunities associated with the campaign.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "SumOfOpenOpportunitiesRevenue":{
            "title":"Total Revenue from Open Opportunities",
            "type":"number",
            "description":"The total revenue of the open opportunities associated with the campaign.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NumberOfLeads":{
            "title":"Total Leads",
            "type":"number",
            "description":"The total number of leads associated with the campaign.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NumberOfOpportunities":{
            "title":"Total Opportunities",
            "type":"number",
            "description":"The total number of opportunities associated with the campaign.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CampaignId":{
            "title":"Campaign Identifier",
            "type":"integer",
            "description":"The unique identifier of the campaign.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "NumberOfOpenOpportunities":{
            "title":"Total Open Opportunities",
            "type":"number",
            "description":"The total number of open opportunities associated with the campaign.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NumberOfWonOpportunities":{
            "title":"Total Won Opportunities",
            "type":"number",
            "description":"The total won opportunities associated with the campaign.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SumOfOpenLeadAmount":{
            "title":"Total Revenue from Open Leads",
            "type":"number",
            "description":"The total amount of the unqualified and qualified leads associated with the campaign.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SumOfAllOpportunitiesRevenue":{
            "title":"Total Revenue from Opportunities",
            "type":"number",
            "description":"The total revenue of opportunities associated with the campaign.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"The corporate currency code for campaign rollups.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NumberOfConvertedLeads":{
            "title":"Total Converted Leads",
            "type":"number",
            "description":"The total number of converted leads associated with the campaign.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : campaigns-CampaignTeam-item-response

Type: object

Show Source

• AccessLevelCode: string
  Title: Campaign Team Member Access Level Code

  Maximum Length: 30

  Default Value: 300

  The code indicating the access level of a team member.
• ApproverFlag: boolean
  Title: Is Approver

  Maximum Length: 1

  Default Value: false

  Indicates whether the team member is approver of the campaign.
• CampaignId: integer (int64)
  Title: Campaign ID

  The unique identifier of the campaign.
• CampaignNumber: string
  Title: Campaign Number

  Maximum Length: 30

  The unique identifier of the campaign to which the campaign resource belongs to.
• CampaignTeamId: integer (int64)
  Title: Campaign Team Member ID

  The unique identifier of the campaign resource.
• CampaignTeamNumber: string
  Title: Campaign Team Member Number

  Maximum Length: 30

  The alternate key identifier of the campaign resource.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the campaign resource.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the campaign resource was created.
• EmailAddress: string
  Title: Primary Email

  Read Only: true

  Maximum Length: 320

  The e-mail address associated with the campaign team resource.
• FormattedPhoneNumber: string
  Title: Primary Phone

  Read Only: true

  The formatted phone number of the campaign resource.
• LastUpdateDate: string (date-time)
  Title: Last Updated

  Read Only: true

  The date when the campaign resource was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the campaign resource.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MemberFunctionCode: string
  Title: Campaign Team Member Function Code

  Maximum Length: 30

  The role of lead contact in the context of this campaign.
• OwnerFlag: boolean
  Title: Owner

  Indicates whether this resource is a primary resource for this campaign.
• ResourceId: integer (int64)
  Title: Campaign Team Member Party ID

  The unique identifier associated with this sales campaign resource.
• ResourceName: string
  Title: Name

  Read Only: true

  Maximum Length: 360

  The name of the party associated with the campaign resource.
• ResourcePartyNumber: string
  Title: Registry ID

  Read Only: true

  Maximum Length: 30

  The alternate key identifier associated with this campaign resource.
• RoleName: string
  Title: Role Name

  Read Only: true

  Maximum Length: 60

  The name of the role of the campaign resource associated with the sales lead.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the campaign resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the campaign resource was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the campaign resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "AccessLevelCode":{
            "title":"Campaign Team Member Access Level Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the access level of a team member.",
            "nullable":false,
            "default":"300",
            "x-queryable":false
        },
        "ResourceName":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the party associated with the campaign resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OwnerFlag":{
            "title":"Owner",
            "type":"boolean",
            "description":"Indicates whether this resource is a primary resource for this campaign.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ResourceId"
                ]
            }
        },
        "CampaignTeamId":{
            "title":"Campaign Team Member ID",
            "type":"integer",
            "description":"The unique identifier of the campaign resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CampaignTeamNumber":{
            "title":"Campaign Team Member Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the campaign resource.",
            "nullable":false,
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Primary Email",
            "maxLength":"320",
            "type":"string",
            "description":"The e-mail address associated with the campaign team resource.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "RoleName":{
            "title":"Role Name",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the role of the campaign resource associated with the sales lead.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CampaignId":{
            "title":"Campaign ID",
            "type":"integer",
            "description":"The unique identifier of the campaign.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ResourceId":{
            "title":"Campaign Team Member Party ID",
            "type":"integer",
            "description":"The unique identifier associated with this sales campaign resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "RecentItemEntityName":"resources"
            },
            "x-queryable":true
        },
        "CampaignNumber":{
            "title":"Campaign Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the campaign to which the campaign resource belongs to.",
            "nullable":false,
            "x-queryable":true
        },
        "ApproverFlag":{
            "title":"Is Approver",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the team member is approver of the campaign.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "ResourcePartyNumber":{
            "title":"Registry ID",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier associated with this campaign resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MemberFunctionCode":{
            "title":"Campaign Team Member Function Code",
            "maxLength":"30",
            "type":"string",
            "description":"The role of lead contact in the context of this campaign.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FormattedPhoneNumber":{
            "title":"Primary Phone",
            "type":"string",
            "description":"The formatted phone number of the campaign resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Updated",
            "type":"string",
            "description":"The date when the campaign resource was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : campaigns-MktCampaignMembers-item-response

Type: object

Show Source

• Active: string
  Title: Is Active

  Read Only: true

  Maximum Length: 1

  Default Value: Y

  Indicates whether the campaign member is active or not.
• CampaignCampaignName: string
  Title: Name

  Read Only: true

  Maximum Length: 100

  The name of the campaign to which the campaign member belongs to.
• CampaignCampaignNumber: string
  Title: Campaign Number

  Maximum Length: 30

  The unique identifier of the campaign to which the campaign member belongs to.
• CampaignEndDate: string (date-time)
  Title: End Date

  Read Only: true

  The date when marketing integration campaign ends.
• CampaignId: integer (int64)
  Title: Campaign Identifier

  The unique identifier of the campaign member.
• CampaignMemberId: integer (int64)
  Title: Campaign Member ID

  The unique identifier of the campaign.
• CampaignMemberNumber: string
  Title: Campaign Member Number

  Maximum Length: 30

  The alternate key identifier of the campaign member.
• CampaignStartDate: string (date-time)
  Title: Start Date

  Read Only: true

  The date when marketing integration campaign starts.
• CampaignStatus: string
  Title: Status

  Read Only: true

  Maximum Length: 30

  Default Value: ORA_DRAFT

  The status of marketing integration campaign.
• CampaignType: string
  Title: Type

  Read Only: true

  Maximum Length: 30

  The type of marketing integration campaign.
• ContactEmail: string
  Title: Contact Email

  Read Only: true

  Maximum Length: 320

  The email address of the contact associated with the campaign member.
• ContactId: integer (int64)
  Title: Contact ID

  The unique identifier of the party associated with the campaign member.
• ContactPartyName: string
  Title: Contact Name

  Read Only: true

  Maximum Length: 360

  The name of the contact party associated with the campaign member.
• ContactPartyNumber: string
  Title: Contact Number

  Maximum Length: 30

  The unique alternate identifier of the contact associated with the campaign member.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the campaign member.
• CreatedByModule: string
  Title: Created by Module

  Maximum Length: 60

  Default Value: ORA_WS

  The module through which the campaign member can be created.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the campaign member was created.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 15

  The code indicating the currency associated with the campaign member, such as USD or GBP.
• DeleteFlag: boolean
  Title: Can Be Deleted

  Read Only: true

  Indicates whether the campaign member can be deleted by the logged in user.
• EmailAddress: string
  Title: Email

  Maximum Length: 320

  The email address of the campaign member.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the campaign member was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the campaign member.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the campaign member.
• LeadAccountName: string
  Title: Lead Account

  Read Only: true

  Maximum Length: 360

  The account name of the lead associated with the campaign member.
• LeadEmail: string
  Title: Lead Email

  Read Only: true

  Maximum Length: 320

  The email address of the lead associated with the campaign member.
• LeadId: integer (int64)
  Title: Lead ID

  The unique identifier of the lead associated with the campaign member.
• LeadLeadName: string
  Title: Lead Name

  Read Only: true

  Maximum Length: 250

  The name of the lead associated with the campaign member.
• LeadLeadNumber: string
  Title: Lead Number

  Maximum Length: 30

  The unique alternate identifier of the lead associated with the campaign member.
• LeadOwnerName: string
  Title: Lead Owner

  Read Only: true

  Maximum Length: 360

  The owner name of the lead associated with the campaign member.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MemberResponseDate: string (date-time)
  Title: Response Date

  The date when the response is received for the campaign member.
• MemberStatus: string
  Title: Member Status

  Maximum Length: 30

  Default Value: ORA_SENT

  The status of the campaign member.
• MemberStatusLookupMeaning: string
  Title: Member Status

  Read Only: true

  Maximum Length: 80

  The display label for the status of the campaign member.
• SourceSystemCampMemberId: string
  Title: Source System Campaign Member ID

  Maximum Length: 100

  The unique identifier of the campaign member in the source system.
• UpdateFlag: boolean
  Title: Can Be Updated

  Read Only: true

  Indicates whether the campaign member can be updated by the logged in user.

{
    "type":"object",
    "properties":{
        "SourceSystemCampMemberId":{
            "title":"Source System Campaign Member ID",
            "maxLength":"100",
            "type":"string",
            "description":"The unique identifier of the campaign member in the source system.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the campaign member was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LeadLeadName":{
            "title":"Lead Name",
            "maxLength":"250",
            "type":"string",
            "description":"The name of the lead associated with the campaign member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CampaignStatus":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of marketing integration campaign.",
            "nullable":false,
            "readOnly":true,
            "default":"ORA_DRAFT",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LeadEmail":{
            "title":"Lead Email",
            "maxLength":"320",
            "type":"string",
            "description":"The email address of the lead associated with the campaign member.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "LeadAccountName":{
            "title":"Lead Account",
            "maxLength":"360",
            "type":"string",
            "description":"The account name of the lead associated with the campaign member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactId":{
            "title":"Contact ID",
            "type":"integer",
            "description":"The unique identifier of the party associated with the campaign member.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "RecentItemEntityName":"contacts"
            },
            "x-queryable":true
        },
        "MemberResponseDate":{
            "title":"Response Date",
            "type":"string",
            "description":"The date when the response is received for the campaign member.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "ContactPartyName":{
            "title":"Contact Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the contact party associated with the campaign member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The code indicating the currency associated with the campaign member, such as USD or GBP.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "UpdateFlag":{
            "title":"Can Be Updated",
            "type":"boolean",
            "description":"Indicates whether the campaign member can be updated by the logged in user.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LeadOwnerName":{
            "title":"Lead Owner",
            "maxLength":"360",
            "type":"string",
            "description":"The owner name of the lead associated with the campaign member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CampaignId":{
            "title":"Campaign Identifier",
            "type":"integer",
            "description":"The unique identifier of the campaign member.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CampaignCampaignNumber":{
            "title":"Campaign Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the campaign to which the campaign member belongs to.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LeadId":{
            "title":"Lead ID",
            "type":"integer",
            "description":"The unique identifier of the lead associated with the campaign member.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "RecentItemEntityName":"leads"
            },
            "x-queryable":true
        },
        "LeadLeadNumber":{
            "title":"Lead Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unique alternate identifier of the lead associated with the campaign member.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedByModule":{
            "title":"Created by Module",
            "maxLength":"60",
            "type":"string",
            "description":"The module through which the campaign member can be created.",
            "nullable":false,
            "default":"ORA_WS",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CampaignType":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of marketing integration campaign.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the campaign member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CampaignMemberId":{
            "title":"Campaign Member ID",
            "type":"integer",
            "description":"The unique identifier of the campaign.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the campaign member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CampaignStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when marketing integration campaign starts.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Can Be Deleted",
            "type":"boolean",
            "description":"Indicates whether the campaign member can be deleted by the logged in user.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EmailAddress":{
            "title":"Email",
            "maxLength":"320",
            "type":"string",
            "description":"The email address of the campaign member.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactPartyNumber":{
            "title":"Contact Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unique alternate identifier of the contact associated with the campaign member.",
            "nullable":false,
            "x-queryable":true
        },
        "Active":{
            "title":"Is Active",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the campaign member is active or not.",
            "nullable":false,
            "readOnly":true,
            "default":"Y",
            "x-queryable":true
        },
        "CampaignMemberNumber":{
            "title":"Campaign Member Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the campaign member.",
            "nullable":false,
            "x-queryable":true
        },
        "CampaignEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when marketing integration campaign ends.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactEmail":{
            "title":"Contact Email",
            "maxLength":"320",
            "type":"string",
            "description":"The email address of the contact associated with the campaign member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MemberStatusLookupMeaning":{
            "title":"Member Status",
            "maxLength":"80",
            "type":"string",
            "description":"The display label for the status of the campaign member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CampaignCampaignName":{
            "title":"Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the campaign to which the campaign member belongs to.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MemberStatus":{
            "title":"Member Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the campaign member.",
            "nullable":true,
            "default":"ORA_SENT",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the campaign member was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the campaign member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : campaigns-SalesContents-item-response

Type: object

Show Source

• CanDelete: string
  Read Only: true

  Default Value: Y

  Indicates whether user can delete the content item or not.
• CanUpdate: string
  Read Only: true

  Default Value: Y

  Indicates whether user can update the content item or not.
• ContentItemId: string
  Title: Content ID

  Maximum Length: 64

  The internal content item identifier from the source system.
• ContentItemName: string
  Title: Content Name

  Maximum Length: 4000

  The name of the sales content item.
• ContentItemType: string
  Read Only: true

  Indicates the type of content, for example pdf, png, and so on.
• ContentSourceSystem: string
  Maximum Length: 50

  Default Value: OCE

  Indicates from where the content item is sourced.
• DeletedInSourceFlag: boolean
  Title: Content Deleted in Source

  Maximum Length: 1

  Default Value: false

  Indicates whether referred sales content item is deleted in source system.
• DisplaySequence: integer (int32)
  Title: Display Sequence

  Indicates the sequence in which the sales content should appear in a page.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ParentObjectId: integer (int64)
  Title: Parent Object ID

  The unique identifier of the object associated to the sales content row.
• ParentObjectType: string
  Maximum Length: 128

  The parent object type associated to the sales content row, for example Account, Contact, Lead, and so on.
• PublicContentItemId: string
  Title: Public Content ID

  Maximum Length: 64

  The public content item identifier from the source system.
• PublicContentItemName: string
  Title: Public Content Name

  Maximum Length: 4000

  The name of the public sales content item.
• PublicCustomerName: string
  Title: Customer Name

  Maximum Length: 4000

  The name of the customer for which the public content was published.
• PublicPublishedDate: string (date-time)
  Title: Publish Date

  The date on which the public content item was published.
• PublicStoryLink: string
  Title: Public URL

  Maximum Length: 4000

  The link of the public content item.
• SalesContentId: integer (int64)
  Title: Sales Content ID

  Read Only: true

  The unique identifier of the sales content.

{
    "type":"object",
    "properties":{
        "ContentSourceSystem":{
            "maxLength":"50",
            "type":"string",
            "description":"Indicates from where the content item is sourced.",
            "nullable":true,
            "default":"OCE",
            "x-queryable":true
        },
        "ContentItemName":{
            "title":"Content Name",
            "maxLength":"4000",
            "type":"string",
            "description":"The name of the sales content item.",
            "nullable":false,
            "x-queryable":true
        },
        "PublicCustomerName":{
            "title":"Customer Name",
            "maxLength":"4000",
            "type":"string",
            "description":"The name of the customer for which the public content was published.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"Indicates the sequence in which the sales content should appear in a page.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "CanDelete":{
            "type":"string",
            "description":"Indicates whether user can delete the content item or not.",
            "nullable":true,
            "readOnly":true,
            "default":"Y",
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "PublicContentItemId":{
            "title":"Public Content ID",
            "maxLength":"64",
            "type":"string",
            "description":"The public content item identifier from the source system.",
            "nullable":true,
            "x-queryable":true
        },
        "SalesContentId":{
            "title":"Sales Content ID",
            "type":"integer",
            "description":"The unique identifier of the sales content.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ParentObjectType":{
            "maxLength":"128",
            "type":"string",
            "description":"The parent object type associated to the sales content row, for example Account, Contact, Lead, and so on.",
            "nullable":false,
            "x-queryable":true
        },
        "ContentItemId":{
            "title":"Content ID",
            "maxLength":"64",
            "type":"string",
            "description":"The internal content item identifier from the source system.",
            "nullable":false,
            "x-queryable":true
        },
        "CanUpdate":{
            "type":"string",
            "description":"Indicates whether user can update the content item or not.",
            "nullable":true,
            "readOnly":true,
            "default":"Y",
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "PublicPublishedDate":{
            "title":"Publish Date",
            "type":"string",
            "description":"The date on which the public content item was published.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PublicStoryLink":{
            "title":"Public URL",
            "maxLength":"4000",
            "type":"string",
            "description":"The link of the public content item.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PublicContentItemName":{
            "title":"Public Content Name",
            "maxLength":"4000",
            "type":"string",
            "description":"The name of the public sales content item.",
            "nullable":true,
            "x-queryable":true
        },
        "ContentItemType":{
            "type":"string",
            "description":"Indicates the type of content, for example pdf, png, and so on.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ParentObjectId":{
            "title":"Parent Object ID",
            "type":"integer",
            "description":"The unique identifier of the object associated to the sales content row.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DeletedInSourceFlag":{
            "title":"Content Deleted in Source",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether referred sales content item is deleted in source system.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : campaigns-smartActions-item-response

Type: object

Show Source

• ActionIntent: string (byte)
  Title: Action Intent

  JSON object that describes what an action does and what context data can be passed to the action.
• ConfirmationMessage: string
  Title: Confirmation Message

  Maximum Length: 4000

  A message to seek confirmation for the action being performed.
• ContentType: string
  Title: Content Type

  Maximum Length: 50

  The content type to use when invoking the REST endpoint.
• DisplayLabel: string
  Title: Action Name

  Maximum Length: 256

  The consumer friendly Action Name.
• Entity: string
  Title: Parent Entity

  Maximum Length: 150

  The REST Resources the Action belongs to.
• Href: string
  Title: REST Endpoint

  Maximum Length: 150

  The REST endpoint to perform the Action.
• IncludedInApplication: string
  Title: Included in Application

  Maximum Length: 512

  The list of applications that this action can be used in.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MassActionFlag: boolean
  Title: Mass Action

  Maximum Length: 1

  Indicates whether the action can be mass produced.
• Method: string
  Title: HTTP Method

  Maximum Length: 15

  The HTTP method of the smart action REST operation.
• ObjectFunctionName: string
  Title: Object Function

  Maximum Length: 64

  The object function associated with the smart action.
• PageType: string
  Title: Page Type

  Maximum Length: 256

  The list of pages that this action can be used in.
• SmartSuggestFlag: boolean
  Title: Smart Suggest

  Maximum Length: 1

  Indicates whether smart suggest is enabled for the action.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Indicates whether the action is seeded or custom.
• UpdateOfAttributes: string
  Title: Attributes to Update

  Maximum Length: 512

  The attributes to be updated when the Actions UI is launched.
• UserActionId: integer (int64)
  Title: User Action ID

  The unique system assigned identifier of the smart action definition.
• UserActionName: string
  Title: Action Name

  Maximum Length: 256

  Uniquely identifies the Action with name. For internal use.
• UserActionNavigation: array Smart Action User Interface Definitions
  Title: Smart Action User Interface Definitions

  The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
• UserActionRank: integer (int64)
  Title: Priority

  The number to indicate priority of the action.
• UserActionRequestPayload: array Smart Action REST Payload Definitions
  Title: Smart Action REST Payload Definitions

  The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
• UserActionURLBinding: array Smart Action REST Path Parameter Definitions
  Title: Smart Action REST Path Parameter Definitions

  The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.

{
    "type":"object",
    "properties":{
        "SmartSuggestFlag":{
            "title":"Smart Suggest",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether smart suggest is enabled for the action.",
            "nullable":true,
            "x-queryable":true
        },
        "Entity":{
            "title":"Parent Entity",
            "maxLength":"150",
            "type":"string",
            "description":"The REST Resources the Action belongs to.",
            "nullable":true,
            "x-queryable":true
        },
        "ContentType":{
            "title":"Content Type",
            "maxLength":"50",
            "type":"string",
            "description":"The content type to use when invoking the REST endpoint.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionURLBinding":{
            "title":"Smart Action REST Path Parameter Definitions",
            "type":"array",
            "description":"The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
            "items":{
                "$ref":"#/components/schemas/campaigns-smartActions-UserActionURLBinding-item-response"
            }
        },
        "MassActionFlag":{
            "title":"Mass Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the action can be mass produced.",
            "nullable":true,
            "x-queryable":true
        },
        "IncludedInApplication":{
            "title":"Included in Application",
            "maxLength":"512",
            "type":"string",
            "description":"The list of applications that this action can be used in.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionNavigation":{
            "title":"Smart Action User Interface Definitions",
            "type":"array",
            "description":"The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
            "items":{
                "$ref":"#/components/schemas/campaigns-smartActions-UserActionNavigation-item-response"
            }
        },
        "Href":{
            "title":"REST Endpoint",
            "maxLength":"150",
            "type":"string",
            "description":"The REST endpoint to perform the Action.",
            "nullable":true,
            "x-queryable":true
        },
        "Method":{
            "title":"HTTP Method",
            "maxLength":"15",
            "type":"string",
            "description":"The HTTP method of the smart action REST operation.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplayLabel":{
            "title":"Action Name",
            "maxLength":"256",
            "type":"string",
            "description":"The consumer friendly Action Name.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionName":{
            "title":"Action Name",
            "maxLength":"256",
            "type":"string",
            "description":"Uniquely identifies the Action with name. For internal use.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionId":{
            "title":"User Action ID",
            "type":"integer",
            "description":"The unique system assigned identifier of the smart action definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "UserActionRank":{
            "title":"Priority",
            "type":"integer",
            "description":"The number to indicate priority of the action.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"10"
            },
            "x-queryable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the action is seeded or custom.",
            "nullable":true,
            "x-queryable":true
        },
        "ConfirmationMessage":{
            "title":"Confirmation Message",
            "maxLength":"4000",
            "type":"string",
            "description":"A message to seek confirmation for the action being performed.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionRequestPayload":{
            "title":"Smart Action REST Payload Definitions",
            "type":"array",
            "description":"The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
            "items":{
                "$ref":"#/components/schemas/campaigns-smartActions-UserActionRequestPayload-item-response"
            }
        },
        "UpdateOfAttributes":{
            "title":"Attributes to Update",
            "maxLength":"512",
            "type":"string",
            "description":"The attributes to be updated when the Actions UI is launched.",
            "nullable":true,
            "x-queryable":true
        },
        "ActionIntent":{
            "title":"Action Intent",
            "type":"string",
            "description":"JSON object that describes what an action does and what context data can be passed to the action.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ObjectFunctionName":{
            "title":"Object Function",
            "maxLength":"64",
            "type":"string",
            "description":"The object function associated with the smart action.",
            "nullable":true,
            "x-queryable":true
        },
        "PageType":{
            "title":"Page Type",
            "maxLength":"256",
            "type":"string",
            "description":"The list of pages that this action can be used in.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Smart Action User Interface Definitions

Type: array

Title: Smart Action User Interface Definitions

The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.

Show Source

• Array of: object campaigns-smartActions-UserActionNavigation-item-response

{
    "title":"Smart Action User Interface Definitions",
    "type":"array",
    "description":"The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
    "items":{
        "$ref":"#/components/schemas/campaigns-smartActions-UserActionNavigation-item-response"
    }
}

Nested Schema : Smart Action REST Payload Definitions

Type: array

Title: Smart Action REST Payload Definitions

The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.

Show Source

• Array of: object campaigns-smartActions-UserActionRequestPayload-item-response

{
    "title":"Smart Action REST Payload Definitions",
    "type":"array",
    "description":"The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
    "items":{
        "$ref":"#/components/schemas/campaigns-smartActions-UserActionRequestPayload-item-response"
    }
}

Nested Schema : Smart Action REST Path Parameter Definitions

Type: array

Title: Smart Action REST Path Parameter Definitions

The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.

Show Source

• Array of: object campaigns-smartActions-UserActionURLBinding-item-response

{
    "title":"Smart Action REST Path Parameter Definitions",
    "type":"array",
    "description":"The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
    "items":{
        "$ref":"#/components/schemas/campaigns-smartActions-UserActionURLBinding-item-response"
    }
}

Nested Schema : campaigns-smartActions-UserActionNavigation-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
• UserActionNavAppUsage: string
  Title: Application Usage

  Maximum Length: 50

  The client application associated with a smart action user interface endpoint definition identified by UserActionNavId.
• UserActionNavBody: string
  Title: Navigation Metadata

  Maximum Length: 1000

  The metadata definition of the smart action user interface endpoint.
• UserActionNavId: integer (int64)
  Title: Primary Key

  The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
• UserActionNavType: string
  Title: Navigation Type

  Maximum Length: 100

  The text value used by applications to determine which user interface to launch.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "UserActionNavId":{
            "title":"Primary Key",
            "type":"integer",
            "description":"The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "UserActionNavType":{
            "title":"Navigation Type",
            "maxLength":"100",
            "type":"string",
            "description":"The text value used by applications to determine which user interface to launch.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionNavBody":{
            "title":"Navigation Metadata",
            "maxLength":"1000",
            "type":"string",
            "description":"The metadata definition of the smart action user interface endpoint.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionNavAppUsage":{
            "title":"Application Usage",
            "maxLength":"50",
            "type":"string",
            "description":"The client application associated with a smart action user interface endpoint definition identified by UserActionNavId.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : campaigns-smartActions-UserActionRequestPayload-item-response

Type: object

Show Source

• Binding: string
  Title: Payload Value Binding Type

  Maximum Length: 64

  The classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MandatoryFlag: boolean
  Title: Mandatory

  Maximum Length: 1

  Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined.
• RequestPayloadId: integer (int64)
  The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.
• RequestPayloadName: string
  Title: Request Payload Attribute Name

  Maximum Length: 256

  The value assigned to the name property of a name-value pair.
• SmartSuggestPath: string
  Title: Smart Suggest Path

  Maximum Length: 2048

  The path used for smart suggest.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
• Value: string
  Title: Request Payload Attribute Value

  Maximum Length: 1000

  The value assigned to the value property of a name-value pair.
• ValueStruct: string
  Title: Payload Value Structure

  Maximum Length: 20

  A value of JSON_ARRAY_STRING indicates that the value property of a name-value pair represents an array of data rather than a single entity such as an object attribute name or simple text string. The array string is a definition of the name-value pair and the Binding and Mandatory properties. The array string follows specific pattern, for example [{"name":"leadId","Value":"LeadId","MandatoryFlag":true,"Binding":"RUNTIME"}]. A null value indicates the value property represents a simple, single entity such as an object attribute name or simple text string.

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"Payload Value Binding Type",
            "maxLength":"64",
            "type":"string",
            "description":"The classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING.",
            "nullable":true,
            "x-queryable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "ValueStruct":{
            "title":"Payload Value Structure",
            "maxLength":"20",
            "type":"string",
            "description":"A value of JSON_ARRAY_STRING indicates that the value property of a name-value pair represents an array of data rather than a single entity such as an object attribute name or simple text string. The array string is a definition of the name-value pair and the Binding and Mandatory properties. The array string follows specific pattern, for example [{\"name\":\"leadId\",\"Value\":\"LeadId\",\"MandatoryFlag\":true,\"Binding\":\"RUNTIME\"}]. A null value indicates the value property represents a simple, single entity such as an object attribute name or simple text string.",
            "nullable":true,
            "x-queryable":true
        },
        "Value":{
            "title":"Request Payload Attribute Value",
            "maxLength":"1000",
            "type":"string",
            "description":"The value assigned to the value property of a name-value pair.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SmartSuggestPath":{
            "title":"Smart Suggest Path",
            "maxLength":"2048",
            "type":"string",
            "description":"The path used for smart suggest.",
            "nullable":true,
            "x-queryable":true
        },
        "RequestPayloadId":{
            "type":"integer",
            "description":"The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RequestPayloadName":{
            "title":"Request Payload Attribute Name",
            "maxLength":"256",
            "type":"string",
            "description":"The value assigned to the name property of a name-value pair.",
            "nullable":false,
            "x-queryable":true
        },
        "MandatoryFlag":{
            "title":"Mandatory",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : campaigns-smartActions-UserActionURLBinding-item-response

Type: object

Show Source

• Binding: string
  Title: URL Binding Type

  Maximum Length: 64

  The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
• URLBindingId: integer (int64)
  The unique system assigned identifier of a smart action REST path parameter name-value pair definition.
• URLBindingName: string
  Title: URL Binding Parameter Name

  Maximum Length: 50

  The value assigned to the name property of a name-value pair.
• Value: string
  Title: URL Binding Parameter Value

  Maximum Length: 80

  The value assigned to the value property of a name-value pair.

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"URL Binding Type",
            "maxLength":"64",
            "type":"string",
            "description":"The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "Value":{
            "title":"URL Binding Parameter Value",
            "maxLength":"80",
            "type":"string",
            "description":"The value assigned to the value property of a name-value pair.",
            "nullable":true,
            "x-queryable":true
        },
        "URLBindingId":{
            "type":"integer",
            "description":"The unique system assigned identifier of a smart action REST path parameter name-value pair definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":"1",
            "type":"boolean",
            "description":"The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "URLBindingName":{
            "title":"URL Binding Parameter Name",
            "maxLength":"50",
            "type":"string",
            "description":"The value assigned to the name property of a name-value pair.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Back to Top

Examples

The following example shows how to get all campaigns by submitting a get request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/campaigns

Example of Response Body

The following shows an example of the response body in JSON format.

{
    "items": [
        {
            "ActualCost": 1235234.23,
            "BudgetedCost": 1235239.23,
            "CampaignId": 300100182466483,
            "CampaignName": "BIQA_ELQ_CAMPAIGN8",
            "CampaignNumber": "CDRM_8",
            "CampaignType": "ORA_NURTURE",
            "CreatedBy": "SALES_ADMIN",
            "CreatedByModule": "ORA_WS",
            "CreationDate": "2019-09-06T08:41:34+00:00",
            "CurrencyCode": "USD",
            "Description": "BIQA_ELQ_CAMPAIGN6",
            "EndDate": "2030-12-31T00:00:00+00:00",
            "LastUpdateDate": "2019-09-06T08:41:34.113+00:00",
            "LastUpdateLogin": "910A1D8F02E39F6FE053A15AF00A6378",
            "LastUpdatedBy": "SALES_ADMIN",
            "OwnerId": 100010025532672,
            "ParentCampaignId": null,
            "ProductDescription": null,
            "RegionCode": null,
            "SourceSystemCampaignId": null,
            "StartDate": "2019-09-06T00:00:00+00:00",
            "Status": "ORA_ACTIVE",
            "OwnerPartyName": "Gabrielle   Lee",
            "UpdateFlag": true,
            "DeleteFlag": true,
            "StatusLookupMeaning": "Active",
            "CampaignTypeMeaning": "Nurture",
            "OwnerPartyNumber": "100010025532672",
            "ParentCampaignName": null,
            "ParentCampaignNumber": null,
            "CampaignCreationDate": "2019-09-06T08:41:34+00:00",
            "CampaignCreatedBy": "SALES_ADMIN",
            "CampaignLastUpdateDate": "2019-09-06T08:41:34.113+00:00",
            "CampaignLastUpdatedBy": "SALES_ADMIN",
            "CampaignOrigin": "MKT_CAMPAIGN",
            "NumberOfAssociatedAccounts": null,
            "NumberOfLeadsErrored": null,
            "NumberOfLeadsGenerated": null,
            "SalesTargetCampaignStage": null,
            "SourceSystemEmailId": null,
            "SourceSystemLandingPageId": null,
            "SourceSystemSegmentId": null,
            "SourceSystemSharedListId": null,
            "SalesTargetLeadsCreationDate": null,
            "SalesTargetCampaignEloquaSyncDate": null,
            "SalesTargetCampaignDaysToVerify": null,
            "CampaignCategory": "ORA_MARKETING",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/campaigns/CDRM_8",
                    "name": "campaigns",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/campaigns/CDRM_8",
                    "name": "campaigns",
                    "kind": "item"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/campaigns/CDRM_8/lov/OwnerPickerVA",
                    "name": "OwnerPickerVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/campaigns/CDRM_8/lov/CampaignCategoryVA",
                    "name": "CampaignCategoryVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/campaigns/CDRM_8/lov/CampaignTypeVA",
                    "name": "CampaignTypeVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/campaigns/CDRM_8/lov/CurrencyCodeVA",
                    "name": "CurrencyCodeVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/campaigns/CDRM_8/lov/CampaignOriginVA",
                    "name": "CampaignOriginVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/campaigns/CDRM_8/lov/CreatedByModuleVA",
                    "name": "CreatedByModuleVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/campaigns/CDRM_8/lov/CampaignStageVA",
                    "name": "CampaignStageVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/campaigns/CDRM_8/lov/StatusVA",
                    "name": "StatusVA",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/campaigns/CDRM_8/child/CampaignAccountAttributionCriteria",
                    "name": "CampaignAccountAttributionCriteria",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/campaigns/CDRM_8/child/CampaignAccounts",
                    "name": "CampaignAccounts",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/campaigns/CDRM_8/child/CampaignProducts",
                    "name": "CampaignProducts",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/campaigns/CDRM_8/child/CampaignTeam",
                    "name": "CampaignTeam",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/campaigns/CDRM_8/child/MktCampaignMembers",
                    "name": "MktCampaignMembers",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/campaigns/CDRM_8/child/SalesContents",
                    "name": "SalesContents",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/campaigns/CDRM_8/child/smartActions",
                    "name": "smartActions",
                    "kind": "collection"
                }
            ]
        },
        ....
    ],
    "count": 25,
    "hasMore": true,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/campaigns",
            "name": "campaigns",
            "kind": "collection"
        }
    ]
}

Back to Top