Jump to

• Request
• Response

Search for a Lookup table by Name field

get

/api/rest/2.0/assets/lookupTables

Request

Supported Media Types

• application/json

Query Parameters

• count: integer
  The number of results returned in the request.
• depth: string
  Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to minimal by default.
• lastUpdatedAt: integer
  The date and time the lookup table was last updated. This is a read-only property.
• orderBy: string
  Specifies the field by which list results are ordered
• page: integer
  Specifies which page of entities to return (the count parameter defines the number of entities per page). If the page parameter is not supplied, 1 will be used by default.
• search: string
  Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : QueryResultLookupTable

Type: object

Title: QueryResultLookupTable

Show Source

• elements: array elements
  Array of the lookup table fields.
• page: integer
  The specified page.
• pageSize: integer
  The page size.
• total: integer
  The total amount of results.
• type: string
  The lookup table field's type in Eloqua.

{
    "title":"QueryResultLookupTable",
    "properties":{
        "type":{
            "type":"string",
            "description":"The lookup table field's type in Eloqua."
        },
        "elements":{
            "type":"array",
            "description":"Array of the lookup table fields.",
            "items":{
                "$ref":"#/definitions/LookupTableRest20"
            }
        },
        "total":{
            "type":"integer",
            "description":"The total amount of results."
        },
        "pageSize":{
            "type":"integer",
            "description":"The page size."
        },
        "page":{
            "type":"integer",
            "description":"The specified page."
        }
    }
}

Nested Schema : elements

Type: array

Array of the lookup table fields.

Show Source

• Array of: object LookupTable
  Title: LookupTable

{
    "type":"array",
    "description":"Array of the lookup table fields.",
    "items":{
        "$ref":"#/definitions/LookupTableRest20"
    }
}

Nested Schema : LookupTable

Type: object

Title: LookupTable

Show Source

• createdAt: string
  Read Only: true

  The date and time the lookup table was created, expressed in Unix time.
• createdBy: string
  Read Only: true

  The login id of the user who created the lookup table.
• currentStatus: string
  The status of the lookup table.
• depth: string
  Read Only: true

  Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.
• description: string
  The description of the lookup table.
• folderId: string
  Read Only: true

  The folder id of the folder which contains the lookup table.
• id: string
  Read Only: true

  Id of the lookup table. This is a read-only property.
• lookupFieldName: string
  The lookup field of the lookup table.
• name: string
  The name of the lookup table.
• permissions: array permissions
  The permissions for the lookup table granted to your current instance. This is a read-only property.
• replacementFieldName: string
  The replacement field of the lookup table.
• scheduledFor: string
  Read Only: true

  The date the lookup table is scheduled.
• sourceTemplateId: string
  The Id for the source template of the lookup table.
• type: string
  The lookup table type
• updatedAt: string
  Read Only: true

  The date and time the lookup table was last updated, expressed in Unix time.
• updatedBy: string
  Read Only: true

  The login id of the user who last updated the lookup table.
• valuesAreCaseSensitive: string
  While compare lookup field with case sensitive rule or not.

{
    "title":"LookupTable",
    "properties":{
        "type":{
            "type":"string",
            "description":"The lookup table type"
        },
        "id":{
            "type":"string",
            "readOnly":true,
            "description":"Id of the lookup table. This is a read-only property."
        },
        "currentStatus":{
            "type":"string",
            "description":"The status of the lookup table."
        },
        "name":{
            "type":"string",
            "description":"The name of the lookup table."
        },
        "description":{
            "type":"string",
            "description":"The description of the lookup table."
        },
        "permissions":{
            "type":"array",
            "description":"The permissions for the lookup table granted to your current instance. This is a read-only property.",
            "items":{
                "type":"string"
            }
        },
        "folderId":{
            "type":"string",
            "readOnly":true,
            "description":"The folder id of the folder which contains the lookup table."
        },
        "sourceTemplateId":{
            "type":"string",
            "description":"The Id for the source template of the lookup table."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user who created the lookup table."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the lookup table was created, expressed in Unix time."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user who last updated the lookup table."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the lookup table was last updated, expressed in Unix time."
        },
        "scheduledFor":{
            "type":"string",
            "readOnly":true,
            "description":"The date the lookup table is scheduled."
        },
        "depth":{
            "type":"string",
            "readOnly":true,
            "description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>."
        },
        "lookupFieldName":{
            "type":"string",
            "description":"The lookup field of the lookup table."
        },
        "replacementFieldName":{
            "type":"string",
            "description":"The replacement field of the lookup table."
        },
        "valuesAreCaseSensitive":{
            "type":"string",
            "description":"While compare lookup field with case sensitive rule or not."
        }
    }
}

Nested Schema : permissions

Type: array

The permissions for the lookup table granted to your current instance. This is a read-only property.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The permissions for the lookup table granted to your current instance. This is a read-only property.",
    "items":{
        "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.

500 Response

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

Back to Top