ValidateUserDefinedFunction
curl --request POST \
--url https://api.siftstack.com/api/v1/user-defined-functions:validate \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"expression": "<string>",
"functionInputs": [
{
"identifier": "<string>",
"dataType": "FUNCTION_DATA_TYPE_UNSPECIFIED",
"constant": true
}
]
}
'import requests
url = "https://api.siftstack.com/api/v1/user-defined-functions:validate"
payload = {
"expression": "<string>",
"functionInputs": [
{
"identifier": "<string>",
"dataType": "FUNCTION_DATA_TYPE_UNSPECIFIED",
"constant": True
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.siftstack.com/api/v1/user-defined-functions:validate"
payload := strings.NewReader("{\n \"expression\": \"<string>\",\n \"functionInputs\": [\n {\n \"identifier\": \"<string>\",\n \"dataType\": \"FUNCTION_DATA_TYPE_UNSPECIFIED\",\n \"constant\": true\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"error": {
"errorMessage": "<string>"
},
"success": {
"userDefinedFunction": {
"userDefinedFunctionId": "<string>",
"name": "<string>",
"userDefinedFunctionVersionId": "<string>",
"version": 123,
"description": "<string>",
"changeMessage": "<string>",
"userNotes": "<string>",
"expression": "<string>",
"functionInputs": [
{
"identifier": "<string>",
"dataType": "FUNCTION_DATA_TYPE_UNSPECIFIED",
"constant": true
}
],
"functionDependencies": [
{
"userDefinedFunctionVersionId": "<string>"
}
],
"createdDate": "2023-11-07T05:31:56Z",
"modifiedDate": "2023-11-07T05:31:56Z",
"createdByUserId": "<string>",
"modifiedByUserId": "<string>",
"metadata": [
{
"key": {
"name": "<string>",
"type": "METADATA_KEY_TYPE_UNSPECIFIED",
"archivedDate": "2023-11-07T05:31:56Z",
"isArchived": true
},
"stringValue": "<string>",
"numberValue": 123,
"booleanValue": true,
"relationValue": {
"resourceType": "<string>",
"resourceId": "<string>"
},
"archivedDate": "2023-11-07T05:31:56Z",
"isArchived": true
}
],
"isArchived": true,
"archivedDate": "2023-11-07T05:31:56Z",
"functionOutputType": "FUNCTION_DATA_TYPE_UNSPECIFIED"
}
}
}{
"code": 123,
"message": "<string>",
"details": [
{
"@type": "<string>"
}
]
}UserDefinedFunctionService
ValidateUserDefinedFunction
Validates a potential user defined function.
POST
/
api
/
v1
/
user-defined-functions:validate
ValidateUserDefinedFunction
curl --request POST \
--url https://api.siftstack.com/api/v1/user-defined-functions:validate \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"expression": "<string>",
"functionInputs": [
{
"identifier": "<string>",
"dataType": "FUNCTION_DATA_TYPE_UNSPECIFIED",
"constant": true
}
]
}
'import requests
url = "https://api.siftstack.com/api/v1/user-defined-functions:validate"
payload = {
"expression": "<string>",
"functionInputs": [
{
"identifier": "<string>",
"dataType": "FUNCTION_DATA_TYPE_UNSPECIFIED",
"constant": True
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.siftstack.com/api/v1/user-defined-functions:validate"
payload := strings.NewReader("{\n \"expression\": \"<string>\",\n \"functionInputs\": [\n {\n \"identifier\": \"<string>\",\n \"dataType\": \"FUNCTION_DATA_TYPE_UNSPECIFIED\",\n \"constant\": true\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"error": {
"errorMessage": "<string>"
},
"success": {
"userDefinedFunction": {
"userDefinedFunctionId": "<string>",
"name": "<string>",
"userDefinedFunctionVersionId": "<string>",
"version": 123,
"description": "<string>",
"changeMessage": "<string>",
"userNotes": "<string>",
"expression": "<string>",
"functionInputs": [
{
"identifier": "<string>",
"dataType": "FUNCTION_DATA_TYPE_UNSPECIFIED",
"constant": true
}
],
"functionDependencies": [
{
"userDefinedFunctionVersionId": "<string>"
}
],
"createdDate": "2023-11-07T05:31:56Z",
"modifiedDate": "2023-11-07T05:31:56Z",
"createdByUserId": "<string>",
"modifiedByUserId": "<string>",
"metadata": [
{
"key": {
"name": "<string>",
"type": "METADATA_KEY_TYPE_UNSPECIFIED",
"archivedDate": "2023-11-07T05:31:56Z",
"isArchived": true
},
"stringValue": "<string>",
"numberValue": 123,
"booleanValue": true,
"relationValue": {
"resourceType": "<string>",
"resourceId": "<string>"
},
"archivedDate": "2023-11-07T05:31:56Z",
"isArchived": true
}
],
"isArchived": true,
"archivedDate": "2023-11-07T05:31:56Z",
"functionOutputType": "FUNCTION_DATA_TYPE_UNSPECIFIED"
}
}
}{
"code": 123,
"message": "<string>",
"details": [
{
"@type": "<string>"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Was this page helpful?
⌘I