View

All the endpoints that can be called on the View controller.

Endpoints that require the VIEW_READ permission:

• GET index

Endpoints that require the VIEW_CUD permission:

• POST index

• POST item

• DELETE item

Endpoints that require the GROUP_CUD permission:

• GET item

Endpoints that require the SETTINGS_CRUD permission:

• GET viewCategories

index

get

Returns all the existing views.

Authorizations

apiKey

apiKeystringRequired

Query parameters

querystring · min: 1OptionalPattern: ^[0-9a-zA-Z \-\_]+

itemStartnumberOptionalDefault: 0

itemLimitnumber · max: 9999OptionalDefault: 15

Responses

200Success

No content

get

/api/v2/view

HTTPcURLJavaScriptPython

GET /api/v2/view HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Accept: */*

200Success

No content

index

post

Creates a new view.

View the example on how to create conditions and columns.

Authorizations

apiKey

apiKeystringRequired

Body

multipart/form-data

titlestring · min: 4RequiredExample: example titlePattern: ^[0-9a-zA-Z \-\_]+$

primary_sortingstringOptionalDefault: noneExample: nonePattern: ^[a-z_]+$

primary_sorting_orderstring · enumOptionalDefault: ascPossible values:

secondary_sortingstringOptionalDefault: noneExample: nonePattern: ^[a-z_]+$

secondary_sorting_orderstring · enumOptionalDefault: ascPossible values:

view_category_idnumberOptional

view_order_idnumberOptionalExample: 1

Responses

200

index example

application/json

post

/api/v2/view

HTTPcURLJavaScriptPython

POST /api/v2/view HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 343

{
  "title": "example title",
  "primary_sorting": "none",
  "primary_sorting_order": "",
  "secondary_sorting": "none",
  "secondary_sorting_order": "",
  "view_category_id": "",
  "view_order_id": 1,
  "conditions": {
    "all": [
      {
        "fact": "brand_id",
        "operation": "equals",
        "value": "1"
      }
    ],
    "any": [
      {
        "fact": "text",
        "operation": "text",
        "value": "text"
      }
    ]
  },
  "columns": [
    {
      "type": "channel_icon"
    }
  ]
}

200

index example

{
  "message": "View created.",
  "type": "result"
}

item

get

Returns the view by its ID.

Authorizations

apiKey

apiKeystringRequired

Path parameters

idnumberRequired

Responses

200Success

No content

get

/api/v2/view/{id}

HTTPcURLJavaScriptPython

GET /api/v2/view/{id} HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Accept: */*

200Success

No content

item

put

Updates this specific view.

View the example of POST index on how to update the conditions and columns.

Authorizations

apiKey

apiKeystringRequired

Path parameters

idnumberRequired

Body

application/x-www-form-urlencoded

titlestring · min: 4RequiredPattern: ^[0-9a-zA-Z \-\_]+$

primary_sortingstringOptionalDefault: nonePattern: ^[a-z_]+$

primary_sorting_orderstring · enumOptionalDefault: ascPossible values:

secondary_sortingstringOptionalDefault: nonePattern: ^[a-z_]+$

secondary_sorting_orderstring · enumOptionalDefault: ascPossible values:

view_category_idnumberOptional

view_order_idnumberOptional

historyReasonstringOptional

Responses

200Success

No content

put

/api/v2/view/{id}

HTTPcURLJavaScriptPython

PUT /api/v2/view/{id} HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 359

"title='text'&primary_sorting='none'&primary_sorting_order='asc'&secondary_sorting='none'&secondary_sorting_order='asc'&view_category_id=1&view_order_id=1&historyReason='text'&conditions={'all':[{'fact':'text','operation':'text','value':'text'}],'any':[{'fact':'text','operation':'text','value':'text'}]}&columns=[{'type':'channel_icon'}]"

200Success

No content

item

delete

Permanently deletes this view by its ID.

Authorizations

apiKey

apiKeystringRequired

Path parameters

idnumberRequired

Responses

200Success

No content

delete

/api/v2/view/{id}

HTTPcURLJavaScriptPython

DELETE /api/v2/view/{id} HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Accept: */*

200Success

No content