shareSavedSearch

Click to copy

Share a saved search

Update the list of groups a saved search is shared with by specifying the updated list in the json body. The adminAdvanced privilege is required.

Share Saved Search Parameters:

ParameterDescriptionData Type
groupIdsRequired. Defines the Group Ids that the saved search will be shared with.Array[String]

Body parameter

Use dark colors for code blocksCopy
1
2
3
4
5
{
  "groupIds": [
    "string"
  ]
}

Query parameters

NameTypeRequired

token

string

Path parameters

NameTypeRequired

searchId

string

orgId

string

itemId

string

Examples

Request

Use dark colors for code blocksCopy
1
2
3
4
5
# You can also use wget
curl -X POST /{orgId}/{itemId}/searches/{searchId}/shareWith \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Response

200 Response

Use dark colors for code blocksCopy
1
2
3
{
  "success": true
}
StatusMeaningDescriptionSchema

200

OK

success

Success

400

Bad Request

Error

WorkflowExceptionDTO

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.