Statement JSON schema reference

Introduction

Access control statements for Uptempo Campaign Management activities are defined using a JSON (JavaScript Object Notation) schema.

In addition to the visual Statement Editor, you can create and modify access control statements directly in the Raw JSON editor. The Raw JSON editor provides greater flexibility and control for users who are comfortable using JSON syntax.

This reference guide describes the JSON schema used for activity access controls. It explains the required structure, supported fields, and accepted data types and values needed to create valid access control statements in Uptempo Campaign Management.

Basic syntax rules

When writing an activity access control statement in JSON, use standard JSON syntax:

• Begin and end statements and objects with curly braces: {...}.

• Begin and end arrays (such as conditions) with square brackets: [...].

• For key-value pairs, use the format: "key": "value".

  • Separate the key and value with colon: :.

  • Keys must be strings in double quotes: "key".

  • If the value is a string, it must be in double quotes: "value".

• Separate individual key-value pairs and items in arrays with a comma: ,. Do not place a trailing comma after the last item.

• JSON is data-only: do not include comments in statements.

Statement structure

Access control statements use the following general structure:

Example

The following example statement allows viewing of all activities within three specified activity types:

{ "effect": "ALLOW", "action": "View", "resourceType": "ACTIVITY", "resourceLocator": "*", "conditions": [ { "field": { "name": "ACTIVITY_TYPE" }, "operator": "IS_ONE_OF", "value": ["21", "74", "41"] } ] }

Resource IDs

Many access control statements are scoped to specific Uptempo Campaign Management resources, such as activities or attributes. To reference a specific resource in your statements, you use its ID. These IDs are system-generated identifiers that uniquely identify each resource. Statements use the following types of ID:

Activity ID (activityId)

Identifies a specific activity.

Activity Type ID (activityTypeId)

Identifies a specific activity type.

Activity Type Group ID (activityTypeGroupId)

Identifies a specific activity type group.

Attribute Definition ID (attributeDefinitionId)

Identifies a specific attribute.

Attribute Option ID (attributeOptionId)

Identifies a specific list option for a Drop-Down List or Multi-Select List attribute.

To learn how to find resource IDs in Uptempo Campaign Management, see Find resource IDs in Uptempo.

Primary properties

The primary properties in an access control statement are:

conditions[] object properties

Each object in the conditions array describes a separate condition that must be met for the statement to apply, and consists of the following properties:

Find resource IDs in Uptempo

To identify specific resources such as activities and attributes in the conditions object, you must reference them by their resource ID. These IDs in the Uptempo Campaign Management UI.