The REST API provides access to create, retrieve, update and delete External Assets.

 

Accessing External Asset Types

  • GET :  /assets/external/types?depth=complete

 

Accessing External Assets

  • GET :  /assets/external/{id}?depth={depth}

 

Response

The response for this call looks as follows :

 

{
  "elements": [
    {
      "type": "ExternalAssetType",
      "id": "2",
      "createdAt": "1256486517",
      "depth": "complete",
      "name": "Tradeshow Sample",
      "updatedAt": "1369168490",
      "updatedBy": "23",
      "activityTypes": [
        {
          "type": "ExternalActivityType",
          "id": "1017",
          "createdAt": "1369168490",
          "createdBy": "23",
          "depth": "complete",
          "name": "Attended",
          "updatedAt": "1369168490",
          "updatedBy": "23"
        },
        {
          "type": "ExternalActivityType",
          "id": "1016",
          "createdAt": "1369168490",
          "createdBy": "23",
          "depth": "complete",
          "name": "Registered",
          "updatedAt": "1369168490",
          "updatedBy": "23"
        },
        {
          "type": "ExternalActivityType",
          "id": "1003",
          "createdAt": "1256486517",
          "depth": "complete",
          "name": "Viewed Demo",
          "updatedAt": "1369168490",
          "updatedBy": "23"
        },
        {
          "type": "ExternalActivityType",
          "id": "1002",
          "createdAt": "1256486517",
          "depth": "complete",
          "name": "Visited Booth",
          "updatedAt": "1369168490",
          "updatedBy": "23"
        }
      ]
    },
    {
      "type": "ExternalAssetType",
      "id": "3",
      "createdAt": "1347550426",
      "createdBy": "146",
      "depth": "complete",
      "name": "Direct Mail",
      "updatedAt": "1371612452",
      "updatedBy": "14",
      "activityTypes": [
        {    …   }
   }

 

Properties

 

 

Name

Type

Description

Notes

Validation

type

“ExternalAsset”

 

 

 

id

integer

The unique identifier for the External Assset

ReadOnly

 

name

string

 

 

 

createdAt

long

 

 

 

createdBy

integer

 

 

 

updatedAt

long

 

 

 

updatedBy

integer

 

 

 

 

Related Operations

  • SEARCH :  /assets/externals?depth={depth}&count={count}&page={page}&search={search}&orderBy={orderBy}&lastUpdatedAt={lastUpdatedAt}
  • POST :  /assets/external
  • PUT :  /assets/external/{id}
  • DELETE :  /assets/external/{id}

 

 

We hope that you find this helpful and please let us know if you need more information.

 

Thanks,

Fred