Update an Allocation Rule
put
/api/restapi/funds/allocationRule
Send a request to this endpoint to update an allocation rule. An application object with an ID value that matches the ID value provided in the JSON object in the request body will be updated to reflect the JSON contents.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : ApiEntityNamedFilter
Type:
object
Title:
ApiEntityNamedFilter
This entity represents a NamedFilter object, a unique NamedFilter object can be identified by the following combinations of the fields.
Show Source
- filterId
-
conditions(required): array
conditions
Contains the allocation rule filter condition.
-
filterId: integer
(int64)
The unique identifier of the allocation rule.
-
link: string
(url)
Read Only:
true
The self-link to the object. This field is populated only in the responses generated by the batch create APIs. -
name(required): string
Minimum Length:
1
Maximum Length:255
The name of the filter. -
ownerId: integer
(int64)
The system-generated unique identifier of a user who has created the filter.
-
updateDate: string
(date-time)
Read Only:
true
Date when the record was last updated. -
workspaceCode: string
Minimum Length:
0
Maximum Length:60
The user-specified identifier of a workspace. -
workspaceId(required): integer
(int64)
The unique identifier of the workspace.
Nested Schema : conditions
Type:
array
Contains the allocation rule filter condition.
Show Source
-
Array of:
object ApiEntityFilterCondition
Title:
ApiEntityFilterCondition
Nested Schema : ApiEntityFilterCondition
Type:
object
Title:
Show Source
ApiEntityFilterCondition
-
codeTypeCode: string
Minimum Length:
1
Maximum Length:60
This field displays the name of a code or value. -
codeValueCode: string
Minimum Length:
1
Maximum Length:60
The unique identifier for the code value. -
conditions: array
conditions
Contains the allocation rule filter condition.
-
equality(required): string
Allowed Values:
[ "EQUALS", "NOT_EQUALS", "EQUALS_IGNORE_CASE", "GREATER_THAN", "GREATER_THAN_EQUALS", "LESS_THAN", "LESS_THAN_EQUALS", "IN", "NOT_IN", "STARTS_WITH", "ENDS_WITH", "LIKE", "NOT_LIKE", "BETWEEN", "NOT_BETWEEN", "IS_NULL", "NOT_NULL", "IS_EMPTY", "IS_UNDER" ]
Contains the allocation rule filter condition equality. -
fieldPath(required): string
Contains the allocation rule filter field.
The field is non-persistable and thus maximum length is not applicable. -
join(required): string
Allowed Values:
[ "AND", "OR", "NULL" ]
Contains the allocation rule filter join operation. -
parentCodeValueCode: string
Minimum Length:
1
Maximum Length:60
The unique identifier for the code value. -
value(required): object
value
Contains the allocation rule filter condition value.
Nested Schema : conditions
Type:
array
Contains the allocation rule filter condition.
Show Source
-
Array of:
object ApiEntityFilterCondition
Title:
ApiEntityFilterCondition
Nested Schema : value
Type:
object
Contains the allocation rule filter condition value.
Response
200 Response
A collection of object IDs mapped to a canonical link of the object. For example - {"links":{"1":"https://[host]:[port]/api/restapi/[object]/1","2":"https://[host]:[port]/api/restapi/[object]/2"}}
400 Response
Invalid Input.