UpdateSavedSearch

Updates an existing saved search using using the list of fields specified in `update_mask`.

PATCH

/api/v1/saved_searches

Request Body

application/jsonRequired

The request for a call to SavedSearchService_UpdateSavedSearch to update a saved search.

`savedSearch`
Required
object

`updateMask`
Required
string

The list of fields to be updated. The fields available to be updated are name and properties.

curl -X PATCH "<API_URL>/api/v1/saved_searches" \
  -H "Authorization: Bearer <API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "savedSearch": {
      "savedSearchId": "string",
      "organizationId": "string",
      "name": "string",
      "properties": {
        "overviewMode": "string",
        "searchTerm": "string",
        "fromDateTime": "2019-08-24T14:15:22Z",
        "toDateTime": "2019-08-24T14:15:22Z",
        "assetItems": [
          {
            "id": "string",
            "name": "string"
          }
        ],
        "userItems": [
          {
            "id": "string",
            "name": "string"
          }
        ],
        "tagItems": [
          {
            "id": "string",
            "name": "string"
          }
        ],
        "annotationItems": [
          {
            "id": "string",
            "name": "string"
          }
        ],
        "runItems": [
          {
            "id": "string",
            "name": "string"
          }
        ],
        "reportTemplateItems": [
          {
            "id": "string",
            "name": "string"
          }
        ],
        "showAdvancedFilters": true
      },
      "createdByUserId": "string",
      "modifiedByUserId": "string",
      "createdDate": "2019-08-24T14:15:22Z",
      "modifiedDate": "2019-08-24T14:15:22Z"
    },
    "updateMask": "string"
  }'

A successful response.

{
  "savedSearch": {
    "savedSearchId": "string",
    "organizationId": "string",
    "name": "string",
    "properties": {
      "overviewMode": "string",
      "searchTerm": "string",
      "fromDateTime": "2019-08-24T14:15:22Z",
      "toDateTime": "2019-08-24T14:15:22Z",
      "assetItems": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "userItems": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "tagItems": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "annotationItems": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "runItems": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "reportTemplateItems": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "showAdvancedFilters": true
    },
    "createdByUserId": "string",
    "modifiedByUserId": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "modifiedDate": "2019-08-24T14:15:22Z"
  }
}

Request Body

savedSearchRequiredobject

Attributes

updateMaskRequiredstring

Response

`savedSearch`
Required
object

`updateMask`
Required
string