Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Response
A successful response.
curl --request GET \
--url https://your-sift-api-url.com/api/v1/rules \
--header 'Authorization: Bearer <token>'{
"rule": {
"ruleId": "<string>",
"assetId": "<string>",
"name": "<string>",
"description": "<string>",
"isEnabled": true,
"createdDate": "2023-11-07T05:31:56Z",
"modifiedDate": "2023-11-07T05:31:56Z",
"createdByUserId": "<string>",
"modifiedByUserId": "<string>",
"organizationId": "<string>",
"conditions": [
{
"ruleConditionId": "<string>",
"ruleId": "<string>",
"expression": {
"singleChannelComparison": {
"channelComponent": "<string>",
"channelName": "<string>",
"comparator": "CONDITION_COMPARATOR_UNSPECIFIED",
"double": 123,
"string": "<string>",
"lastValue": {}
},
"calculatedChannel": {
"channelReferences": {},
"expression": "<string>",
"functionDependencies": [
{
"userDefinedFunctionVersionId": "<string>"
}
]
}
},
"createdDate": "2023-11-07T05:31:56Z",
"modifiedDate": "2023-11-07T05:31:56Z",
"createdByUserId": "<string>",
"modifiedByUserId": "<string>",
"actions": [
{
"ruleActionId": "<string>",
"ruleConditionId": "<string>",
"actionType": "ACTION_KIND_UNSPECIFIED",
"configuration": {
"notification": {
"recipientUserIds": [
"<string>"
]
},
"annotation": {
"tagIds": [
"<string>"
],
"annotationType": "ANNOTATION_TYPE_UNSPECIFIED",
"assignedToUserId": "<string>",
"metadata": [
{
"key": {
"name": "<any>",
"type": "<any>",
"archivedDate": "<any>"
},
"stringValue": "<string>",
"numberValue": 123,
"booleanValue": true,
"archivedDate": "2023-11-07T05:31:56Z"
}
]
}
},
"createdDate": "2023-11-07T05:31:56Z",
"modifiedDate": "2023-11-07T05:31:56Z",
"createdByUserId": "<string>",
"modifiedByUserId": "<string>",
"ruleActionVersionId": "<string>"
}
],
"ruleConditionVersionId": "<string>"
}
],
"ruleVersion": {
"ruleId": "<string>",
"ruleVersionId": "<string>",
"version": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"createdByUserId": "<string>",
"versionNotes": "<string>",
"generatedChangeMessage": "<string>",
"deletedDate": "2023-11-07T05:31:56Z"
},
"clientKey": "<string>",
"assetConfiguration": {
"assetIds": [
"<string>"
],
"tagIds": [
"<string>"
]
},
"contextualChannels": {
"channels": [
{
"name": "<string>",
"component": "<string>"
}
]
},
"deletedDate": "2023-11-07T05:31:56Z",
"isExternal": true,
"metadata": [
{
"key": {
"name": "<string>",
"type": "METADATA_KEY_TYPE_UNSPECIFIED",
"archivedDate": "2023-11-07T05:31:56Z"
},
"stringValue": "<string>",
"numberValue": 123,
"booleanValue": true,
"archivedDate": "2023-11-07T05:31:56Z"
}
]
}
}Retrieves the latest version of a rule.
curl --request GET \
--url https://your-sift-api-url.com/api/v1/rules \
--header 'Authorization: Bearer <token>'{
"rule": {
"ruleId": "<string>",
"assetId": "<string>",
"name": "<string>",
"description": "<string>",
"isEnabled": true,
"createdDate": "2023-11-07T05:31:56Z",
"modifiedDate": "2023-11-07T05:31:56Z",
"createdByUserId": "<string>",
"modifiedByUserId": "<string>",
"organizationId": "<string>",
"conditions": [
{
"ruleConditionId": "<string>",
"ruleId": "<string>",
"expression": {
"singleChannelComparison": {
"channelComponent": "<string>",
"channelName": "<string>",
"comparator": "CONDITION_COMPARATOR_UNSPECIFIED",
"double": 123,
"string": "<string>",
"lastValue": {}
},
"calculatedChannel": {
"channelReferences": {},
"expression": "<string>",
"functionDependencies": [
{
"userDefinedFunctionVersionId": "<string>"
}
]
}
},
"createdDate": "2023-11-07T05:31:56Z",
"modifiedDate": "2023-11-07T05:31:56Z",
"createdByUserId": "<string>",
"modifiedByUserId": "<string>",
"actions": [
{
"ruleActionId": "<string>",
"ruleConditionId": "<string>",
"actionType": "ACTION_KIND_UNSPECIFIED",
"configuration": {
"notification": {
"recipientUserIds": [
"<string>"
]
},
"annotation": {
"tagIds": [
"<string>"
],
"annotationType": "ANNOTATION_TYPE_UNSPECIFIED",
"assignedToUserId": "<string>",
"metadata": [
{
"key": {
"name": "<any>",
"type": "<any>",
"archivedDate": "<any>"
},
"stringValue": "<string>",
"numberValue": 123,
"booleanValue": true,
"archivedDate": "2023-11-07T05:31:56Z"
}
]
}
},
"createdDate": "2023-11-07T05:31:56Z",
"modifiedDate": "2023-11-07T05:31:56Z",
"createdByUserId": "<string>",
"modifiedByUserId": "<string>",
"ruleActionVersionId": "<string>"
}
],
"ruleConditionVersionId": "<string>"
}
],
"ruleVersion": {
"ruleId": "<string>",
"ruleVersionId": "<string>",
"version": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"createdByUserId": "<string>",
"versionNotes": "<string>",
"generatedChangeMessage": "<string>",
"deletedDate": "2023-11-07T05:31:56Z"
},
"clientKey": "<string>",
"assetConfiguration": {
"assetIds": [
"<string>"
],
"tagIds": [
"<string>"
]
},
"contextualChannels": {
"channels": [
{
"name": "<string>",
"component": "<string>"
}
]
},
"deletedDate": "2023-11-07T05:31:56Z",
"isExternal": true,
"metadata": [
{
"key": {
"name": "<string>",
"type": "METADATA_KEY_TYPE_UNSPECIFIED",
"archivedDate": "2023-11-07T05:31:56Z"
},
"stringValue": "<string>",
"numberValue": 123,
"booleanValue": true,
"archivedDate": "2023-11-07T05:31:56Z"
}
]
}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
A successful response.
Show child attributes
Was this page helpful?