UpdateSavedSearch

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

PATCH /api/v1/saved_searches

UpdateSavedSearch

cURL

curl --request PATCH \
  --url https://api.siftstack.com/api/v1/saved_searches \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "savedSearch": {
    "savedSearchId": "<string>",
    "organizationId": "<string>",
    "name": "<string>",
    "properties": {
      "overviewMode": "<string>",
      "searchTerm": "<string>",
      "fromDateTime": "2023-11-07T05:31:56Z",
      "toDateTime": "2023-11-07T05:31:56Z",
      "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,
      "includeArchived": true,
      "orderBy": "<string>",
      "metadataItems": [
        {
          "key": "<string>",
          "stringValue": "<string>",
          "numberValue": 123,
          "booleanValue": true
        }
      ],
      "duration": "<string>"
    },
    "createdByUserId": "<string>",
    "modifiedByUserId": "<string>",
    "createdDate": "2023-11-07T05:31:56Z",
    "modifiedDate": "2023-11-07T05:31:56Z"
  },
  "updateMask": "<string>"
}
'

200

{
  "savedSearch": {
    "savedSearchId": "<string>",
    "organizationId": "<string>",
    "name": "<string>",
    "properties": {
      "overviewMode": "<string>",
      "searchTerm": "<string>",
      "fromDateTime": "2023-11-07T05:31:56Z",
      "toDateTime": "2023-11-07T05:31:56Z",
      "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,
      "includeArchived": true,
      "orderBy": "<string>",
      "metadataItems": [
        {
          "key": "<string>",
          "stringValue": "<string>",
          "numberValue": 123,
          "booleanValue": true
        }
      ],
      "duration": "<string>"
    },
    "createdByUserId": "<string>",
    "modifiedByUserId": "<string>",
    "createdDate": "2023-11-07T05:31:56Z",
    "modifiedDate": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

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

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

savedSearch · object · required

Show child attributes

updateMask · string · required

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

Response

200

application/json

A successful response.

The response of a call to SavedSearchService_UpdateSavedSearch.

savedSearch · object · required

Show child attributes