• cacheInstanceId(optional): string
  Title: Cache Instance Id

  The unique identifier for the entry of transaction data stored in the cache. This typically is obtained from first createTransaction or OpenTransaction action and passed along in subsequent Modify/Interact action to avoid reload transaction data from db.
• criteria(optional): object Query Definition
  Title: Query Definition

  Captures the query definition for the current resource request.
• delta(optional): boolean
  Title: Delta

  When the delta parameter is enabled and an action is invoked, only the data and state properties that have changed from the cache image are included in the response. Delta data is only calculated for the requested criteria.

{
    "type":"object",
    "properties":{
        "criteria":{
            "$ref":"#/definitions/queryDef"
        },
        "delta":{
            "$ref":"#/definitions/delta"
        },
        "cacheInstanceId":{
            "$ref":"#/definitions/cacheInstanceId"
        }
    }
}

• actions(optional): array actions
  Array of actions names, whose state is requested in the state object response.
• childDefs(optional): array childDefs
• enableHierarchy(optional): boolean
  Parameter value should be true to execute hierarchy search and sort. Default value is false.
• excludeFieldTypes(optional): array excludeFieldTypes
  Array of field names that you want to exclude in the response.
• expand(optional): array expand
  Array of child resource names that you want to expand so that the contents return with the parent in the same request.
• expandedDomains(optional): array expandedDomains
  Array of field names, whose expanded domains are requested in the state object response.
• expandNodes(optional): boolean
  Boolean value that only be available when enableHierarchy is true. True = all nodes will be expanded; False = All nodes will be collapsed.Default value is true.
• fields(optional): array fields
  Array of field names that you wanted returned in a request.
• groups(optional): array groups
  Array of group names, whose state is requested in the state object response.
• limit(optional): integer
  Positive integer value that specifies the maximum number of items returned by the server.
• nodesExceptionList(optional): array nodesExceptionList
  Array of document_number, recording the nodes that violate current expandNodes flag
• offset(optional): integer
  Non-negative integer values that specifies the index of the first item to be returned. The offset index begins at 0. By default, the offset is 0, which returns all items starting from the first item in the collection.
• orderBy(optional): array orderBy
  Array of field names, each optionally followed by asc or desc, that specifies the order of items returned in the response payload.
• q(optional): string
  Filter (a ??where??clause) to restrict the items returned in the collection. By default, no filtering is applied.
• state(optional): boolean
  Boolean value that specifies whether to calculate the state property. By default, this value is set to false indicating that state is not calculated.
• totalResults(optional): boolean
  Boolean value that specifies whether to calculate the totalResults property. By default, this value is set to false indicating that totalResults is not calculated.

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"boolean",
            "description":"Boolean value that specifies whether to calculate the totalResults property. By default, this value is set to false indicating that totalResults is not calculated."
        },
        "q":{
            "type":"string",
            "description":"Filter (a ??where??clause) to restrict the items returned in the collection. By default, no filtering is applied."
        },
        "limit":{
            "type":"integer",
            "description":"Positive integer value that specifies the maximum number of items returned by the server."
        },
        "offset":{
            "type":"integer",
            "description":"Non-negative integer values that specifies the index of the first item to be returned. The offset index begins at 0. By default, the offset is 0, which returns all items starting from the first item in the collection."
        },
        "state":{
            "type":"boolean",
            "description":"Boolean value that specifies whether to calculate the state property. By default, this value is set to false indicating that state is not calculated."
        },
        "orderBy":{
            "type":"array",
            "description":"Array of field names, each optionally followed by asc or desc, that specifies the order of items returned in the response payload.",
            "items":{
                "type":"string"
            }
        },
        "expand":{
            "type":"array",
            "description":"Array of child resource names that you want to expand so that the contents return with the parent in the same request.",
            "items":{
                "type":"string"
            }
        },
        "fields":{
            "type":"array",
            "description":"Array of field names that you wanted returned in a request.",
            "items":{
                "type":"string"
            }
        },
        "excludeFieldTypes":{
            "type":"array",
            "description":"Array of field names that you want to exclude in the response.",
            "items":{
                "type":"string"
            }
        },
        "actions":{
            "type":"array",
            "description":"Array of actions names, whose state is requested in the state object response.",
            "items":{
                "type":"string"
            }
        },
        "groups":{
            "type":"array",
            "description":"Array of group names, whose state is requested in the state object response.",
            "items":{
                "type":"string"
            }
        },
        "expandedDomains":{
            "type":"array",
            "description":"Array of field names, whose expanded domains are requested in the state object response.",
            "items":{
                "type":"string"
            }
        },
        "childDefs":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/childQueryDef"
            }
        },
        "enableHierarchy":{
            "type":"boolean",
            "description":"Parameter value should be true to execute hierarchy search and sort. Default value is false."
        },
        "expandNodes":{
            "type":"boolean",
            "description":"Boolean value that only be available when enableHierarchy is true. True = all nodes will be expanded; False = All nodes will be collapsed.Default value is true."
        },
        "nodesExceptionList":{
            "type":"array",
            "description":"Array of document_number, recording the nodes that violate current expandNodes flag",
            "items":{
                "type":"string"
            }
        }
    },
    "title":"Query Definition",
    "description":"Captures the query definition for the current resource request."
}

• Array of: string

{
    "type":"array",
    "description":"Array of actions names, whose state is requested in the state object response.",
    "items":{
        "type":"string"
    }
}

• Array of: object Child query criteria.
  Title: Child query criteria.

  Captures the query criteria for the child resource.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/childQueryDef"
    }
}

• Array of: string

{
    "type":"array",
    "description":"Array of field names that you want to exclude in the response.",
    "items":{
        "type":"string"
    }
}

• Array of: string

{
    "type":"array",
    "description":"Array of child resource names that you want to expand so that the contents return with the parent in the same request.",
    "items":{
        "type":"string"
    }
}

• Array of: string

{
    "type":"array",
    "description":"Array of field names, whose expanded domains are requested in the state object response.",
    "items":{
        "type":"string"
    }
}

• Array of: string

{
    "type":"array",
    "description":"Array of field names that you wanted returned in a request.",
    "items":{
        "type":"string"
    }
}

• Array of: string

{
    "type":"array",
    "description":"Array of group names, whose state is requested in the state object response.",
    "items":{
        "type":"string"
    }
}

• Array of: string

{
    "type":"array",
    "description":"Array of document_number, recording the nodes that violate current expandNodes flag",
    "items":{
        "type":"string"
    }
}

• Array of: string

{
    "type":"array",
    "description":"Array of field names, each optionally followed by asc or desc, that specifies the order of items returned in the response payload.",
    "items":{
        "type":"string"
    }
}

• name(optional): string
  Rest alias name of the child resource this query belongs to.
• queryDef(optional): object Query Definition
  Title: Query Definition

  Captures the query definition for the current resource request.
• recursive(optional): boolean
  Boolean value that specifies whether this query is a recursive expand on the current child resource query.

{
    "type":"object",
    "properties":{
        "recursive":{
            "type":"boolean",
            "description":"Boolean value that specifies whether this query is a recursive expand on the current child resource query."
        },
        "name":{
            "type":"string",
            "description":"Rest alias name of the child resource this query belongs to."
        },
        "queryDef":{
            "$ref":"#/definitions/queryDef"
        }
    },
    "title":"Child query criteria.",
    "description":"Captures the query criteria for the child resource."
}