Awards
/
Statistics
/
Execute Batch Operations

Awards (Awards & Nominations) (v1-2025-04-18)

Service providing access to Awards (Awards & Nominations) resources and features

Download OpenAPI description
awards-v1.json
awards-v1.yaml
Languages
Servers
Mock server
https://docs.api.rhythmsoftware.com/_mock/apis/awards/awards-v1/
https://awards.api.rhythmsoftware.com/

Application Fees

Application Fees

Operations

Application Processes

Application Processes

Operations

Application Status Reasons

Application Status Reasons

Operations

Applications

Applications

Operations

Awards

Awards

Operations

Categories

Categories

Operations

Coupons

Coupons

Operations

Nomination Processes

Nomination Processes

Operations

Nominations

Nominations

Operations

Nominees

Nominees

Operations

Query Definitions

Query Definitions

Operations

Recipient Categories

Recipient Categories

Operations

Recipients

Recipients

Operations

Reference Processes

Reference Processes

Operations

Reference Types

Reference Types

Operations

References

References

Operations

Review Processes

Review Processes

Operations

Review Rounds

Review Rounds

Operations

Reviews

Reviews

Operations

Settings

Settings

Operations

Statistics

Statistics

Operations

Execute Batch Operations

Request

TAllows you to perform up to 100 parallel patch/delete operations

Path
tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The batch request

operationsArray of objects
curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/awards/awards-v1/statistics/{tenantId}/batch' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "operations": [
      {
        "id": null,
        "object": {},
        "operation": "create",
        "patch_directives": {
          "0": {
            "op": "add",
            "path": "string",
            "value": "string"
          }
        }
      }
    ]
  }'

Responses

Request completed successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
error_countnumber(float)(Error Count)

Number of error results

resultsArray of objects
success_countnumber(float)(Success Count)

Number of successful results

Response
application/json
{
  "error_count": 0.1,
  "results": [
    { … }
  ],
  "success_count": 0.1
}

Returns a statistic from the system by its ID.

Request

This method will look up a statistic by the specified ID and return it back.

Path
tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the statistic to return.

Query
parametersstring

Parameters to the query

recalculateboolean

If true, the latest statistic will be calculated and the cache will be updated

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/awards/awards-v1/statistics/{tenantId}/{id}?parameters=string&recalculate=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The statistic was retrieved successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
dataSourcestring(Datasource)

The datasource used to generate this value

errorstring(Error)

If the cache encountered an error, this is it

idstring(ID)^[\w-:%\/]+$required

The unique, string identifier of this statistic

namestring(Name)required

The name of the statistic

statusstring(Status)required

The description of the statistic

Enum"error""processing""valid"
sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

valuenumber(float)(Value)required

The numeric value of the statistic

value_difference_numericnumber(float)(Value Difference Numeric)

When a value & previous value is present, this is the numeric difference

value_difference_percentagenumber(float)(Value Difference Percentage)

When a value & previous value is present, this is the percentage difference

value_for_previous_periodnumber(float)(Value For Previous Period)

For statistics that can compare values from a previous period, this is the value

valuesArray of objects

If the stat hs values in a row form, this variable contains it

Response
application/json
{
  "dataSource": "string",
  "error": "string",
  "id": "string",
  "name": "string",
  "status": "error",
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_bulk_data_operation_id": "string",
  "sys_last_bulk_data_operation_sys_version": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1,
  "value": 0.1,
  "value_difference_numeric": 0.1,
  "value_difference_percentage": 0.1,
  "value_for_previous_period": 0.1,
  "values": [
    {}
  ]
}

Types

Types

Operations