Post Dash - SuperOffice

Post Dash

using RestSharp;


var options = new RestClientOptions("http://localhost:53294/api/v1/Dash");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n  \"DashboardId\": 123,\n  \"UniqueId\": \"<string>\",\n  \"Name\": \"<string>\",\n  \"Description\": \"<string>\",\n  \"AssociateId\": 123,\n  \"Columns\": 123,\n  \"Theme\": {\n    \"DashboardThemeId\": 123,\n    \"Name\": \"<string>\",\n    \"Config\": \"<string>\",\n    \"Rank\": 123,\n    \"Client\": \"<string>\",\n    \"Style\": \"<string>\",\n    \"TableRight\": {\n      \"Mask\": \"<string>\",\n      \"Reason\": \"<string>\"\n    },\n    \"FieldProperties\": {}\n  },\n  \"VisibleForAll\": 123,\n  \"VisibleForAssociates\": [\n    123\n  ],\n  \"VisibleForGroups\": [\n    123\n  ],\n  \"PinForAll\": 123,\n  \"PinForAssociates\": [\n    123\n  ],\n  \"PinForGroups\": [\n    123\n  ],\n  \"TableRight\": {\n    \"Mask\": \"<string>\",\n    \"Reason\": \"<string>\"\n  },\n  \"FieldProperties\": {}\n}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    DashboardId: 123,
    UniqueId: '<string>',
    Name: '<string>',
    Description: '<string>',
    AssociateId: 123,
    Columns: 123,
    Theme: {
      DashboardThemeId: 123,
      Name: '<string>',
      Config: '<string>',
      Rank: 123,
      Client: '<string>',
      Style: '<string>',
      TableRight: {Mask: '<string>', Reason: '<string>'},
      FieldProperties: {}
    },
    VisibleForAll: 123,
    VisibleForAssociates: [123],
    VisibleForGroups: [123],
    PinForAll: 123,
    PinForAssociates: [123],
    PinForGroups: [123],
    TableRight: {Mask: '<string>', Reason: '<string>'},
    FieldProperties: {}
  })
};

fetch('http://localhost:53294/api/v1/Dash', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "53294",
  CURLOPT_URL => "http://localhost:53294/api/v1/Dash",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'DashboardId' => 123,
    'UniqueId' => '<string>',
    'Name' => '<string>',
    'Description' => '<string>',
    'AssociateId' => 123,
    'Columns' => 123,
    'Theme' => [
        'DashboardThemeId' => 123,
        'Name' => '<string>',
        'Config' => '<string>',
        'Rank' => 123,
        'Client' => '<string>',
        'Style' => '<string>',
        'TableRight' => [
                'Mask' => '<string>',
                'Reason' => '<string>'
        ],
        'FieldProperties' => [
                
        ]
    ],
    'VisibleForAll' => 123,
    'VisibleForAssociates' => [
        123
    ],
    'VisibleForGroups' => [
        123
    ],
    'PinForAll' => 123,
    'PinForAssociates' => [
        123
    ],
    'PinForGroups' => [
        123
    ],
    'TableRight' => [
        'Mask' => '<string>',
        'Reason' => '<string>'
    ],
    'FieldProperties' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

import requests

url = "http://localhost:53294/api/v1/Dash"

payload = {
    "DashboardId": 123,
    "UniqueId": "<string>",
    "Name": "<string>",
    "Description": "<string>",
    "AssociateId": 123,
    "Columns": 123,
    "Theme": {
        "DashboardThemeId": 123,
        "Name": "<string>",
        "Config": "<string>",
        "Rank": 123,
        "Client": "<string>",
        "Style": "<string>",
        "TableRight": {
            "Mask": "<string>",
            "Reason": "<string>"
        },
        "FieldProperties": {}
    },
    "VisibleForAll": 123,
    "VisibleForAssociates": [123],
    "VisibleForGroups": [123],
    "PinForAll": 123,
    "PinForAssociates": [123],
    "PinForGroups": [123],
    "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
    },
    "FieldProperties": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    DashboardId: 123,
    UniqueId: '<string>',
    Name: '<string>',
    Description: '<string>',
    AssociateId: 123,
    Columns: 123,
    Theme: {
      DashboardThemeId: 123,
      Name: '<string>',
      Config: '<string>',
      Rank: 123,
      Client: '<string>',
      Style: '<string>',
      TableRight: {Mask: '<string>', Reason: '<string>'},
      FieldProperties: {}
    },
    VisibleForAll: 123,
    VisibleForAssociates: [123],
    VisibleForGroups: [123],
    PinForAll: 123,
    PinForAssociates: [123],
    PinForGroups: [123],
    TableRight: {Mask: '<string>', Reason: '<string>'},
    FieldProperties: {}
  })
};

fetch('http://localhost:53294/api/v1/Dash', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "DashboardId": 123,
  "UniqueId": "<string>",
  "Name": "<string>",
  "Description": "<string>",
  "AssociateId": 123,
  "Columns": 123,
  "Theme": {
    "DashboardThemeId": 123,
    "Name": "<string>",
    "Config": "<string>",
    "Rank": 123,
    "Client": "<string>",
    "Style": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "VisibleForAll": 123,
  "VisibleForAssociates": [
    123
  ],
  "VisibleForGroups": [
    123
  ],
  "PinForAll": 123,
  "PinForAssociates": [
    123
  ],
  "PinForGroups": [
    123
  ],
  "TableRight": {
    "Mask": "<string>",
    "Reason": "<string>"
  },
  "FieldProperties": {},
  "_Links": {}
}

Post Dash

using RestSharp;


var options = new RestClientOptions("http://localhost:53294/api/v1/Dash");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n  \"DashboardId\": 123,\n  \"UniqueId\": \"<string>\",\n  \"Name\": \"<string>\",\n  \"Description\": \"<string>\",\n  \"AssociateId\": 123,\n  \"Columns\": 123,\n  \"Theme\": {\n    \"DashboardThemeId\": 123,\n    \"Name\": \"<string>\",\n    \"Config\": \"<string>\",\n    \"Rank\": 123,\n    \"Client\": \"<string>\",\n    \"Style\": \"<string>\",\n    \"TableRight\": {\n      \"Mask\": \"<string>\",\n      \"Reason\": \"<string>\"\n    },\n    \"FieldProperties\": {}\n  },\n  \"VisibleForAll\": 123,\n  \"VisibleForAssociates\": [\n    123\n  ],\n  \"VisibleForGroups\": [\n    123\n  ],\n  \"PinForAll\": 123,\n  \"PinForAssociates\": [\n    123\n  ],\n  \"PinForGroups\": [\n    123\n  ],\n  \"TableRight\": {\n    \"Mask\": \"<string>\",\n    \"Reason\": \"<string>\"\n  },\n  \"FieldProperties\": {}\n}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    DashboardId: 123,
    UniqueId: '<string>',
    Name: '<string>',
    Description: '<string>',
    AssociateId: 123,
    Columns: 123,
    Theme: {
      DashboardThemeId: 123,
      Name: '<string>',
      Config: '<string>',
      Rank: 123,
      Client: '<string>',
      Style: '<string>',
      TableRight: {Mask: '<string>', Reason: '<string>'},
      FieldProperties: {}
    },
    VisibleForAll: 123,
    VisibleForAssociates: [123],
    VisibleForGroups: [123],
    PinForAll: 123,
    PinForAssociates: [123],
    PinForGroups: [123],
    TableRight: {Mask: '<string>', Reason: '<string>'},
    FieldProperties: {}
  })
};

fetch('http://localhost:53294/api/v1/Dash', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "53294",
  CURLOPT_URL => "http://localhost:53294/api/v1/Dash",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'DashboardId' => 123,
    'UniqueId' => '<string>',
    'Name' => '<string>',
    'Description' => '<string>',
    'AssociateId' => 123,
    'Columns' => 123,
    'Theme' => [
        'DashboardThemeId' => 123,
        'Name' => '<string>',
        'Config' => '<string>',
        'Rank' => 123,
        'Client' => '<string>',
        'Style' => '<string>',
        'TableRight' => [
                'Mask' => '<string>',
                'Reason' => '<string>'
        ],
        'FieldProperties' => [
                
        ]
    ],
    'VisibleForAll' => 123,
    'VisibleForAssociates' => [
        123
    ],
    'VisibleForGroups' => [
        123
    ],
    'PinForAll' => 123,
    'PinForAssociates' => [
        123
    ],
    'PinForGroups' => [
        123
    ],
    'TableRight' => [
        'Mask' => '<string>',
        'Reason' => '<string>'
    ],
    'FieldProperties' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

import requests

url = "http://localhost:53294/api/v1/Dash"

payload = {
    "DashboardId": 123,
    "UniqueId": "<string>",
    "Name": "<string>",
    "Description": "<string>",
    "AssociateId": 123,
    "Columns": 123,
    "Theme": {
        "DashboardThemeId": 123,
        "Name": "<string>",
        "Config": "<string>",
        "Rank": 123,
        "Client": "<string>",
        "Style": "<string>",
        "TableRight": {
            "Mask": "<string>",
            "Reason": "<string>"
        },
        "FieldProperties": {}
    },
    "VisibleForAll": 123,
    "VisibleForAssociates": [123],
    "VisibleForGroups": [123],
    "PinForAll": 123,
    "PinForAssociates": [123],
    "PinForGroups": [123],
    "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
    },
    "FieldProperties": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    DashboardId: 123,
    UniqueId: '<string>',
    Name: '<string>',
    Description: '<string>',
    AssociateId: 123,
    Columns: 123,
    Theme: {
      DashboardThemeId: 123,
      Name: '<string>',
      Config: '<string>',
      Rank: 123,
      Client: '<string>',
      Style: '<string>',
      TableRight: {Mask: '<string>', Reason: '<string>'},
      FieldProperties: {}
    },
    VisibleForAll: 123,
    VisibleForAssociates: [123],
    VisibleForGroups: [123],
    PinForAll: 123,
    PinForAssociates: [123],
    PinForGroups: [123],
    TableRight: {Mask: '<string>', Reason: '<string>'},
    FieldProperties: {}
  })
};

fetch('http://localhost:53294/api/v1/Dash', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "DashboardId": 123,
  "UniqueId": "<string>",
  "Name": "<string>",
  "Description": "<string>",
  "AssociateId": 123,
  "Columns": 123,
  "Theme": {
    "DashboardThemeId": 123,
    "Name": "<string>",
    "Config": "<string>",
    "Rank": 123,
    "Client": "<string>",
    "Style": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "VisibleForAll": 123,
  "VisibleForAssociates": [
    123
  ],
  "VisibleForGroups": [
    123
  ],
  "PinForAll": 123,
  "PinForAssociates": [
    123
  ],
  "PinForGroups": [
    123
  ],
  "TableRight": {
    "Mask": "<string>",
    "Reason": "<string>"
  },
  "FieldProperties": {},
  "_Links": {}
}

Authorizations

Authorization

string

header

required

SuperOffice username:password are passed in Base64-encoded.

You can also pass inn an unencoded ticket 7T:abc== with the HTTP Authenticate header.

Authorization

string

header

required

SuperOffice SuperId OAuth implicit flow. You need to issue a request to the SuperId authorization URL https://online.superoffice.com/login/common/oauth/authorize?response_type=token &client_id=670734e0-4c5a-11e3-be9e-a171392e81db &redirect_uri=https://example.com/spa/

passing in the application id and redirect URL.

SuperId will log the user in, and redirect to the requested redirect URL with a #payload containing the access token and claims. (The redirect URL must be registered with SuperId in advance)

https://example.com/spa#access_token=8A%3aCust12227.AXRrCITpPBvQX3UbIohb &token_type=bearer &state= &expires_in=3600 &ctx=Cust12227 &netserver_url=https%3a%2f%2fsod.superoffice.com%2fCust12227%2fRemote%2fServices82%2f

You can take the #access_token value and pass it as the Authenticate HTTP header as a BEARER token.

FlowImplicit

Authorization URL: https://online.superoffice.com/login/common/oauth/authorize

Headers

Accept-Language

string

Convert string references and multi-language values into a specified language (iso2) code.

SO-Language

string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

SO-Culture

string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

SO-TimeZone

string

Specify the timezone code that you would like date/time responses converted to.

SO-AppToken

string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Query Parameters

$select

string

Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category" Default = show all fields.

Body

The Dash to be saved.

Dashboard configuration Carrier object for Dash. Services for the Dash Carrier is available from the Dash Agent.

DashboardId

integer<int32>

Primary key

UniqueId

string

GUID identifying a default dashboard from SuperOffice

Name

string

The name of this dashboard

Description

string

Detailed description

AssociateId

integer<int32>

Associate who owns this dashboard

Columns

integer<int32>

How many columns there will be in the dashboard.

Theme

object

Dashboard theme configuration Carrier object for DashTheme. Services for the DashTheme Carrier is available from the Dash Agent.

Show child attributes

VisibleForAll

integer<int32>

True if visible for all

VisibleForAssociates

integer<int32>[]

Array of references to the visible for associates

VisibleForGroups

integer<int32>[]

Array of references to the visible for groups

PinForAll

integer<int32>

True if pinned for all

PinForAssociates

integer<int32>[]

Array of references to the pinned associates

PinForGroups

integer<int32>[]

Array of references to the pinned groups

TableRight

object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

Show child attributes

FieldProperties

object

Field property dictionary mapping field names to field access rights.

Show child attributes

Response

Dashboard configuration Dash entity with API _Links added.

DashboardId

integer<int32>

Primary key

UniqueId

string

GUID identifying a default dashboard from SuperOffice

Name

string

The name of this dashboard

Description

string

Detailed description

AssociateId

integer<int32>

Associate who owns this dashboard

Columns

integer<int32>

How many columns there will be in the dashboard.

Theme

object

Dashboard theme configuration Carrier object for DashTheme. Services for the DashTheme Carrier is available from the Dash Agent.

Show child attributes

VisibleForAll

integer<int32>

True if visible for all

VisibleForAssociates

integer<int32>[]

Array of references to the visible for associates

VisibleForGroups

integer<int32>[]

Array of references to the visible for groups

PinForAll

integer<int32>

True if pinned for all

PinForAssociates

integer<int32>[]

Array of references to the pinned associates

PinForGroups

integer<int32>[]

Array of references to the pinned groups

TableRight

object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

Show child attributes

FieldProperties

object

Field property dictionary mapping field names to field access rights.

Show child attributes

_Links

object

Show child attributes