Watchlist

Get Watchlist

Endpoint to retrieve a single Watchlist by ID

post/security-watchlist/{id}/get-item

Request

Path parameters

idstring uuid required

ID of the Watchlist to retrieve

Request body

Example request

{
  "select": {
    "_id": true,
    "createdAt": true,
    "updatedAt": true,
    "name": true,
    "entityType": true,
    "source": true,
    "importSchedule": true
  }
}

Response

Successful response

Example response

{
  "data": {
    "_id": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "updatedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "deletedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "version": 42,
    "projectId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "vip_users",
    "description": "This is an example of longer text content that might be stored in this field.",
    "entityType": "User",
    "source": "Values",
    "threatIntelFeedId": "123e4567-e89b-12d3-a456-426614174000",
    "importUrl": "https://example.com/vip-users.csv",
    "importSchedule": "Every Hour",
    "nextImportAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "lastImportAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "lastImportSucceededAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "lastImportError": "This is an example of very long text content that might be stored in this field. It can contain a lot of information, such as detailed descriptions, comments, or any other lengthy text data that needs to be stored in the database.",
    "lastImportErrorDetail": "This is an example of very long text content that might be stored in this field. It can contain a lot of information, such as detailed descriptions, comments, or any other lengthy text data that needs to be stored in the database.",
    "lastImportLinesLeftOut": 42,
    "valueCount": 42,
    "createdByUserId": "123e4567-e89b-12d3-a456-426614174000",
    "deletedByUserId": "123e4567-e89b-12d3-a456-426614174000"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.