Jump to

• Request
• Response

View an Allocation Rule

get

/api/restapi/funds/allocationRule/{filterId}

This endpoint returns the allocation rule with an ID that matches the value of the {filterId} path parameter.

Request

Path Parameters

• filterId(required): integer(int64)
  The ID of the allocation rule to be found.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

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.

• filterId

Show Source

• 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.

{
    "title":"ApiEntityNamedFilter",
    "required":[
        "conditions",
        "name",
        "workspaceId"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "name":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the filter.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "conditions":{
            "type":"array",
            "description":"Contains the allocation rule filter condition.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityFilterCondition",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "ownerId":{
            "type":"integer",
            "description":"The system-generated unique identifier of a user who has created the filter.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "filterId":{
            "type":"integer",
            "description":"The unique identifier of the allocation rule.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of the workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a NamedFilter object, a unique NamedFilter object can be identified by the following combinations of the fields.<ul><li>filterId</li>",
    "exampleSetFlag":false
}

Nested Schema : conditions

Type: array

Contains the allocation rule filter condition.

Show Source

• Array of: object ApiEntityFilterCondition
  Title: ApiEntityFilterCondition

{
    "type":"array",
    "description":"Contains the allocation rule filter condition.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityFilterCondition",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityFilterCondition

Type: object

Title: ApiEntityFilterCondition

Show Source

• 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.

{
    "title":"ApiEntityFilterCondition",
    "required":[
        "equality",
        "fieldPath",
        "join",
        "value"
    ],
    "type":"object",
    "properties":{
        "value":{
            "type":"object",
            "description":"Contains the allocation rule filter condition value.",
            "exampleSetFlag":false,
            "types":[
                "object"
            ],
            "jsonSchema":{
                "type":"object",
                "description":"PRIMAVERA_DB_DOCUMENT_KEY:fund_resource_filter_value"
            }
        },
        "conditions":{
            "type":"array",
            "description":"Contains the allocation rule filter condition.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityFilterCondition",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "codeTypeCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"This field displays the name of a code or value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "codeValueCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The unique identifier for the code value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "parentCodeValueCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The unique identifier for the code value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "join":{
            "type":"string",
            "description":"Contains the allocation rule filter join operation.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "AND",
                "OR",
                "NULL"
            ]
        },
        "equality":{
            "type":"string",
            "description":"Contains the allocation rule filter condition equality.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "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"
            ]
        },
        "fieldPath":{
            "type":"string",
            "description":"Contains the allocation rule filter field.<br />The field is non-persistable and thus maximum length is not applicable.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : conditions

Type: array

Contains the allocation rule filter condition.

Show Source

• Array of: object ApiEntityFilterCondition
  Title: ApiEntityFilterCondition

{
    "type":"array",
    "description":"Contains the allocation rule filter condition.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityFilterCondition",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : value

Type: object

Contains the allocation rule filter condition value.

404 Response

The requested object does not exist, or you do not have access to it.

Back to Top