REST API for Oracle Eloqua Marketing Cloud Service

Retrieve an opportunity field definition

get

/api/bulk/2.0/opportunities/fields/{id}

Retrieves an opportunity field definition. For more information about using these endpoints, see, using the opportunities endpoints.

Request

Supported Media Types

application/json
text/csv

Path Parameters

id: integer

Response

Supported Media Types

application/json

200 Response

OK.

Root Schema : OpportunityFieldIndividualResponse

Type: object

Title: OpportunityFieldIndividualResponse

Show Source

createdAt(optional): string(date-time)

Title: createdAt
createdBy(optional): string

Title: createdBy
dataType(optional): string

Title: DataType

Default Value: number

Allowed Values: [ "number", "string", "boolean", "date", "emailAddress" ]
defaultValue(optional): string

Title: defaultValue
hasNotNullConstraint(optional): boolean

Title: hasNotNullConstraint
hasReadOnlyConstraint(optional): boolean

Title: hasReadOnlyConstraint
hasUniquenessConstraint(optional): boolean

Title: hasUniquenessConstraint
internalName(optional): string

Title: internalName
name(optional): string

Title: name
statement(optional): string

Title: statement
updatedAt(optional): string(date-time)

Title: updatedAt
updatedBy(optional): string

Title: updatedBy
uri(optional): string

Title: uri

{
    "title":"OpportunityFieldIndividualResponse",
    "description":"",
    "properties":{
        "createdAt":{
            "format":"date-time",
            "title":"createdAt",
            "description":"",
            "type":"string"
        },
        "createdBy":{
            "title":"createdBy",
            "description":"",
            "type":"string"
        },
        "dataType":{
            "$ref":"#/definitions/DataType"
        },
        "defaultValue":{
            "title":"defaultValue",
            "description":"",
            "type":"string"
        },
        "hasNotNullConstraint":{
            "title":"hasNotNullConstraint",
            "description":"",
            "type":"boolean"
        },
        "hasReadOnlyConstraint":{
            "title":"hasReadOnlyConstraint",
            "description":"",
            "type":"boolean"
        },
        "hasUniquenessConstraint":{
            "title":"hasUniquenessConstraint",
            "description":"",
            "type":"boolean"
        },
        "internalName":{
            "title":"internalName",
            "description":"",
            "type":"string"
        },
        "name":{
            "title":"name",
            "description":"",
            "type":"string"
        },
        "statement":{
            "title":"statement",
            "description":"",
            "type":"string"
        },
        "updatedAt":{
            "format":"date-time",
            "title":"updatedAt",
            "description":"",
            "type":"string"
        },
        "updatedBy":{
            "title":"updatedBy",
            "description":"",
            "type":"string"
        },
        "uri":{
            "title":"uri",
            "description":"",
            "type":"string"
        }
    }
}

400 Response

Bad request. See Status Codes for information about other possible HTTP status codes.

401 Response

Unauthorized. See Status Codes for information about other possible HTTP status codes.

403 Response

Forbidden. See Status Codes for information about other possible HTTP status codes.

404 Response

The requested resource was not found. See Status Codes for information about other possible HTTP status codes.

409 Response

There was a conflict. See Status Codes for information about other possible HTTP status codes.

410 Response

The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes.

412 Response

The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes.

413 Response

Storage space exceeded. See Status Codes for information about other possible HTTP status codes.

500 Response

The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes.

503 Response

There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes.

Examples

The following examples demonstrate how to retrieve an opportunity field using an HTTP request and cURL. For more information on requests, see API requests.

HTTP Request Example

Retrieve the opportunity field with the id #45:


GET /opportunities/fields/45
Content-Type: application/json

Response:


{
  "name": "Forecast To Close Date",
  "internalName": "ForecastToCloseDate",
  "dataType": "date",
  "hasReadOnlyConstraint": false,
  "hasNotNullConstraint": false,
  "hasUniquenessConstraint": false,
  "statement": "{{Opportunity.Field(ForecastToCloseDate)}}",
  "uri": "/opportunities/fields/45"
}

cURL Example

Here is the same example in cURL given an instance with the name APITest, username API.User, and POD of 3.


curl --user "APITest\API.User" --request GET https://secure.p03.eloqua.com/api/bulk/2.0/opportunities/fields/45