Placewise API
Get startedExplore
Get startedExplore
Performance Cloud 🗗
Placewise 🗗
ExplorePublic APIManagement APIUsers APIOperations API
Messaging APIReporting APIML APIData API
ExplorePublic APIManagement APIUsers APIOperations API
Messaging APIReporting APIML APIData API
  1. Resource Types
  • Introduction
  • Manager API
    • Introduction
    • Settings
      • Introduction
      • Show Operations Settings
      • Update Settings
    • ABM Links
      • List ABM Links
      • Show Unassigned ABM Links Count
      • Import ABM Links
    • Members
      • Show Contact
      • Delete Contact
      • Update Contact
    • Issues
      • Introduction
      • Reopen Issue
      • List Issue Types
      • List Issues
      • Show Issue
      • Accept Issue
      • Resolve Issue
    • Articles
      • Introduction
      • List Articles
      • Show Article
      • Create Article
      • Update Article
      • Destroy Article
    • Articles Categories
      • Introduction
      • List Categories
      • Show Category
      • Create Category
      • Update Category
      • Destroy Category
      • List Categories with Articles
    • Documents
      • Introduction
      • List Documents
      • Show Document
      • List Document Recipients
      • Create Document
      • Update Document
      • Add Recipients to the Document
      • Destroy Document
    • Resource Types
      • Introduction
      • Show Resource Type Schema
        GET
      • Update Resource Type Schema
        PUT
    • Resources
      • Introduction
      • Delete Resource
      • List Resources
      • Show Resource
      • Accept Resource
      • Reject Resource
      • Create a Resource Reminder
    • Revenue Reporting
      • Introduction
      • List Store Tax Categories
      • Bulk Update Store Tax Categories
      • List Aggregated Reports
      • List Aggregated Reports As Csv
      • Show Policy
      • Update Policy
      • List Tax Categories
      • Bulk Update Tax Categories
      • Download revenue reports import template
      • Import revenue reports from file
    • Alerts
      • Introduction
      • Recall Alert
      • Deactivate Alert
      • List Alerts
      • Show Alert
      • List Alert Recipients
      • Create Alert
      • Accept Alert
      • Reject Alert
    • Alert Templates
      • Introduction
      • List Alert Templates
      • Show Alert Template
      • Create Alert Template
      • Update Alert Template
      • Destroy Alert Template
    • Footfall Reporting
      • List Footfall Reports
      • Bulk Update Reports
  • Tenant API
    • Introduction
    • Documents
      • Introduction
      • List Documents
      • Show Document
      • Confirm Document
    • Resource Types
      • Show Resource Type Schema
    • Resources
      • Introduction
      • List Resources
      • List Deleted Resources
      • Show Resource
      • Create Resource
      • Update Resource
      • Destroy Resource
      • Resubmit Resource
      • Restore Resource
    • Alerts
      • Introduction
      • List Alert Types
      • List Alerts
      • Show Alert
      • Create Alert
      • Report to Alert
    • Alert Templates
      • List Alert Templates
    • Push App Tokens
      • Introduction
      • Add App Tokens
    • Revenue Reporting
      • List Reporting Periods
      • List Reporting Period Reports
      • Bulk Update Reports
      • List Tax Categories
      • List Store Tax Categories
      • Bulk Update
    • ABM Links
      • Assign ABM Link
      • Send ABM Link
    • Issues
      • Introduction
      • List Issues
      • Show Issue
      • Create Issue
      • Update Issues
      • Destroy Issue
    • Articles
      • Introduction
      • List Articles
      • Show Article
      • List Categories with Articles
  1. Resource Types

Introduction

Resource type schema#

Example#

{
"$id": "/v1/users/me/operations/resource_types/schema",
"$schema": "http://json-schema.org/draft-07/schema#",
"description": "Description of available ResourceTypes (with their properties)",
"type": "object",
"properties": {
    "ResourceType 2": {
        "description": "image/jpeg",
        "type": "object",
        "kind": "regular",
        "properties": {
            "ResourceTypeAttribute 3": {
                "type": "string",
                "enum": ["radio input value 1", "radio input value 2"]
            },
            "ResourceTypeAttribute 4": {
                "type": "array",
                "items": {
                    "type": "string",
                    "enum": ["select input value 1", "select input value 2"]
                }
            }
        },
        "required": [
    "ResourceTypeAttribute 3"
  ]
    },
    "ResourceType 1": {
        "description": "image/jpeg",
        "type": "object",
        "kind": "regular",
        "properties": {
            "ResourceTypeAttribute 1": {
                "type": "string"
            },
            "ResourceTypeAttribute 2": {
                "type": "array",
                "items": {
                    "type": "string"
                }
            },
            "Campaign start date": {
                "type": "datetime"
            },
            "Campaign end date": {
                "type": "datetime",
                "validates_gt_against": "Campaign start date"
            }
        },
        "required": [
    "ResourceTypeAttribute 2"
  ]
    },
    "Coupon": {
        "description": "image/png;image/jpeg;image/gif",
        "type": "object",
        "kind": "offer",
        "properties": {
            "Collection": {
                "type": "offer_collection_id"
            },
            "Start date": {
                "type": "datetime"
            },
            "Expiration date": {
                "type": "datetime",
                "validates_gt_against": "Start date"
            },
            "Offer": {
                "type": "string"
            },
            "Description of offer": {
                "type": "text"
            },
            "Channel": {
                "type": "array",
                "items": {
                    "type": "string",
                    "enum": [
                        "Instagram",
                        "Facebook",
                        "Website",
                        "E-mail message",
                        "App Coupon",
                        "SMS message"
                    ]
                }
            }
        },
        "required": [
            "Collection"
        ]
    }
  }
}

Definition#

KeyTypeOptionalDescription
$idstringyespath of this schema (auto-generated)
$schemastringyesdraft which this schema is compatible with (auto-generated)
descriptionstringyesdescription of this schema (auto-generated)
typestringyestype of this schema (auto-generated)
kindenum: ['regular', 'offer']yesresource type kind
propertiesobjectnodescription of how the resource type properties look like for each of the resource types and their attributes (and whether they are required)
properties.{{resource_type}}.properties.{{property_name}}.typestringnotype of property - see here

Resource type schema properties types#

Properties may have following type:
TypeBasic type
stringstring
booleanboolean
datetimedatetime
textstring
custom_named_stringstring
offer_collection_idinteger
Previous
Destroy Document
Next
Show Resource Type Schema
Built with