Endpoints under /rule
allow you to list and manage the rules.
A GET request to the /rule
endpoint retrieves a list of all stored rules.
media type | data type | description |
---|---|---|
application/json | array of Rule (JSON) | A list of Rule objects in JSON format. |
GET /v2/rule
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"ruleActions" : [ {
"actionType" : "...",
"actionDisplayName" : "...",
"actionName" : "...",
"actionAttributes" : {
"property1" : { },
"property2" : { }
}
}, {
"actionType" : "...",
"actionDisplayName" : "...",
"actionName" : "...",
"actionAttributes" : {
"property1" : { },
"property2" : { }
}
} ],
"ruleScope" : {
"tagStates" : [ "...", "..." ],
"sourcePropertyFilters" : {
"property1" : "...",
"property2" : "..."
},
"virtualFolders" : [ "...", "..." ],
"fieldTags" : [ "...", "..." ],
"resourceTags" : [ "...", "..." ]
},
"name" : "...",
"ruleBody" : "...",
"ruleType" : "...",
"metadataRule" : [ {
"tagDetails" : [ {
"tagName" : "...",
"domainName" : "..."
}, {
"tagName" : "...",
"domainName" : "..."
} ]
}, {
"tagDetails" : [ {
"tagName" : "...",
"domainName" : "..."
}, {
"tagName" : "...",
"domainName" : "..."
} ]
} ],
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ {
"description" : "...",
"value" : { },
"facetAble" : true,
"name" : "...",
"type" : "...",
"displayName" : "..."
}, {
"description" : "...",
"value" : { },
"facetAble" : true,
"name" : "...",
"type" : "...",
"displayName" : "..."
} ]
} ]
A POST request to the /rule
endpoint creates a rule.
media type | data type | description |
---|---|---|
application/json | Rule (JSON) | request payload in JSON format. |
media type | data type | description |
---|---|---|
application/json | Rule (JSON) | newly created Rule object in JSON format. |
POST /v2/rule
Content-Type: application/json
Accept: application/json
{
"ruleActions" : [ {
"actionType" : "...",
"actionDisplayName" : "...",
"actionName" : "...",
"actionAttributes" : {
"property1" : { },
"property2" : { }
}
}, {
"actionType" : "...",
"actionDisplayName" : "...",
"actionName" : "...",
"actionAttributes" : {
"property1" : { },
"property2" : { }
}
} ],
"ruleScope" : {
"tagStates" : [ "...", "..." ],
"sourcePropertyFilters" : {
"property1" : "...",
"property2" : "..."
},
"virtualFolders" : [ "...", "..." ],
"fieldTags" : [ "...", "..." ],
"resourceTags" : [ "...", "..." ]
},
"name" : "...",
"ruleBody" : "...",
"ruleType" : "...",
"metadataRule" : [ {
"tagDetails" : [ {
"tagName" : "...",
"domainName" : "..."
}, {
"tagName" : "...",
"domainName" : "..."
} ]
}, {
"tagDetails" : [ {
"tagName" : "...",
"domainName" : "..."
}, {
"tagName" : "...",
"domainName" : "..."
} ]
} ],
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ {
"description" : "...",
"value" : { },
"facetAble" : true,
"name" : "...",
"type" : "...",
"displayName" : "..."
}, {
"description" : "...",
"value" : { },
"facetAble" : true,
"name" : "...",
"type" : "...",
"displayName" : "..."
} ]
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"ruleActions" : [ {
"actionType" : "...",
"actionDisplayName" : "...",
"actionName" : "...",
"actionAttributes" : {
"property1" : { },
"property2" : { }
}
}, {
"actionType" : "...",
"actionDisplayName" : "...",
"actionName" : "...",
"actionAttributes" : {
"property1" : { },
"property2" : { }
}
} ],
"ruleScope" : {
"tagStates" : [ "...", "..." ],
"sourcePropertyFilters" : {
"property1" : "...",
"property2" : "..."
},
"virtualFolders" : [ "...", "..." ],
"fieldTags" : [ "...", "..." ],
"resourceTags" : [ "...", "..." ]
},
"name" : "...",
"ruleBody" : "...",
"ruleType" : "...",
"metadataRule" : [ {
"tagDetails" : [ {
"tagName" : "...",
"domainName" : "..."
}, {
"tagName" : "...",
"domainName" : "..."
} ]
}, {
"tagDetails" : [ {
"tagName" : "...",
"domainName" : "..."
}, {
"tagName" : "...",
"domainName" : "..."
} ]
} ],
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ {
"description" : "...",
"value" : { },
"facetAble" : true,
"name" : "...",
"type" : "...",
"displayName" : "..."
}, {
"description" : "...",
"value" : { },
"facetAble" : true,
"name" : "...",
"type" : "...",
"displayName" : "..."
} ]
}
A PUT request to the /rule
endpoint updates a specific rule identified by key retrieved from payload.
media type | data type | description |
---|---|---|
application/json | Rule (JSON) | object used to accept json payload. |
media type | data type | description |
---|---|---|
application/json | Rule (JSON) | The Rule object in JSON format. |
PUT /v2/rule
Content-Type: application/json
Accept: application/json
{
"ruleActions" : [ {
"actionType" : "...",
"actionDisplayName" : "...",
"actionName" : "...",
"actionAttributes" : {
"property1" : { },
"property2" : { }
}
}, {
"actionType" : "...",
"actionDisplayName" : "...",
"actionName" : "...",
"actionAttributes" : {
"property1" : { },
"property2" : { }
}
} ],
"ruleScope" : {
"tagStates" : [ "...", "..." ],
"sourcePropertyFilters" : {
"property1" : "...",
"property2" : "..."
},
"virtualFolders" : [ "...", "..." ],
"fieldTags" : [ "...", "..." ],
"resourceTags" : [ "...", "..." ]
},
"name" : "...",
"ruleBody" : "...",
"ruleType" : "...",
"metadataRule" : [ {
"tagDetails" : [ {
"tagName" : "...",
"domainName" : "..."
}, {
"tagName" : "...",
"domainName" : "..."
} ]
}, {
"tagDetails" : [ {
"tagName" : "...",
"domainName" : "..."
}, {
"tagName" : "...",
"domainName" : "..."
} ]
} ],
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ {
"description" : "...",
"value" : { },
"facetAble" : true,
"name" : "...",
"type" : "...",
"displayName" : "..."
}, {
"description" : "...",
"value" : { },
"facetAble" : true,
"name" : "...",
"type" : "...",
"displayName" : "..."
} ]
}
HTTP/1.1 204 No Content
Content-Type: application/json
{
"ruleActions" : [ {
"actionType" : "...",
"actionDisplayName" : "...",
"actionName" : "...",
"actionAttributes" : {
"property1" : { },
"property2" : { }
}
}, {
"actionType" : "...",
"actionDisplayName" : "...",
"actionName" : "...",
"actionAttributes" : {
"property1" : { },
"property2" : { }
}
} ],
"ruleScope" : {
"tagStates" : [ "...", "..." ],
"sourcePropertyFilters" : {
"property1" : "...",
"property2" : "..."
},
"virtualFolders" : [ "...", "..." ],
"fieldTags" : [ "...", "..." ],
"resourceTags" : [ "...", "..." ]
},
"name" : "...",
"ruleBody" : "...",
"ruleType" : "...",
"metadataRule" : [ {
"tagDetails" : [ {
"tagName" : "...",
"domainName" : "..."
}, {
"tagName" : "...",
"domainName" : "..."
} ]
}, {
"tagDetails" : [ {
"tagName" : "...",
"domainName" : "..."
}, {
"tagName" : "...",
"domainName" : "..."
} ]
} ],
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ {
"description" : "...",
"value" : { },
"facetAble" : true,
"name" : "...",
"type" : "...",
"displayName" : "..."
}, {
"description" : "...",
"value" : { },
"facetAble" : true,
"name" : "...",
"type" : "...",
"displayName" : "..."
} ]
}
A PUT request to the /rule/name
endpoint updates a specific rule identified by name retrieved from payload.
media type | data type | description |
---|---|---|
application/json | Rule (JSON) | object used to accept json payload. |
media type | data type | description |
---|---|---|
application/json | Rule (JSON) | The Rule object in JSON format. |
PUT /v2/rule/name
Content-Type: application/json
Accept: application/json
{
"ruleActions" : [ {
"actionType" : "...",
"actionDisplayName" : "...",
"actionName" : "...",
"actionAttributes" : {
"property1" : { },
"property2" : { }
}
}, {
"actionType" : "...",
"actionDisplayName" : "...",
"actionName" : "...",
"actionAttributes" : {
"property1" : { },
"property2" : { }
}
} ],
"ruleScope" : {
"tagStates" : [ "...", "..." ],
"sourcePropertyFilters" : {
"property1" : "...",
"property2" : "..."
},
"virtualFolders" : [ "...", "..." ],
"fieldTags" : [ "...", "..." ],
"resourceTags" : [ "...", "..." ]
},
"name" : "...",
"ruleBody" : "...",
"ruleType" : "...",
"metadataRule" : [ {
"tagDetails" : [ {
"tagName" : "...",
"domainName" : "..."
}, {
"tagName" : "...",
"domainName" : "..."
} ]
}, {
"tagDetails" : [ {
"tagName" : "...",
"domainName" : "..."
}, {
"tagName" : "...",
"domainName" : "..."
} ]
} ],
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ {
"description" : "...",
"value" : { },
"facetAble" : true,
"name" : "...",
"type" : "...",
"displayName" : "..."
}, {
"description" : "...",
"value" : { },
"facetAble" : true,
"name" : "...",
"type" : "...",
"displayName" : "..."
} ]
}
HTTP/1.1 204 No Content
Content-Type: application/json
{
"ruleActions" : [ {
"actionType" : "...",
"actionDisplayName" : "...",
"actionName" : "...",
"actionAttributes" : {
"property1" : { },
"property2" : { }
}
}, {
"actionType" : "...",
"actionDisplayName" : "...",
"actionName" : "...",
"actionAttributes" : {
"property1" : { },
"property2" : { }
}
} ],
"ruleScope" : {
"tagStates" : [ "...", "..." ],
"sourcePropertyFilters" : {
"property1" : "...",
"property2" : "..."
},
"virtualFolders" : [ "...", "..." ],
"fieldTags" : [ "...", "..." ],
"resourceTags" : [ "...", "..." ]
},
"name" : "...",
"ruleBody" : "...",
"ruleType" : "...",
"metadataRule" : [ {
"tagDetails" : [ {
"tagName" : "...",
"domainName" : "..."
}, {
"tagName" : "...",
"domainName" : "..."
} ]
}, {
"tagDetails" : [ {
"tagName" : "...",
"domainName" : "..."
}, {
"tagName" : "...",
"domainName" : "..."
} ]
} ],
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ {
"description" : "...",
"value" : { },
"facetAble" : true,
"name" : "...",
"type" : "...",
"displayName" : "..."
}, {
"description" : "...",
"value" : { },
"facetAble" : true,
"name" : "...",
"type" : "...",
"displayName" : "..."
} ]
}
A DELETE request to the /rule/{key}
endpoint deletes a specific rule identified by key.
name | type | description |
---|---|---|
key | path | The unique identifier for a rule. |
DELETE /v2/rule/{key}
Content-Type: application/json
...
HTTP/1.1 204 No Content
A GET request to the /rule/{key}
endpoint retrieves details of a specific rule identified by key.
name | type | description |
---|---|---|
key | path | The unique identifier of the Rule object, as returned in the call to getAllRules(). |
media type | data type | description |
---|---|---|
application/json | Rule (JSON) | The Rule object in JSON format. |
GET /v2/rule/{key}
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"ruleActions" : [ {
"actionType" : "...",
"actionDisplayName" : "...",
"actionName" : "...",
"actionAttributes" : {
"property1" : { },
"property2" : { }
}
}, {
"actionType" : "...",
"actionDisplayName" : "...",
"actionName" : "...",
"actionAttributes" : {
"property1" : { },
"property2" : { }
}
} ],
"ruleScope" : {
"tagStates" : [ "...", "..." ],
"sourcePropertyFilters" : {
"property1" : "...",
"property2" : "..."
},
"virtualFolders" : [ "...", "..." ],
"fieldTags" : [ "...", "..." ],
"resourceTags" : [ "...", "..." ]
},
"name" : "...",
"ruleBody" : "...",
"ruleType" : "...",
"metadataRule" : [ {
"tagDetails" : [ {
"tagName" : "...",
"domainName" : "..."
}, {
"tagName" : "...",
"domainName" : "..."
} ]
}, {
"tagDetails" : [ {
"tagName" : "...",
"domainName" : "..."
}, {
"tagName" : "...",
"domainName" : "..."
} ]
} ],
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ {
"description" : "...",
"value" : { },
"facetAble" : true,
"name" : "...",
"type" : "...",
"displayName" : "..."
}, {
"description" : "...",
"value" : { },
"facetAble" : true,
"name" : "...",
"type" : "...",
"displayName" : "..."
} ]
}
A DELETE request to the /rule/name/{name}
endpoint deletes a specific rule identified by key.
name | type | description |
---|---|---|
name | path | The name of the Rule object, as returned in the call to getAllRules() or getRule(). |
DELETE /v2/rule/name/{name}
Content-Type: application/json
...
HTTP/1.1 204 No Content
A GET request to the /rule/name/{name}
endpoint retrieves details of a specific rule.
name | type | description |
---|---|---|
name | path | The name of the Rule object, as returned in the call to getAllRules() or getRule(). |
media type | data type | description |
---|---|---|
application/json | Rule (JSON) | The Rule object in JSON format. |
GET /v2/rule/name/{name}
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"ruleActions" : [ {
"actionType" : "...",
"actionDisplayName" : "...",
"actionName" : "...",
"actionAttributes" : {
"property1" : { },
"property2" : { }
}
}, {
"actionType" : "...",
"actionDisplayName" : "...",
"actionName" : "...",
"actionAttributes" : {
"property1" : { },
"property2" : { }
}
} ],
"ruleScope" : {
"tagStates" : [ "...", "..." ],
"sourcePropertyFilters" : {
"property1" : "...",
"property2" : "..."
},
"virtualFolders" : [ "...", "..." ],
"fieldTags" : [ "...", "..." ],
"resourceTags" : [ "...", "..." ]
},
"name" : "...",
"ruleBody" : "...",
"ruleType" : "...",
"metadataRule" : [ {
"tagDetails" : [ {
"tagName" : "...",
"domainName" : "..."
}, {
"tagName" : "...",
"domainName" : "..."
} ]
}, {
"tagDetails" : [ {
"tagName" : "...",
"domainName" : "..."
}, {
"tagName" : "...",
"domainName" : "..."
} ]
} ],
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ {
"description" : "...",
"value" : { },
"facetAble" : true,
"name" : "...",
"type" : "...",
"displayName" : "..."
}, {
"description" : "...",
"value" : { },
"facetAble" : true,
"name" : "...",
"type" : "...",
"displayName" : "..."
} ]
}