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. Resources
  • 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
      • Update Resource Type Schema
    • Resources
      • Introduction
      • Delete Resource
        GET
      • List Resources
        GET
      • Show Resource
        GET
      • Accept Resource
        PUT
      • Reject Resource
        PUT
      • Create a Resource Reminder
        POST
    • 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. Resources

Introduction

Resource model#

A resource is an entity that has a file attached to it. It comprises of a name, details (listed above) and a custom attribute list that matches its resource type attributes.
As an admin, one can list, accept and reject resources submitted by users.

Example#

{
    "id": 15,
    "resource_type": "Some resource type",
    "store_id": 3,
    "member_id": 33,
    "user_id": "some-user-uuid",
    "name": "a very important document",
    "marketing_usable": true,
    "file_url": "https://some.file/url",
    "state": "accepted",
    "properties": {
      "campaign_name": ["November", "October"],
      "used_so_far": false,
      "author_count": 3
    },
    "campaign_type": "some campaign type",
    "notes": "some notes about the resource",
    "created_at": "2020-12-30T17:12:46.435Z",
    "updated_at": "2020-12-30T17:12:50.235Z",
}

Definition#

KeyTypeOptionalDescription
idintegerno
resource_typestringnoname of the ResourceType the resource is assigned to
store_idintegerno.id of the Store the resource is assigned to
member_idintegerno.member_id of the User the resource has been created by
user_idstringnouuid of the User the resource has been created by
namestringnoname of the resource
marketing_usablebooleannowhether the resource will be allowed to be used for marketing purposes
file_urlstringnoURL of the file where the resource is located at
statestringnocurrent state of the resource (could be pending (the default one), accepted or rejected)
propertiesobjectyescustom attributes of the resource
campaign_typestringyescampaign type of the resource
notesstringyesnotes about the resource - used to provide a reason for its acceptance/rejection/resubmission
created_atdatetimenotime of creation
updated_atdatetimenotime of last update
Previous
Update Resource Type Schema
Next
Delete Resource
Built with