Change Log

  • 19-Jun-2024 | v7.0.0 | All new article

Contributors:

Adam Wilson - Logo Pogo

Site Globals API

Create, Retrieve, Update and Delete Site Global Groups and their Properties via the public API endpoint using "where" filtering.

GET Site Globals Property Groups List

Retrieves a list of Site Globals Groups as a JSON response based on your provided query parameters.

/api/v2/admin/site-globals

Data / Response:

{
    "Where" : {},
    "Order_By" : "Id",
    "Offset" : 0,
    "Limit" : 100,
}

[
  {
    "Id": 0,
    "CreatedDateTime": "2024-05-22T17:06:39.382Z",
    "Properties": [
      {
        "Id": 0,
        "GroupId": 0,
        "CreatedDateTime": "2024-05-22T17:06:39.382Z",
        "LiquidOutput": "string",
        "LiquidShortOutput": "string",
        "HTMLLiquidOutput": "string",
        "HTMLLiquidShortOutput": "string",
        "Name": "string",
        "Alias": "string",
        "ShortAlias": "string",
        "SortOrder": 0,
        "Type": 0,
        "Value": "string",
        "HTMLAlias": "string",
        "ShortHTMLAlias": "string",
        "Layout": "string"
      }
    ],
    "Name": "string",
    "Alias": "string",
    "ShortAlias": "string",
    "EnableOse": true,
    "EnableToolbox": true
  }
]

POST Site Globals Property Group Create

Creates a new Site Globals Group based on the provided data.

/api/v2/admin/site-globals

Data / Response:

{
  "Name": "string",
  "Alias": "string",
  "ShortAlias": "string",
  "EnableOse": true,
  "EnableToolbox": true
}

{
  "Id": 0,
  "CreatedDateTime": "2024-05-22T17:07:49.084Z",
  "Properties": [
    {
      "Id": 0,
      "GroupId": 0,
      "CreatedDateTime": "2024-05-22T17:07:49.084Z",
      "LiquidOutput": "string",
      "LiquidShortOutput": "string",
      "HTMLLiquidOutput": "string",
      "HTMLLiquidShortOutput": "string",
      "Name": "string",
      "Alias": "string",
      "ShortAlias": "string",
      "SortOrder": 0,
      "Type": 0,
      "Value": "string",
      "HTMLAlias": "string",
      "ShortHTMLAlias": "string",
      "Layout": "string"
    }
  ],
  "Name": "string",
  "Alias": "string",
  "ShortAlias": "string",
  "EnableOse": true,
  "EnableToolbox": true
}

GET Site Globals Property Group Item

Retrieves a single Site Globals Group based on the ID passed in the endpoint URL.

/api/v2/admin/site-globals/group/{group_id}

Data / Response:

N/A

{
  "Id": 0,
  "CreatedDateTime": "2024-05-22T17:10:07.466Z",
  "Properties": [
    {
      "Id": 0,
      "GroupId": 0,
      "CreatedDateTime": "2024-05-22T17:10:07.466Z",
      "LiquidOutput": "string",
      "LiquidShortOutput": "string",
      "HTMLLiquidOutput": "string",
      "HTMLLiquidShortOutput": "string",
      "Name": "string",
      "Alias": "string",
      "ShortAlias": "string",
      "SortOrder": 0,
      "Type": 0,
      "Value": "string",
      "HTMLAlias": "string",
      "ShortHTMLAlias": "string",
      "Layout": "string"
    }
  ],
  "Name": "string",
  "Alias": "string",
  "ShortAlias": "string",
  "EnableOse": true,
  "EnableToolbox": true
}

PUT Site Globals Property Group Update

Updates a single Site Globals Group based on the ID passed in the endpoint URL and data provided.

/api/v2/admin/site-globals/{group_id}

Data / Response:

{
  "Name": "string",
  "Alias": "string",
  "ShortAlias": "string",
  "EnableOse": true,
  "EnableToolbox": true
}

{
  "Id": 0,
  "CreatedDateTime": "2024-05-22T17:07:49.084Z",
  "Properties": [
    {
      "Id": 0,
      "GroupId": 0,
      "CreatedDateTime": "2024-05-22T17:07:49.084Z",
      "LiquidOutput": "string",
      "LiquidShortOutput": "string",
      "HTMLLiquidOutput": "string",
      "HTMLLiquidShortOutput": "string",
      "Name": "string",
      "Alias": "string",
      "ShortAlias": "string",
      "SortOrder": 0,
      "Type": 0,
      "Value": "string",
      "HTMLAlias": "string",
      "ShortHTMLAlias": "string",
      "Layout": "string"
    }
  ],
  "Name": "string",
  "Alias": "string",
  "ShortAlias": "string",
  "EnableOse": true,
  "EnableToolbox": true
}

DELETE Site Globals Property Group Delete

Deletes a single Site Globals Group based on the ID passed in the endpoint URL.

/api/v2/admin/site-globals

Data / Response:

[
  "string"
]

Status 204

GET Site Globals Group Properties List

Retrieves a list of Site Globals Group Properties as a JSON response based on your provided query parameters.

/api/v2/admin/site-globals/properties

Data / Response:

{
    "Where" : {},
    "Order_By" : "Id",
    "Offset" : 0,
    "Limit" : 100,
}

[
  {
    "Id": 0,
    "GroupId": 0,
    "CreatedDateTime": "2024-05-22T17:10:19.139Z",
    "LiquidOutput": "string",
    "LiquidShortOutput": "string",
    "HTMLLiquidOutput": "string",
    "HTMLLiquidShortOutput": "string",
    "Name": "string",
    "Alias": "string",
    "ShortAlias": "string",
    "SortOrder": 0,
    "Type": 0,
    "Value": "string",
    "HTMLAlias": "string",
    "ShortHTMLAlias": "string",
    "Layout": "string"
  }
]

POST Site Globals Group Property Create

Creates a new Site Globals Group Property based on the provided data.

/api/v2/admin/site-globals/{group_id}/property

Data / Response:

{
  "Name": "string",
  "Alias": "string",
  "ShortAlias": "string",
  "Type": "string",
  "Value": "string",
  "HTMLAlias": "string",
  "ShortHTMLAlias": "string",
  "Layout": "string"
}

{
  "Id": 0,
  "GroupId": 0,
  "CreatedDateTime": "2024-05-22T17:07:49.091Z",
  "LiquidOutput": "string",
  "LiquidShortOutput": "string",
  "HTMLLiquidOutput": "string",
  "HTMLLiquidShortOutput": "string",
  "Name": "string",
  "Alias": "string",
  "ShortAlias": "string",
  "SortOrder": 0,
  "Type": 0,
  "Value": "string",
  "HTMLAlias": "string",
  "ShortHTMLAlias": "string",
  "Layout": "string"
}

GET Site Globals Group Property Item

Retrieves a single Globals Group Property based on the ID passed in the endpoint URL.

/api/v2/admin/site-globals/property/{property_id}

Data / Response:

N/A

{
  "Id": 0,
  "GroupId": 0,
  "CreatedDateTime": "2024-05-22T17:10:56.693Z",
  "LiquidOutput": "string",
  "LiquidShortOutput": "string",
  "HTMLLiquidOutput": "string",
  "HTMLLiquidShortOutput": "string",
  "Name": "string",
  "Alias": "string",
  "ShortAlias": "string",
  "SortOrder": 0,
  "Type": 0,
  "Value": "string",
  "HTMLAlias": "string",
  "ShortHTMLAlias": "string",
  "Layout": "string"
}

PUT Site Globals Group Property Update

Updates a single Globals Group Property based on the ID passed in the endpoint URL and data provided.

/api/v2/admin/site-globals/property/{property_id}

Data / Response:

{
  "Name": "string",
  "Alias": "string",
  "ShortAlias": "string",
  "Type": "string",
  "Value": "string",
  "HTMLAlias": "string",
  "ShortHTMLAlias": "string",
  "Layout": "string"
}

{
  "Id": 0,
  "GroupId": 0,
  "CreatedDateTime": "2024-05-22T17:10:56.693Z",
  "LiquidOutput": "string",
  "LiquidShortOutput": "string",
  "HTMLLiquidOutput": "string",
  "HTMLLiquidShortOutput": "string",
  "Name": "string",
  "Alias": "string",
  "ShortAlias": "string",
  "SortOrder": 0,
  "Type": 0,
  "Value": "string",
  "HTMLAlias": "string",
  "ShortHTMLAlias": "string",
  "Layout": "string"
}

DELETE Site Globals Group Property Delete

Deletes a single Globals Group Property based on the ID passed in the endpoint URL.

/api/v2/admin/site-globals/properties

Data / Response:

[
  "string"
]

Status 204