{"openapi":"3.0.1","info":{"title":"Search","description":"Search across Perspio system objects - global object search over the tenant's assets, devices, asset groups, geofences and rules; proximity asset search; and management of saved search artifacts.","version":"v3"},"servers":[{"url":"https://talk.perspio.io/search/v3","description":"AU Region"},{"url":"https://us-talk.perspio.io/search/v3","description":"US Region"}],"paths":{"/assetsinproximity":{"get":{"tags":["Search"],"summary":"Get Assets In Proximity","description":"Find assets within a radius of a point, ordered by distance. When history=true each asset includes its recent location history, bounded by the optional from/to date range.","operationId":"getassetsinproximity","parameters":[{"name":"lat","in":"query","description":"Format - double. Format - double. Format - double. Latitude","required":true,"schema":{"type":"number","format":"double"}},{"name":"lon","in":"query","description":"Format - double. Format - double. Format - double. Longitude","required":true,"schema":{"type":"number","format":"double"}},{"name":"radius","in":"query","description":"Format - double. Format - double. Format - double. Distance in meters to search for","required":true,"schema":{"type":"number","format":"double","default":5000}},{"name":"take","in":"query","description":"Number of results to return","schema":{"type":"integer","default":10}},{"name":"history","in":"query","description":"When true, include each matched asset's recent location history.","schema":{"type":"boolean"},"example":"False"},{"name":"assetids","in":"query","description":"Optional list of asset ids to restrict the proximity search to.","schema":{"type":"array","items":{"type":"string"}}},{"name":"from","in":"query","description":"Start of the location-history date range (used when history=true).","schema":{"type":"string","format":"date-time"}},{"name":"to","in":"query","description":"End of the location-history date range (used when history=true).","schema":{"type":"string","format":"date-time"}},{"name":"x-perspio-filter","in":"header","description":"Global data filter (JSON-serialised) scoping results to matching assets. Optional keys, each an array of strings: locationHierarchyL1..L3, productHierarchyL1..L3, operationalHierarchyL1..L3, groupIds; plus boolean 'enabled'. Omit for no additional filtering (security-group scoping always applies). Example: {\"locationHierarchyL1\":[\"NSW\"],\"enabled\":true}","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"active":{"type":"boolean","description":"Whether the asset is currently active/enabled."},"assetId":{"type":"string","description":"Asset identifier."},"assetName":{"type":"string","description":"Display name of the asset."},"assetTypeId":{"type":"integer","description":"Asset type identifier.","format":"int32"},"contactEmail":{"type":"string","description":"Contact email associated with the asset."},"contactName":{"type":"string","description":"Contact name associated with the asset."},"contactPhone":{"type":"string","description":"Contact phone associated with the asset."},"correlationId":{"type":"string"},"createdBy":{"type":"string"},"createdDate":{"type":"string","format":"date-time"},"customerAssetId":{"type":"string"},"customerOdometer":{"type":"number","format":"double","nullable":true},"customerRunHours":{"type":"number","format":"double","nullable":true},"deviceDataJson":{"type":"string"},"distance":{"type":"number","description":"Distance from the query point to the asset, in metres.","format":"double"},"encodedSystemFlags":{"type":"integer","format":"int32"},"id":{"type":"string","description":"Unique identifier of the saved search artifact."},"insideGeofenceJson":{"type":"string"},"lastCommunicatedEpoch":{"type":"integer","format":"int64"},"lastCommunicatedUtc":{"type":"string","description":"UTC timestamp of the asset's most recent communication.","format":"date-time"},"lastSynchronizedUtc":{"type":"string","format":"date-time"},"latitude":{"type":"number","description":"Latitude of the location.","format":"double"},"locationHierarchy":{"type":"object","properties":{"level1":{"type":"string"},"level2":{"type":"string"},"level3":{"type":"string"}}},"locations":{"type":"array","items":{"type":"object","properties":{"lastCommunicatedUtc":{"type":"string","description":"UTC timestamp of the asset's most recent communication.","format":"date-time","nullable":true},"latitude":{"type":"number","description":"Latitude of the location.","format":"double","nullable":true},"longitude":{"type":"number","description":"Longitude of the location.","format":"double","nullable":true}}},"description":"Recent location history for the asset (returned when history=true)."},"longitude":{"type":"number","description":"Longitude of the location.","format":"double"},"markerChoice":{"type":"string"},"markerType":{"type":"integer","format":"int32","nullable":true},"odometer":{"type":"number","format":"double","nullable":true},"odometerSource":{"type":"integer","format":"int32","nullable":true},"ownedBy":{"type":"string"},"perspioCounter1":{"type":"number","format":"double","nullable":true},"perspioCounter2":{"type":"number","format":"double","nullable":true},"perspioCounter3":{"type":"number","format":"double","nullable":true},"perspioOdometer":{"type":"number","format":"double","nullable":true},"perspioRunHours":{"type":"number","format":"double","nullable":true},"preferredMetersSource":{"type":"integer","format":"int32"},"preferredOdometer":{"type":"number","format":"double","nullable":true},"preferredRunHours":{"type":"number","format":"double","nullable":true},"productHierarchy":{"type":"object","properties":{"level1":{"type":"string"},"level2":{"type":"string"},"level3":{"type":"string"}}},"relatedObjectsCount":{"type":"integer","format":"int32"},"runHours":{"type":"number","format":"double","nullable":true},"runHoursSource":{"type":"integer","format":"int32","nullable":true},"sourceSysAssetId":{"type":"string"},"streetAddress":{"type":"string","description":"Street address of the asset's location."},"tenantId":{"type":"string","description":"Identifier of the owning tenant."},"timeZone":{"type":"string"},"updatedBy":{"type":"string"},"updatedDate":{"type":"string","format":"date-time"}}}},"example":[{"active":true,"assetId":"asset-001","assetName":"Delivery Truck A","assetTypeId":12,"contactEmail":"contact@deliveryco.com","contactName":"John Doe","contactPhone":"+61412345678","correlationId":"corr-12345","createdBy":"admin@example.com","createdDate":"2025-07-02T08:00:00.0000000+00:00","customerAssetId":"cust-asset-001","customerOdometer":10500.75,"customerRunHours":250.5,"deviceDataJson":"{\"engineStatus\": \"running\", \"fuelLevel\": 65}","distance":123456.78,"encodedSystemFlags":3,"id":"id-asset-001","insideGeofenceJson":"{\"geofenceId\":\"geo-1001\", \"status\":true}","lastCommunicatedEpoch":1688284800,"lastCommunicatedUtc":"2025-07-02T07:00:00.0000000+00:00","lastSynchronizedUtc":"2025-07-02T07:30:00.0000000+00:00","latitude":-33.8688,"locationHierarchy":{"level1":"Australia","level2":"New South Wales","level3":"Sydney"},"locations":[{"lastCommunicatedUtc":"2025-07-02T06:50:00.0000000+00:00","latitude":-33.869,"longitude":151.2094},{"lastCommunicatedUtc":"2025-07-02T06:55:00.0000000+00:00","latitude":-33.87,"longitude":151.21}],"longitude":151.2093,"markerChoice":"red","markerType":1,"odometer":10510.5,"odometerSource":2,"ownedBy":"fleet-management","perspioCounter1":12.5,"perspioCounter2":5,"perspioCounter3":7.75,"perspioOdometer":10505.5,"perspioRunHours":252,"preferredMetersSource":1,"preferredOdometer":10515,"preferredRunHours":253,"productHierarchy":{"level1":"Vehicles","level2":"Trucks","level3":"Delivery Trucks"},"relatedObjectsCount":3,"runHours":255.5,"runHoursSource":1,"sourceSysAssetId":"sys-asset-001","streetAddress":"123 George Street, Sydney","tenantId":"tenant-001","timeZone":"Australia/Sydney","updatedBy":"admin@example.com","updatedDate":"2025-07-02T08:30:00.0000000+00:00"}]}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PerspioError"},"example":{"functionName":"Perspio.API.AssetData.AssetDetailsApi.GetAssetsInProximity","errorType":"ArgumentException","statusCode":400,"request":"GET /api/searchassets","tenantId":"in-93b1a4c6-1234-4c1c-9d2a-1f2e3d4c5b6a","message":"perpsioObject is invalid. Please pass a valid perspio Object: "}}}},"401":{"description":"Invalid API Key provided or Invalid Access token"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PerspioError"},"example":{"functionName":"Perspio.API.AssetData.AssetDetailsApi.GetAssetsInProximity","errorType":"NullReferenceException","statusCode":500,"request":"GET /api/searchassets","tenantId":"in-93b1a4c6-1234-4c1c-9d2a-1f2e3d4c5b6a","message":"Internal Server Error: Object reference not set to an instance of an object."}}}}}}},"/":{"get":{"tags":["Search"],"summary":"Global Search","description":"Search the tenant's system-object cache - assets, devices, asset groups, geofences and rules - by free text, optionally restricted to a single Perspio object type and a set of asset types. Returns the matching objects grouped by type.","operationId":"globalSearch","parameters":[{"name":"searchString","in":"query","schema":{"type":"string"},"examples":{"searchByAssetId":{"summary":"Search by Asset Id","value":"in-000052"},"searchByDeviceId":{"summary":"Search by Device Id","value":"DM-551859"},"searchByAssetGroupId":{"summary":"Search by Asset Group Id","value":"ASTG-001"},"searchByGeofenceId":{"summary":"Search by Geofence Id","value":"in-gf-000058"},"searchByWorkflowId":{"summary":"Search by Workflow Id","value":"in-wf-000825"}}},{"name":"perspioObject","in":"query","description":"Restrict the search to a single Perspio object type (asset, device, assetGroup, geofence, rule).","schema":{"type":"string"},"examples":{"assetExample":{"summary":"Search in assets","value":"asset"},"deviceExample":{"summary":"Search in devices","value":"device"},"groupExample":{"summary":"Search in asset groups","value":"assetgroup"},"geofenceExample":{"summary":"Search in geofences","value":"geofence"},"workflowExample":{"summary":"Search in workflows","value":"rule"}}},{"name":"top","in":"query","schema":{"type":"integer","default":10},"example":5},{"name":"assetTypeIds","in":"query","schema":{"type":"array","items":{"type":"integer"}},"example":[1,2]},{"name":"x-perspio-filter","in":"header","description":"Global data filter (JSON-serialised) scoping results to matching assets. Optional keys, each an array of strings: locationHierarchyL1..L3, productHierarchyL1..L3, operationalHierarchyL1..L3, groupIds; plus boolean 'enabled'. Omit for no additional filtering (security-group scoping always applies). Example: {\"locationHierarchyL1\":[\"NSW\"],\"enabled\":true}","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"assets":{"type":"array","items":{"type":"object","properties":{"customerAssetId":{"type":"string"},"sourceSystemAssetId":{"type":"string"},"markerChoice":{"type":"string"},"markerType":{"type":"integer","format":"int32"},"id":{"type":"string","description":"Unique identifier of the saved search artifact."},"name":{"type":"string"}}}},"assetGroups":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the saved search artifact."},"name":{"type":"string"}}}},"geoFences":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the saved search artifact."},"name":{"type":"string"}}}},"rules":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the saved search artifact."},"name":{"type":"string"}}}}}},"example":{"assets":[{"customerAssetId":"cust-001","sourceSystemAssetId":"sys-1001","markerChoice":"blue","markerType":1,"id":"asset-001","name":"Forklift A"},{"customerAssetId":"cust-002","sourceSystemAssetId":"sys-1002","markerChoice":"red","markerType":2,"id":"asset-002","name":"Truck B"}],"assetGroups":[{"id":"group-01","name":"Warehouse Equipment"},{"id":"group-02","name":"Delivery Vehicles"}],"geoFences":[{"id":"gf-001","name":"Main Warehouse"},{"id":"gf-002","name":"Distribution Center"}],"rules":[{"id":"rule-01","name":"Speed Limit Alert"},{"id":"rule-02","name":"After Hours Movement"}]}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PerspioError"},"example":{"functionName":"Perspio.API.Search.Search.GlobalSearch","errorType":"ArgumentException","statusCode":400,"request":"GET /api/search","tenantId":"in-93b1a4c6-1234-4c1c-9d2a-1f2e3d4c5b6a","message":"perpsioObject is invalid. Please pass a valid perspio Object: "}}}},"401":{"description":"Invalid API Key provided or Invalid Bearer token"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PerspioError"},"example":{"functionName":"Perspio.API.Search.Search.GlobalSearch","errorType":"NullReferenceException","statusCode":500,"request":"GET /api/search","tenantId":"in-93b1a4c6-1234-4c1c-9d2a-1f2e3d4c5b6a","message":"Internal Server Error: Object reference not set to an instance of an object."}}}}}}},"/dependency/{objectId}":{"get":{"tags":["Search"],"summary":"Get Object Dependency","description":"Return the objects that depend on the given object. Passthrough lookup endpoint. Optionally append `/{objectType}` (e.g. asset, device, geofence) to scope the lookup to a single object type; omitted returns dependents of all types.","operationId":"getObjectDependencies","parameters":[{"name":"objectId","in":"path","description":"Id of the object whose dependents to return (matches the backend objectId path segment).","required":true,"schema":{"type":"string","example":"IN-000123"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"objectType":{"type":"string","description":"Type of the dependent object (e.g. asset, device, rule)."},"id":{"type":"string","description":"Unique identifier of the saved search artifact."},"name":{"type":"string","description":"Display name of the dependent object."}}}},"example":[{"objectType":"Asset","id":"asset-001","name":"Forklift A"},{"objectType":"GeoFence","id":"gf-002","name":"Main Warehouse Zone"},{"objectType":"Rule","id":"rule-123","name":"Speed Limit Alert"}]}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PerspioError"},"example":{"functionName":"Perspio.API.AssetData.ValidationService.CheckObjectDependency","errorType":"ArgumentException","statusCode":400,"request":"GET /api/dependency/IN-000123","tenantId":"in-93b1a4c6-1234-4c1c-9d2a-1f2e3d4c5b6a","message":"perpsioObject is invalid. Please pass a valid perspio Object: "}}}},"401":{"description":"Invalid API Key provided or Invalid Access token"},"404":{"description":"Resource Not Found"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PerspioError"},"example":{"functionName":"Perspio.API.AssetData.ValidationService.CheckObjectDependency","errorType":"NullReferenceException","statusCode":500,"request":"GET /api/dependency/IN-000123","tenantId":"in-93b1a4c6-1234-4c1c-9d2a-1f2e3d4c5b6a","message":"Internal Server Error: Object reference not set to an instance of an object."}}}}}}},"/artifacts":{"get":{"tags":["Saved Searches"],"summary":"Get Saved Searches","description":"Fetch the saved search artifacts of the given type, optionally filtered by owner email and a created-from date.","operationId":"getSavedSearches","parameters":[{"name":"searchArtifactType","in":"query","description":"Get Search Artifacts for a specifed Type. 1 - Proximity, 2 - Proximity with History, 3 - Condition Search, 4 - Global","required":true,"schema":{"enum":["1","2","3","4"],"type":"string","description":"1 - Proximity, 2 - Proximity with History, 3 - Condition Search, 4 - Global","default":"4"}},{"name":"userEmail","in":"query","description":"Get Search Artifacts for a specifed user","schema":{"type":"string","example":"user@perspio.io"}},{"name":"from","in":"query","description":"DateTime to search saved artifacts from (in ISO 8601 format)","schema":{"type":"string","format":"date-time"},"example":"2024-06-16T02:00:00.0000000+00:00"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SavedSearchArtifact"}},"example":[{"id":"search-002","dateTime":"2025-06-26T04:00:00.0000000+00:00","title":"Condition Search: Speeding Vehicles","description":"Vehicles exceeding speed limit of 80 km/h","searchArtifactType":3,"payload":{"condition":{"field":"speed","operator":">","value":80}}}]}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PerspioError"},"example":{"functionName":"Perspio.API.Search.Search.GetSavedSearchArtifacts","errorType":"ArgumentException","statusCode":400,"request":"GET /api/search/artifacts","tenantId":"in-93b1a4c6-1234-4c1c-9d2a-1f2e3d4c5b6a","message":"perpsioObject is invalid. Please pass a valid perspio Object: "}}}},"401":{"description":"Invalid API Key provided or Invalid Bearer token"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PerspioError"},"example":{"functionName":"Perspio.API.Search.Search.GetSavedSearchArtifacts","errorType":"NullReferenceException","statusCode":500,"request":"GET /api/search/artifacts","tenantId":"in-93b1a4c6-1234-4c1c-9d2a-1f2e3d4c5b6a","message":"Internal Server Error: Object reference not set to an instance of an object."}}}}}},"post":{"tags":["Saved Searches"],"summary":"Save Search","description":"Create and persist a new saved search artifact. Returns the saved artifact including its generated id.","operationId":"saveSearch","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewSearchArtifactToSave"},"example":{"title":"string","description":"string","searchArtifactType":0,"payload":{}}}}},"responses":{"200":{"description":"The saved search artifact, including its generated id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SavedSearchArtifact"},"example":{"id":"search-001","dateTime":"2025-06-26T04:00:00.0000000+00:00","title":"Saved Asset Search: Cold Chain Fleet","description":"Refrigerated vehicles assigned to the northern depot","searchArtifactType":1,"payload":{"assetTypeIds":[1,2],"searchString":"cold chain"}}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PerspioError"},"example":{"functionName":"Perspio.API.Search.Search.CreateSearchArtifact","errorType":"ArgumentException","statusCode":400,"request":"POST /api/search/artifacts","tenantId":"in-93b1a4c6-1234-4c1c-9d2a-1f2e3d4c5b6a","message":"perpsioObject is invalid. Please pass a valid perspio Object: "}}}},"401":{"description":"Invalid API Key provided or Invalid Access token"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PerspioError"},"example":{"functionName":"Perspio.API.Search.Search.CreateSearchArtifact","errorType":"NullReferenceException","statusCode":500,"request":"POST /api/search/artifacts","tenantId":"in-93b1a4c6-1234-4c1c-9d2a-1f2e3d4c5b6a","message":"Internal Server Error: Object reference not set to an instance of an object."}}}}}}},"/artifacts/{id}":{"delete":{"tags":["Saved Searches"],"summary":"Delete Saved Search","description":"Delete a saved search artifact by id.","operationId":"deleteSavedSearch","parameters":[{"name":"id","in":"path","description":"Search Artifact ID (GUID)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The saved search artifact was deleted."},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PerspioError"},"example":{"functionName":"Perspio.API.Search.Search.DeleteSavedSearchArtifact","errorType":"ArgumentException","statusCode":400,"request":"DELETE /api/search/artifacts/in-000052","tenantId":"in-93b1a4c6-1234-4c1c-9d2a-1f2e3d4c5b6a","message":"perpsioObject is invalid. Please pass a valid perspio Object: "}}}},"401":{"description":"Invalid API Key provided or Invalid Access token"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PerspioError"},"example":{"functionName":"Perspio.API.Search.Search.DeleteSavedSearchArtifact","errorType":"NullReferenceException","statusCode":500,"request":"DELETE /api/search/artifacts/in-000052","tenantId":"in-93b1a4c6-1234-4c1c-9d2a-1f2e3d4c5b6a","message":"Internal Server Error: Object reference not set to an instance of an object."}}}}}},"put":{"tags":["Saved Searches"],"summary":"Edit Search","description":"Update an existing saved search artifact by id. Returns the updated artifact.","operationId":"editSearch","parameters":[{"name":"id","in":"path","description":"Search Artifact ID (GUID)","required":true,"schema":{"type":"string"},"example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewSearchArtifactToSave"},"example":{"id":"search-002","dateTime":"2025-06-26T04:00:00.0000000+00:00","title":"Condition Search: Speeding Vehicles","description":"Vehicles exceeding speed limit of 80 km/h","searchArtifactType":3,"payload":{"condition":{"field":"speed","operator":">","value":80}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SavedSearchArtifact"},"example":{"id":"search-002","dateTime":"2025-06-26T04:00:00.0000000+00:00","title":"Condition Search: Speeding Vehicles","description":"Vehicles exceeding speed limit of 80 km/h","searchArtifactType":3,"payload":{"condition":{"field":"speed","operator":">","value":80}}}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PerspioError"},"example":{"functionName":"Perspio.API.Search.Search.EditSearchArtifact","errorType":"ArgumentException","statusCode":400,"request":"PUT /api/search/artifacts/3fa85f64-5717-4562-b3fc-2c963f66afa6","tenantId":"in-93b1a4c6-1234-4c1c-9d2a-1f2e3d4c5b6a","message":"perpsioObject is invalid. Please pass a valid perspio Object: "}}}},"401":{"description":"Invalid API Key provided or Invalid Access token"},"404":{"description":"Search Artifact Not Found"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PerspioError"},"example":{"functionName":"Perspio.API.Search.Search.EditSearchArtifact","errorType":"NullReferenceException","statusCode":500,"request":"PUT /api/search/artifacts/3fa85f64-5717-4562-b3fc-2c963f66afa6","tenantId":"in-93b1a4c6-1234-4c1c-9d2a-1f2e3d4c5b6a","message":"Internal Server Error: Object reference not set to an instance of an object."}}}}}}}},"components":{"schemas":{"PerspioError":{"type":"object","properties":{"functionName":{"type":"string","description":"Name of the backend function that raised the error."},"errorType":{"type":"string","description":"Exception/error type name."},"statusCode":{"type":"integer","description":"HTTP status code of the error.","format":"int32"},"request":{"type":"string","description":"Method and URL of the failing request."},"tenantId":{"type":"string","description":"Tenant the request was executed for."},"message":{"type":"string","description":"Human-readable error message."}},"description":"Standard Perspio backend error body (ErrorResultObject emitted by the error-handling middleware)."},"SavedSearchArtifact":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the saved search artifact."},"dateTime":{"type":"string","description":"UTC timestamp when the artifact was created or last saved."},"title":{"type":"string","description":"Display name of the saved search."},"description":{"type":"string","description":"Free-text description of the saved search."},"searchArtifactType":{"type":"integer","description":"Type of saved search (SearchArtifactType enum, serialised as its integer value)."},"payload":{"type":"object","description":"Payload that was saved. The type depends on the searchArtifactType. For example, if searchArtifactType is 1, then payload will be of type SearchArtifactType 1 & 2 (Proximity), payload is query string. For 3 (Condition Search), payload is a JSON object comprising the Condition."}}},"NewSearchArtifactToSave":{"type":"object","properties":{"title":{"type":"string","description":"Display name of the saved search."},"description":{"type":"string","description":"Free-text description of the saved search."},"searchArtifactType":{"type":"integer","description":"Type of saved search (SearchArtifactType enum, serialised as its integer value)."},"payload":{"type":"object","description":"Payload to be saved. The type depends on the searchArtifactType. For example, if searchArtifactType is 1, then payload will be of type SearchArtifactType 1 & 2 (Proximity), payload is query string. For 3 (Condition Search), payload is a JSON object comprising the Condition."}}}},"securitySchemes":{"oauth2":{"type":"oauth2","description":"Client credentials from your Perspio API application. See Get Access Token.","flows":{"clientCredentials":{"tokenUrl":"/auth/v3/token","scopes":{}}}},"subscriptionKey":{"type":"apiKey","name":"Ocp-Apim-Subscription-Key","in":"header","description":"Your tenant's subscription key, from your API application."},"tenantId":{"type":"apiKey","name":"tid","in":"header","description":"Your tenant ID (tid), from your API application."}}},"security":[{"oauth2":[],"subscriptionKey":[],"tenantId":[]}],"tags":[{"name":"Search","description":"Global object search, proximity asset search and object dependency lookups."},{"name":"Saved Searches","description":"Create, retrieve, update and delete saved search artifacts."}],"x-readme":{"oauth-options":{"useInsecureClientAuthentication":true}}}