REST API for Oracle Eloqua Marketing Cloud Service

Retrieve a list of images

get

/api/REST/1.0/assets/images

Retrieves all images that match the criteria specified by the request parameters.

Request

Supported Media Types

application/json

Query Parameters

count(optional): integer

Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
depth(optional): 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(optional): integer

The date and time the image was last updated.
orderBy(optional): string

Specifies the field by which list results are ordered.
page(optional): 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(optional): string

Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.

Response

Supported Media Types

application/json

200 Response

OK.

Root Schema : QueryResultImage

Type: object

Title: QueryResultImage

Show Source

elements(optional): array elements

Array of image fields.
page(optional): integer

The specified page.
pageSize(optional): integer

The page size.
total(optional): integer

The total amount of results.
type(optional): string

The asset's type in Eloqua.

{
    "title":"QueryResultImage",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua."
        },
        "elements":{
            "type":"array",
            "description":"Array of image fields.",
            "items":{
                "$ref":"#/definitions/ImageFileRest10"
            }
        },
        "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 image fields.

Show Source

Array of: object ImageFile

Title: ImageFile

{
    "type":"array",
    "description":"Array of image fields.",
    "items":{
        "$ref":"#/definitions/ImageFileRest10"
    }
}

Nested Schema : ImageFile

Type: object

Title: ImageFile

Show Source

createdAt(optional): string

Read Only: true

The date and time the image was created, expressed in Unix time.
createdBy(optional): string

Read Only: true

The login id of the user who created the image.
currentStatus(optional): string

The image's current status.
depth(optional): 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(optional): string

The description of the image.
fullImageUrl(optional): string

The image's complete URL. This is a read-only property.
id(optional): string

Read Only: true

Id of the image. This is a read-only property.
name(optional): string

The name of the image.
permissions(optional): string

The permissions for the image granted to your current instance. This is a read-only property.
size(optional): object Size

Title: Size
thumbnailUrl(optional): string

The image's thumbnail URL. This is a read-only property.
type(optional): string

The asset's type in Eloqua. This is a read-only property.
updatedAt(optional): string

Read Only: true

Unix timestamp for the date and time the image was last updated.
updatedBy(optional): string

Read Only: true

The login id of the user that last updated the image.

{
    "title":"ImageFile",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property. "
        },
        "id":{
            "type":"string",
            "readOnly":true,
            "description":"Id of the image. This is a read-only property."
        },
        "currentStatus":{
            "type":"string",
            "description":"The image's current status."
        },
        "name":{
            "type":"string",
            "description":"The name of the image."
        },
        "description":{
            "type":"string",
            "description":"The description of the image."
        },
        "permissions":{
            "type":"string",
            "description":"The permissions for the image granted to your current instance. This is a read-only property."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user who created the image."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the image was created, expressed in Unix time."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user that last updated the image."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"Unix timestamp for the date and time the image was last updated."
        },
        "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>."
        },
        "fullImageUrl":{
            "type":"string",
            "description":"The image's complete URL. This is a read-only property."
        },
        "size":{
            "$ref":"#/definitions/SizeRest10",
            "description":"The size of the image. Contains 3 fields: type, width and height. \"type\" should be set to \"Size\", and width and height can be set to the image's desired dimensions."
        },
        "thumbnailUrl":{
            "type":"string",
            "description":"The image's thumbnail URL. This is a read-only property."
        }
    }
}

Nested Schema : Size

Type: object

Title: Size

Show Source

type(optional): string

{
    "title":"Size",
    "properties":{
        "type":{
            "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.

Examples

Retrieve the first 2 images in your database:


GET /api/REST/1.0/assets/images?count=2

Response:


{
    "elements":[
        {
            "type":"ImageFile",
            "id":"122",
            "createdAt":"1422481688",
            "createdBy":"19",
            "depth":"minimal",
            "folderId":"375",
            "name":"radio.png",
            "updatedAt":"1422481690",
            "updatedBy":"19"
        },
        {
            "type":"ImageFile",
            "id":"123",
            "createdAt":"1422482336",
            "createdBy":"19",
            "depth":"minimal",
            "folderId":"376",
            "name":"social_google_box.png",
            "updatedAt":"1422482337",
            "updatedBy":"19"
        }
    ],
    "page":1,
    "pageSize":1000,
    "total":2
}