Execute User Command
using RestSharp;
var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/User/ExecuteUserCommand");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n \"CommandName\": \"<string>\",\n \"User\": {\n \"AssociateId\": 123,\n \"Name\": \"<string>\",\n \"Rank\": 123,\n \"Tooltip\": \"<string>\",\n \"LicenseOwners\": [\n {\n \"Name\": \"<string>\",\n \"Description\": \"<string>\",\n \"RestrictedModuleLicenses\": [\n {\n \"Unrestricted\": true,\n \"Total\": 123,\n \"Tooltip\": \"<string>\",\n \"CanAssign\": true,\n \"Free\": 123,\n \"InUse\": 123,\n \"IsHidden\": true,\n \"Assigned\": true,\n \"ModuleLicenseId\": 123,\n \"Name\": \"<string>\",\n \"Description\": \"<string>\",\n \"PrerequisiteModuleName\": \"<string>\",\n \"SortOrder\": 123,\n \"ExtraFlags\": 123,\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n }\n ],\n \"UnrestrictedModuleLicenses\": [\n {\n \"Unrestricted\": true,\n \"Total\": 123,\n \"Tooltip\": \"<string>\",\n \"CanAssign\": true,\n \"Free\": 123,\n \"InUse\": 123,\n \"IsHidden\": true,\n \"Assigned\": true,\n \"ModuleLicenseId\": 123,\n \"Name\": \"<string>\",\n \"Description\": \"<string>\",\n \"PrerequisiteModuleName\": \"<string>\",\n \"SortOrder\": 123,\n \"ExtraFlags\": 123,\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n }\n ],\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n }\n ],\n \"Role\": {\n \"Id\": 123,\n \"Value\": \"<string>\",\n \"Tooltip\": \"<string>\",\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n },\n \"UserGroup\": {\n \"Value\": \"<string>\",\n \"Tooltip\": \"<string>\",\n \"Id\": 123,\n \"Rank\": 123,\n \"Deleted\": true,\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n },\n \"OtherGroups\": [\n {\n \"Value\": \"<string>\",\n \"Tooltip\": \"<string>\",\n \"Id\": 123,\n \"Rank\": 123,\n \"Deleted\": true,\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n }\n ],\n \"Person\": {\n \"Position\": \"<string>\",\n \"PersonId\": 123,\n \"Mrmrs\": \"<string>\",\n \"Firstname\": \"<string>\",\n \"Lastname\": \"<string>\",\n \"MiddleName\": \"<string>\",\n \"Title\": \"<string>\",\n \"Description\": \"<string>\",\n \"Email\": \"<string>\",\n \"FullName\": \"<string>\",\n \"DirectPhone\": \"<string>\",\n \"FormalName\": \"<string>\",\n \"CountryId\": 123,\n \"ContactId\": 123,\n \"ContactName\": \"<string>\",\n \"Retired\": 123,\n \"Rank\": 123,\n \"ActiveInterests\": 123,\n \"ContactDepartment\": \"<string>\",\n \"ContactCountryId\": 123,\n \"ContactOrgNr\": \"<string>\",\n \"FaxPhone\": \"<string>\",\n \"MobilePhone\": \"<string>\",\n \"ContactPhone\": \"<string>\",\n \"AssociateName\": \"<string>\",\n \"AssociateId\": 123,\n \"UsePersonAddress\": true,\n \"ContactFax\": \"<string>\",\n \"Kanafname\": \"<string>\",\n \"Kanalname\": \"<string>\",\n \"Post1\": \"<string>\",\n \"Post2\": \"<string>\",\n \"Post3\": \"<string>\",\n \"EmailName\": \"<string>\",\n \"ContactFullName\": \"<string>\",\n \"ActiveErpLinks\": 123,\n \"TicketPriorityId\": 123,\n \"SupportLanguageId\": 123,\n \"SupportAssociateId\": 123,\n \"CategoryName\": \"<string>\",\n \"PersonNumber\": \"<string>\",\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n },\n \"Deleted\": true,\n \"Lastlogin\": \"2023-11-07T05:31:56Z\",\n \"Lastlogout\": \"2023-11-07T05:31:56Z\",\n \"EjUserId\": 123,\n \"RequestSignature\": \"<string>\",\n \"IsPersonRetired\": true,\n \"IsOnTravel\": true,\n \"Credentials\": [\n {\n \"Type\": {\n \"DisplayType\": \"<string>\",\n \"Type\": \"<string>\",\n \"Description\": \"<string>\",\n \"CanCreatePerson\": true,\n \"IsUserNameSupported\": true,\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n },\n \"Value\": \"<string>\",\n \"DisplayValue\": \"<string>\",\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n }\n ],\n \"UserName\": \"<string>\",\n \"TicketCategories\": [\n {\n \"Id\": 123,\n \"Name\": \"<string>\",\n \"ToolTip\": \"<string>\",\n \"Deleted\": true,\n \"Rank\": 123,\n \"Type\": \"<string>\",\n \"ChildItems\": \"<array>\",\n \"IconHint\": \"<string>\",\n \"ColorBlock\": 123,\n \"ExtraInfo\": \"<string>\",\n \"StyleHint\": \"<string>\",\n \"FullName\": \"<string>\",\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n }\n ],\n \"NickName\": \"<string>\",\n \"WaitingForApproval\": true,\n \"ExtraFields\": {},\n \"CustomFields\": {},\n \"PostSaveCommands\": [\n {\n \"Name\": \"<string>\",\n \"DisplayName\": \"<string>\",\n \"Description\": \"<string>\",\n \"ToolTip\": \"<string>\",\n \"ActionData\": \"<string>\",\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n }\n ],\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n }\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
CommandName: '<string>',
User: {
AssociateId: 123,
Name: '<string>',
Rank: 123,
Tooltip: '<string>',
LicenseOwners: [
{
Name: '<string>',
Description: '<string>',
RestrictedModuleLicenses: [
{
Unrestricted: true,
Total: 123,
Tooltip: '<string>',
CanAssign: true,
Free: 123,
InUse: 123,
IsHidden: true,
Assigned: true,
ModuleLicenseId: 123,
Name: '<string>',
Description: '<string>',
PrerequisiteModuleName: '<string>',
SortOrder: 123,
ExtraFlags: 123,
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
],
UnrestrictedModuleLicenses: [
{
Unrestricted: true,
Total: 123,
Tooltip: '<string>',
CanAssign: true,
Free: 123,
InUse: 123,
IsHidden: true,
Assigned: true,
ModuleLicenseId: 123,
Name: '<string>',
Description: '<string>',
PrerequisiteModuleName: '<string>',
SortOrder: 123,
ExtraFlags: 123,
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
],
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
],
Role: {
Id: 123,
Value: '<string>',
Tooltip: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
},
UserGroup: {
Value: '<string>',
Tooltip: '<string>',
Id: 123,
Rank: 123,
Deleted: true,
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
},
OtherGroups: [
{
Value: '<string>',
Tooltip: '<string>',
Id: 123,
Rank: 123,
Deleted: true,
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
],
Person: {
Position: '<string>',
PersonId: 123,
Mrmrs: '<string>',
Firstname: '<string>',
Lastname: '<string>',
MiddleName: '<string>',
Title: '<string>',
Description: '<string>',
Email: '<string>',
FullName: '<string>',
DirectPhone: '<string>',
FormalName: '<string>',
CountryId: 123,
ContactId: 123,
ContactName: '<string>',
Retired: 123,
Rank: 123,
ActiveInterests: 123,
ContactDepartment: '<string>',
ContactCountryId: 123,
ContactOrgNr: '<string>',
FaxPhone: '<string>',
MobilePhone: '<string>',
ContactPhone: '<string>',
AssociateName: '<string>',
AssociateId: 123,
UsePersonAddress: true,
ContactFax: '<string>',
Kanafname: '<string>',
Kanalname: '<string>',
Post1: '<string>',
Post2: '<string>',
Post3: '<string>',
EmailName: '<string>',
ContactFullName: '<string>',
ActiveErpLinks: 123,
TicketPriorityId: 123,
SupportLanguageId: 123,
SupportAssociateId: 123,
CategoryName: '<string>',
PersonNumber: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
},
Deleted: true,
Lastlogin: '2023-11-07T05:31:56Z',
Lastlogout: '2023-11-07T05:31:56Z',
EjUserId: 123,
RequestSignature: '<string>',
IsPersonRetired: true,
IsOnTravel: true,
Credentials: [
{
Type: {
DisplayType: '<string>',
Type: '<string>',
Description: '<string>',
CanCreatePerson: true,
IsUserNameSupported: true,
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
},
Value: '<string>',
DisplayValue: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
],
UserName: '<string>',
TicketCategories: [
{
Id: 123,
Name: '<string>',
ToolTip: '<string>',
Deleted: true,
Rank: 123,
Type: '<string>',
ChildItems: '<array>',
IconHint: '<string>',
ColorBlock: 123,
ExtraInfo: '<string>',
StyleHint: '<string>',
FullName: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
],
NickName: '<string>',
WaitingForApproval: true,
ExtraFields: {},
CustomFields: {},
PostSaveCommands: [
{
Name: '<string>',
DisplayName: '<string>',
Description: '<string>',
ToolTip: '<string>',
ActionData: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
],
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
})
};
fetch('http://localhost:56350/api/v1/Agents/User/ExecuteUserCommand', 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 => "56350",
CURLOPT_URL => "http://localhost:56350/api/v1/Agents/User/ExecuteUserCommand",
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([
'CommandName' => '<string>',
'User' => [
'AssociateId' => 123,
'Name' => '<string>',
'Rank' => 123,
'Tooltip' => '<string>',
'LicenseOwners' => [
[
'Name' => '<string>',
'Description' => '<string>',
'RestrictedModuleLicenses' => [
[
'Unrestricted' => true,
'Total' => 123,
'Tooltip' => '<string>',
'CanAssign' => true,
'Free' => 123,
'InUse' => 123,
'IsHidden' => true,
'Assigned' => true,
'ModuleLicenseId' => 123,
'Name' => '<string>',
'Description' => '<string>',
'PrerequisiteModuleName' => '<string>',
'SortOrder' => 123,
'ExtraFlags' => 123,
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
]
],
'UnrestrictedModuleLicenses' => [
[
'Unrestricted' => true,
'Total' => 123,
'Tooltip' => '<string>',
'CanAssign' => true,
'Free' => 123,
'InUse' => 123,
'IsHidden' => true,
'Assigned' => true,
'ModuleLicenseId' => 123,
'Name' => '<string>',
'Description' => '<string>',
'PrerequisiteModuleName' => '<string>',
'SortOrder' => 123,
'ExtraFlags' => 123,
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
]
],
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
]
],
'Role' => [
'Id' => 123,
'Value' => '<string>',
'Tooltip' => '<string>',
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
],
'UserGroup' => [
'Value' => '<string>',
'Tooltip' => '<string>',
'Id' => 123,
'Rank' => 123,
'Deleted' => true,
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
],
'OtherGroups' => [
[
'Value' => '<string>',
'Tooltip' => '<string>',
'Id' => 123,
'Rank' => 123,
'Deleted' => true,
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
]
],
'Person' => [
'Position' => '<string>',
'PersonId' => 123,
'Mrmrs' => '<string>',
'Firstname' => '<string>',
'Lastname' => '<string>',
'MiddleName' => '<string>',
'Title' => '<string>',
'Description' => '<string>',
'Email' => '<string>',
'FullName' => '<string>',
'DirectPhone' => '<string>',
'FormalName' => '<string>',
'CountryId' => 123,
'ContactId' => 123,
'ContactName' => '<string>',
'Retired' => 123,
'Rank' => 123,
'ActiveInterests' => 123,
'ContactDepartment' => '<string>',
'ContactCountryId' => 123,
'ContactOrgNr' => '<string>',
'FaxPhone' => '<string>',
'MobilePhone' => '<string>',
'ContactPhone' => '<string>',
'AssociateName' => '<string>',
'AssociateId' => 123,
'UsePersonAddress' => true,
'ContactFax' => '<string>',
'Kanafname' => '<string>',
'Kanalname' => '<string>',
'Post1' => '<string>',
'Post2' => '<string>',
'Post3' => '<string>',
'EmailName' => '<string>',
'ContactFullName' => '<string>',
'ActiveErpLinks' => 123,
'TicketPriorityId' => 123,
'SupportLanguageId' => 123,
'SupportAssociateId' => 123,
'CategoryName' => '<string>',
'PersonNumber' => '<string>',
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
],
'Deleted' => true,
'Lastlogin' => '2023-11-07T05:31:56Z',
'Lastlogout' => '2023-11-07T05:31:56Z',
'EjUserId' => 123,
'RequestSignature' => '<string>',
'IsPersonRetired' => true,
'IsOnTravel' => true,
'Credentials' => [
[
'Type' => [
'DisplayType' => '<string>',
'Type' => '<string>',
'Description' => '<string>',
'CanCreatePerson' => true,
'IsUserNameSupported' => true,
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
],
'Value' => '<string>',
'DisplayValue' => '<string>',
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
]
],
'UserName' => '<string>',
'TicketCategories' => [
[
'Id' => 123,
'Name' => '<string>',
'ToolTip' => '<string>',
'Deleted' => true,
'Rank' => 123,
'Type' => '<string>',
'ChildItems' => '<array>',
'IconHint' => '<string>',
'ColorBlock' => 123,
'ExtraInfo' => '<string>',
'StyleHint' => '<string>',
'FullName' => '<string>',
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
]
],
'NickName' => '<string>',
'WaitingForApproval' => true,
'ExtraFields' => [
],
'CustomFields' => [
],
'PostSaveCommands' => [
[
'Name' => '<string>',
'DisplayName' => '<string>',
'Description' => '<string>',
'ToolTip' => '<string>',
'ActionData' => '<string>',
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
]
],
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
]
]),
CURLOPT_HTTPHEADER => [
"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:56350/api/v1/Agents/User/ExecuteUserCommand"
payload = {
"CommandName": "<string>",
"User": {
"AssociateId": 123,
"Name": "<string>",
"Rank": 123,
"Tooltip": "<string>",
"LicenseOwners": [
{
"Name": "<string>",
"Description": "<string>",
"RestrictedModuleLicenses": [
{
"Unrestricted": True,
"Total": 123,
"Tooltip": "<string>",
"CanAssign": True,
"Free": 123,
"InUse": 123,
"IsHidden": True,
"Assigned": True,
"ModuleLicenseId": 123,
"Name": "<string>",
"Description": "<string>",
"PrerequisiteModuleName": "<string>",
"SortOrder": 123,
"ExtraFlags": 123,
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}
],
"UnrestrictedModuleLicenses": [
{
"Unrestricted": True,
"Total": 123,
"Tooltip": "<string>",
"CanAssign": True,
"Free": 123,
"InUse": 123,
"IsHidden": True,
"Assigned": True,
"ModuleLicenseId": 123,
"Name": "<string>",
"Description": "<string>",
"PrerequisiteModuleName": "<string>",
"SortOrder": 123,
"ExtraFlags": 123,
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}
],
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}
],
"Role": {
"Id": 123,
"Value": "<string>",
"Tooltip": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"UserGroup": {
"Value": "<string>",
"Tooltip": "<string>",
"Id": 123,
"Rank": 123,
"Deleted": True,
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"OtherGroups": [
{
"Value": "<string>",
"Tooltip": "<string>",
"Id": 123,
"Rank": 123,
"Deleted": True,
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}
],
"Person": {
"Position": "<string>",
"PersonId": 123,
"Mrmrs": "<string>",
"Firstname": "<string>",
"Lastname": "<string>",
"MiddleName": "<string>",
"Title": "<string>",
"Description": "<string>",
"Email": "<string>",
"FullName": "<string>",
"DirectPhone": "<string>",
"FormalName": "<string>",
"CountryId": 123,
"ContactId": 123,
"ContactName": "<string>",
"Retired": 123,
"Rank": 123,
"ActiveInterests": 123,
"ContactDepartment": "<string>",
"ContactCountryId": 123,
"ContactOrgNr": "<string>",
"FaxPhone": "<string>",
"MobilePhone": "<string>",
"ContactPhone": "<string>",
"AssociateName": "<string>",
"AssociateId": 123,
"UsePersonAddress": True,
"ContactFax": "<string>",
"Kanafname": "<string>",
"Kanalname": "<string>",
"Post1": "<string>",
"Post2": "<string>",
"Post3": "<string>",
"EmailName": "<string>",
"ContactFullName": "<string>",
"ActiveErpLinks": 123,
"TicketPriorityId": 123,
"SupportLanguageId": 123,
"SupportAssociateId": 123,
"CategoryName": "<string>",
"PersonNumber": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"Deleted": True,
"Lastlogin": "2023-11-07T05:31:56Z",
"Lastlogout": "2023-11-07T05:31:56Z",
"EjUserId": 123,
"RequestSignature": "<string>",
"IsPersonRetired": True,
"IsOnTravel": True,
"Credentials": [
{
"Type": {
"DisplayType": "<string>",
"Type": "<string>",
"Description": "<string>",
"CanCreatePerson": True,
"IsUserNameSupported": True,
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"Value": "<string>",
"DisplayValue": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}
],
"UserName": "<string>",
"TicketCategories": [
{
"Id": 123,
"Name": "<string>",
"ToolTip": "<string>",
"Deleted": True,
"Rank": 123,
"Type": "<string>",
"ChildItems": "<array>",
"IconHint": "<string>",
"ColorBlock": 123,
"ExtraInfo": "<string>",
"StyleHint": "<string>",
"FullName": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}
],
"NickName": "<string>",
"WaitingForApproval": True,
"ExtraFields": {},
"CustomFields": {},
"PostSaveCommands": [
{
"Name": "<string>",
"DisplayName": "<string>",
"Description": "<string>",
"ToolTip": "<string>",
"ActionData": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}
],
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
CommandName: '<string>',
User: {
AssociateId: 123,
Name: '<string>',
Rank: 123,
Tooltip: '<string>',
LicenseOwners: [
{
Name: '<string>',
Description: '<string>',
RestrictedModuleLicenses: [
{
Unrestricted: true,
Total: 123,
Tooltip: '<string>',
CanAssign: true,
Free: 123,
InUse: 123,
IsHidden: true,
Assigned: true,
ModuleLicenseId: 123,
Name: '<string>',
Description: '<string>',
PrerequisiteModuleName: '<string>',
SortOrder: 123,
ExtraFlags: 123,
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
],
UnrestrictedModuleLicenses: [
{
Unrestricted: true,
Total: 123,
Tooltip: '<string>',
CanAssign: true,
Free: 123,
InUse: 123,
IsHidden: true,
Assigned: true,
ModuleLicenseId: 123,
Name: '<string>',
Description: '<string>',
PrerequisiteModuleName: '<string>',
SortOrder: 123,
ExtraFlags: 123,
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
],
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
],
Role: {
Id: 123,
Value: '<string>',
Tooltip: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
},
UserGroup: {
Value: '<string>',
Tooltip: '<string>',
Id: 123,
Rank: 123,
Deleted: true,
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
},
OtherGroups: [
{
Value: '<string>',
Tooltip: '<string>',
Id: 123,
Rank: 123,
Deleted: true,
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
],
Person: {
Position: '<string>',
PersonId: 123,
Mrmrs: '<string>',
Firstname: '<string>',
Lastname: '<string>',
MiddleName: '<string>',
Title: '<string>',
Description: '<string>',
Email: '<string>',
FullName: '<string>',
DirectPhone: '<string>',
FormalName: '<string>',
CountryId: 123,
ContactId: 123,
ContactName: '<string>',
Retired: 123,
Rank: 123,
ActiveInterests: 123,
ContactDepartment: '<string>',
ContactCountryId: 123,
ContactOrgNr: '<string>',
FaxPhone: '<string>',
MobilePhone: '<string>',
ContactPhone: '<string>',
AssociateName: '<string>',
AssociateId: 123,
UsePersonAddress: true,
ContactFax: '<string>',
Kanafname: '<string>',
Kanalname: '<string>',
Post1: '<string>',
Post2: '<string>',
Post3: '<string>',
EmailName: '<string>',
ContactFullName: '<string>',
ActiveErpLinks: 123,
TicketPriorityId: 123,
SupportLanguageId: 123,
SupportAssociateId: 123,
CategoryName: '<string>',
PersonNumber: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
},
Deleted: true,
Lastlogin: '2023-11-07T05:31:56Z',
Lastlogout: '2023-11-07T05:31:56Z',
EjUserId: 123,
RequestSignature: '<string>',
IsPersonRetired: true,
IsOnTravel: true,
Credentials: [
{
Type: {
DisplayType: '<string>',
Type: '<string>',
Description: '<string>',
CanCreatePerson: true,
IsUserNameSupported: true,
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
},
Value: '<string>',
DisplayValue: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
],
UserName: '<string>',
TicketCategories: [
{
Id: 123,
Name: '<string>',
ToolTip: '<string>',
Deleted: true,
Rank: 123,
Type: '<string>',
ChildItems: '<array>',
IconHint: '<string>',
ColorBlock: 123,
ExtraInfo: '<string>',
StyleHint: '<string>',
FullName: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
],
NickName: '<string>',
WaitingForApproval: true,
ExtraFields: {},
CustomFields: {},
PostSaveCommands: [
{
Name: '<string>',
DisplayName: '<string>',
Description: '<string>',
ToolTip: '<string>',
ActionData: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
],
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
})
};
fetch('http://localhost:56350/api/v1/Agents/User/ExecuteUserCommand', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"Success": true,
"Message": "<string>",
"Result": "Implicit",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}Execute User Command
Executes the custom command for User
NsApiSlow threshold: 2000 ms.
Execute User Command
using RestSharp;
var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/User/ExecuteUserCommand");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n \"CommandName\": \"<string>\",\n \"User\": {\n \"AssociateId\": 123,\n \"Name\": \"<string>\",\n \"Rank\": 123,\n \"Tooltip\": \"<string>\",\n \"LicenseOwners\": [\n {\n \"Name\": \"<string>\",\n \"Description\": \"<string>\",\n \"RestrictedModuleLicenses\": [\n {\n \"Unrestricted\": true,\n \"Total\": 123,\n \"Tooltip\": \"<string>\",\n \"CanAssign\": true,\n \"Free\": 123,\n \"InUse\": 123,\n \"IsHidden\": true,\n \"Assigned\": true,\n \"ModuleLicenseId\": 123,\n \"Name\": \"<string>\",\n \"Description\": \"<string>\",\n \"PrerequisiteModuleName\": \"<string>\",\n \"SortOrder\": 123,\n \"ExtraFlags\": 123,\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n }\n ],\n \"UnrestrictedModuleLicenses\": [\n {\n \"Unrestricted\": true,\n \"Total\": 123,\n \"Tooltip\": \"<string>\",\n \"CanAssign\": true,\n \"Free\": 123,\n \"InUse\": 123,\n \"IsHidden\": true,\n \"Assigned\": true,\n \"ModuleLicenseId\": 123,\n \"Name\": \"<string>\",\n \"Description\": \"<string>\",\n \"PrerequisiteModuleName\": \"<string>\",\n \"SortOrder\": 123,\n \"ExtraFlags\": 123,\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n }\n ],\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n }\n ],\n \"Role\": {\n \"Id\": 123,\n \"Value\": \"<string>\",\n \"Tooltip\": \"<string>\",\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n },\n \"UserGroup\": {\n \"Value\": \"<string>\",\n \"Tooltip\": \"<string>\",\n \"Id\": 123,\n \"Rank\": 123,\n \"Deleted\": true,\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n },\n \"OtherGroups\": [\n {\n \"Value\": \"<string>\",\n \"Tooltip\": \"<string>\",\n \"Id\": 123,\n \"Rank\": 123,\n \"Deleted\": true,\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n }\n ],\n \"Person\": {\n \"Position\": \"<string>\",\n \"PersonId\": 123,\n \"Mrmrs\": \"<string>\",\n \"Firstname\": \"<string>\",\n \"Lastname\": \"<string>\",\n \"MiddleName\": \"<string>\",\n \"Title\": \"<string>\",\n \"Description\": \"<string>\",\n \"Email\": \"<string>\",\n \"FullName\": \"<string>\",\n \"DirectPhone\": \"<string>\",\n \"FormalName\": \"<string>\",\n \"CountryId\": 123,\n \"ContactId\": 123,\n \"ContactName\": \"<string>\",\n \"Retired\": 123,\n \"Rank\": 123,\n \"ActiveInterests\": 123,\n \"ContactDepartment\": \"<string>\",\n \"ContactCountryId\": 123,\n \"ContactOrgNr\": \"<string>\",\n \"FaxPhone\": \"<string>\",\n \"MobilePhone\": \"<string>\",\n \"ContactPhone\": \"<string>\",\n \"AssociateName\": \"<string>\",\n \"AssociateId\": 123,\n \"UsePersonAddress\": true,\n \"ContactFax\": \"<string>\",\n \"Kanafname\": \"<string>\",\n \"Kanalname\": \"<string>\",\n \"Post1\": \"<string>\",\n \"Post2\": \"<string>\",\n \"Post3\": \"<string>\",\n \"EmailName\": \"<string>\",\n \"ContactFullName\": \"<string>\",\n \"ActiveErpLinks\": 123,\n \"TicketPriorityId\": 123,\n \"SupportLanguageId\": 123,\n \"SupportAssociateId\": 123,\n \"CategoryName\": \"<string>\",\n \"PersonNumber\": \"<string>\",\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n },\n \"Deleted\": true,\n \"Lastlogin\": \"2023-11-07T05:31:56Z\",\n \"Lastlogout\": \"2023-11-07T05:31:56Z\",\n \"EjUserId\": 123,\n \"RequestSignature\": \"<string>\",\n \"IsPersonRetired\": true,\n \"IsOnTravel\": true,\n \"Credentials\": [\n {\n \"Type\": {\n \"DisplayType\": \"<string>\",\n \"Type\": \"<string>\",\n \"Description\": \"<string>\",\n \"CanCreatePerson\": true,\n \"IsUserNameSupported\": true,\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n },\n \"Value\": \"<string>\",\n \"DisplayValue\": \"<string>\",\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n }\n ],\n \"UserName\": \"<string>\",\n \"TicketCategories\": [\n {\n \"Id\": 123,\n \"Name\": \"<string>\",\n \"ToolTip\": \"<string>\",\n \"Deleted\": true,\n \"Rank\": 123,\n \"Type\": \"<string>\",\n \"ChildItems\": \"<array>\",\n \"IconHint\": \"<string>\",\n \"ColorBlock\": 123,\n \"ExtraInfo\": \"<string>\",\n \"StyleHint\": \"<string>\",\n \"FullName\": \"<string>\",\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n }\n ],\n \"NickName\": \"<string>\",\n \"WaitingForApproval\": true,\n \"ExtraFields\": {},\n \"CustomFields\": {},\n \"PostSaveCommands\": [\n {\n \"Name\": \"<string>\",\n \"DisplayName\": \"<string>\",\n \"Description\": \"<string>\",\n \"ToolTip\": \"<string>\",\n \"ActionData\": \"<string>\",\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n }\n ],\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n }\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
CommandName: '<string>',
User: {
AssociateId: 123,
Name: '<string>',
Rank: 123,
Tooltip: '<string>',
LicenseOwners: [
{
Name: '<string>',
Description: '<string>',
RestrictedModuleLicenses: [
{
Unrestricted: true,
Total: 123,
Tooltip: '<string>',
CanAssign: true,
Free: 123,
InUse: 123,
IsHidden: true,
Assigned: true,
ModuleLicenseId: 123,
Name: '<string>',
Description: '<string>',
PrerequisiteModuleName: '<string>',
SortOrder: 123,
ExtraFlags: 123,
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
],
UnrestrictedModuleLicenses: [
{
Unrestricted: true,
Total: 123,
Tooltip: '<string>',
CanAssign: true,
Free: 123,
InUse: 123,
IsHidden: true,
Assigned: true,
ModuleLicenseId: 123,
Name: '<string>',
Description: '<string>',
PrerequisiteModuleName: '<string>',
SortOrder: 123,
ExtraFlags: 123,
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
],
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
],
Role: {
Id: 123,
Value: '<string>',
Tooltip: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
},
UserGroup: {
Value: '<string>',
Tooltip: '<string>',
Id: 123,
Rank: 123,
Deleted: true,
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
},
OtherGroups: [
{
Value: '<string>',
Tooltip: '<string>',
Id: 123,
Rank: 123,
Deleted: true,
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
],
Person: {
Position: '<string>',
PersonId: 123,
Mrmrs: '<string>',
Firstname: '<string>',
Lastname: '<string>',
MiddleName: '<string>',
Title: '<string>',
Description: '<string>',
Email: '<string>',
FullName: '<string>',
DirectPhone: '<string>',
FormalName: '<string>',
CountryId: 123,
ContactId: 123,
ContactName: '<string>',
Retired: 123,
Rank: 123,
ActiveInterests: 123,
ContactDepartment: '<string>',
ContactCountryId: 123,
ContactOrgNr: '<string>',
FaxPhone: '<string>',
MobilePhone: '<string>',
ContactPhone: '<string>',
AssociateName: '<string>',
AssociateId: 123,
UsePersonAddress: true,
ContactFax: '<string>',
Kanafname: '<string>',
Kanalname: '<string>',
Post1: '<string>',
Post2: '<string>',
Post3: '<string>',
EmailName: '<string>',
ContactFullName: '<string>',
ActiveErpLinks: 123,
TicketPriorityId: 123,
SupportLanguageId: 123,
SupportAssociateId: 123,
CategoryName: '<string>',
PersonNumber: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
},
Deleted: true,
Lastlogin: '2023-11-07T05:31:56Z',
Lastlogout: '2023-11-07T05:31:56Z',
EjUserId: 123,
RequestSignature: '<string>',
IsPersonRetired: true,
IsOnTravel: true,
Credentials: [
{
Type: {
DisplayType: '<string>',
Type: '<string>',
Description: '<string>',
CanCreatePerson: true,
IsUserNameSupported: true,
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
},
Value: '<string>',
DisplayValue: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
],
UserName: '<string>',
TicketCategories: [
{
Id: 123,
Name: '<string>',
ToolTip: '<string>',
Deleted: true,
Rank: 123,
Type: '<string>',
ChildItems: '<array>',
IconHint: '<string>',
ColorBlock: 123,
ExtraInfo: '<string>',
StyleHint: '<string>',
FullName: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
],
NickName: '<string>',
WaitingForApproval: true,
ExtraFields: {},
CustomFields: {},
PostSaveCommands: [
{
Name: '<string>',
DisplayName: '<string>',
Description: '<string>',
ToolTip: '<string>',
ActionData: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
],
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
})
};
fetch('http://localhost:56350/api/v1/Agents/User/ExecuteUserCommand', 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 => "56350",
CURLOPT_URL => "http://localhost:56350/api/v1/Agents/User/ExecuteUserCommand",
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([
'CommandName' => '<string>',
'User' => [
'AssociateId' => 123,
'Name' => '<string>',
'Rank' => 123,
'Tooltip' => '<string>',
'LicenseOwners' => [
[
'Name' => '<string>',
'Description' => '<string>',
'RestrictedModuleLicenses' => [
[
'Unrestricted' => true,
'Total' => 123,
'Tooltip' => '<string>',
'CanAssign' => true,
'Free' => 123,
'InUse' => 123,
'IsHidden' => true,
'Assigned' => true,
'ModuleLicenseId' => 123,
'Name' => '<string>',
'Description' => '<string>',
'PrerequisiteModuleName' => '<string>',
'SortOrder' => 123,
'ExtraFlags' => 123,
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
]
],
'UnrestrictedModuleLicenses' => [
[
'Unrestricted' => true,
'Total' => 123,
'Tooltip' => '<string>',
'CanAssign' => true,
'Free' => 123,
'InUse' => 123,
'IsHidden' => true,
'Assigned' => true,
'ModuleLicenseId' => 123,
'Name' => '<string>',
'Description' => '<string>',
'PrerequisiteModuleName' => '<string>',
'SortOrder' => 123,
'ExtraFlags' => 123,
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
]
],
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
]
],
'Role' => [
'Id' => 123,
'Value' => '<string>',
'Tooltip' => '<string>',
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
],
'UserGroup' => [
'Value' => '<string>',
'Tooltip' => '<string>',
'Id' => 123,
'Rank' => 123,
'Deleted' => true,
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
],
'OtherGroups' => [
[
'Value' => '<string>',
'Tooltip' => '<string>',
'Id' => 123,
'Rank' => 123,
'Deleted' => true,
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
]
],
'Person' => [
'Position' => '<string>',
'PersonId' => 123,
'Mrmrs' => '<string>',
'Firstname' => '<string>',
'Lastname' => '<string>',
'MiddleName' => '<string>',
'Title' => '<string>',
'Description' => '<string>',
'Email' => '<string>',
'FullName' => '<string>',
'DirectPhone' => '<string>',
'FormalName' => '<string>',
'CountryId' => 123,
'ContactId' => 123,
'ContactName' => '<string>',
'Retired' => 123,
'Rank' => 123,
'ActiveInterests' => 123,
'ContactDepartment' => '<string>',
'ContactCountryId' => 123,
'ContactOrgNr' => '<string>',
'FaxPhone' => '<string>',
'MobilePhone' => '<string>',
'ContactPhone' => '<string>',
'AssociateName' => '<string>',
'AssociateId' => 123,
'UsePersonAddress' => true,
'ContactFax' => '<string>',
'Kanafname' => '<string>',
'Kanalname' => '<string>',
'Post1' => '<string>',
'Post2' => '<string>',
'Post3' => '<string>',
'EmailName' => '<string>',
'ContactFullName' => '<string>',
'ActiveErpLinks' => 123,
'TicketPriorityId' => 123,
'SupportLanguageId' => 123,
'SupportAssociateId' => 123,
'CategoryName' => '<string>',
'PersonNumber' => '<string>',
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
],
'Deleted' => true,
'Lastlogin' => '2023-11-07T05:31:56Z',
'Lastlogout' => '2023-11-07T05:31:56Z',
'EjUserId' => 123,
'RequestSignature' => '<string>',
'IsPersonRetired' => true,
'IsOnTravel' => true,
'Credentials' => [
[
'Type' => [
'DisplayType' => '<string>',
'Type' => '<string>',
'Description' => '<string>',
'CanCreatePerson' => true,
'IsUserNameSupported' => true,
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
],
'Value' => '<string>',
'DisplayValue' => '<string>',
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
]
],
'UserName' => '<string>',
'TicketCategories' => [
[
'Id' => 123,
'Name' => '<string>',
'ToolTip' => '<string>',
'Deleted' => true,
'Rank' => 123,
'Type' => '<string>',
'ChildItems' => '<array>',
'IconHint' => '<string>',
'ColorBlock' => 123,
'ExtraInfo' => '<string>',
'StyleHint' => '<string>',
'FullName' => '<string>',
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
]
],
'NickName' => '<string>',
'WaitingForApproval' => true,
'ExtraFields' => [
],
'CustomFields' => [
],
'PostSaveCommands' => [
[
'Name' => '<string>',
'DisplayName' => '<string>',
'Description' => '<string>',
'ToolTip' => '<string>',
'ActionData' => '<string>',
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
]
],
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
]
]),
CURLOPT_HTTPHEADER => [
"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:56350/api/v1/Agents/User/ExecuteUserCommand"
payload = {
"CommandName": "<string>",
"User": {
"AssociateId": 123,
"Name": "<string>",
"Rank": 123,
"Tooltip": "<string>",
"LicenseOwners": [
{
"Name": "<string>",
"Description": "<string>",
"RestrictedModuleLicenses": [
{
"Unrestricted": True,
"Total": 123,
"Tooltip": "<string>",
"CanAssign": True,
"Free": 123,
"InUse": 123,
"IsHidden": True,
"Assigned": True,
"ModuleLicenseId": 123,
"Name": "<string>",
"Description": "<string>",
"PrerequisiteModuleName": "<string>",
"SortOrder": 123,
"ExtraFlags": 123,
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}
],
"UnrestrictedModuleLicenses": [
{
"Unrestricted": True,
"Total": 123,
"Tooltip": "<string>",
"CanAssign": True,
"Free": 123,
"InUse": 123,
"IsHidden": True,
"Assigned": True,
"ModuleLicenseId": 123,
"Name": "<string>",
"Description": "<string>",
"PrerequisiteModuleName": "<string>",
"SortOrder": 123,
"ExtraFlags": 123,
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}
],
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}
],
"Role": {
"Id": 123,
"Value": "<string>",
"Tooltip": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"UserGroup": {
"Value": "<string>",
"Tooltip": "<string>",
"Id": 123,
"Rank": 123,
"Deleted": True,
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"OtherGroups": [
{
"Value": "<string>",
"Tooltip": "<string>",
"Id": 123,
"Rank": 123,
"Deleted": True,
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}
],
"Person": {
"Position": "<string>",
"PersonId": 123,
"Mrmrs": "<string>",
"Firstname": "<string>",
"Lastname": "<string>",
"MiddleName": "<string>",
"Title": "<string>",
"Description": "<string>",
"Email": "<string>",
"FullName": "<string>",
"DirectPhone": "<string>",
"FormalName": "<string>",
"CountryId": 123,
"ContactId": 123,
"ContactName": "<string>",
"Retired": 123,
"Rank": 123,
"ActiveInterests": 123,
"ContactDepartment": "<string>",
"ContactCountryId": 123,
"ContactOrgNr": "<string>",
"FaxPhone": "<string>",
"MobilePhone": "<string>",
"ContactPhone": "<string>",
"AssociateName": "<string>",
"AssociateId": 123,
"UsePersonAddress": True,
"ContactFax": "<string>",
"Kanafname": "<string>",
"Kanalname": "<string>",
"Post1": "<string>",
"Post2": "<string>",
"Post3": "<string>",
"EmailName": "<string>",
"ContactFullName": "<string>",
"ActiveErpLinks": 123,
"TicketPriorityId": 123,
"SupportLanguageId": 123,
"SupportAssociateId": 123,
"CategoryName": "<string>",
"PersonNumber": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"Deleted": True,
"Lastlogin": "2023-11-07T05:31:56Z",
"Lastlogout": "2023-11-07T05:31:56Z",
"EjUserId": 123,
"RequestSignature": "<string>",
"IsPersonRetired": True,
"IsOnTravel": True,
"Credentials": [
{
"Type": {
"DisplayType": "<string>",
"Type": "<string>",
"Description": "<string>",
"CanCreatePerson": True,
"IsUserNameSupported": True,
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"Value": "<string>",
"DisplayValue": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}
],
"UserName": "<string>",
"TicketCategories": [
{
"Id": 123,
"Name": "<string>",
"ToolTip": "<string>",
"Deleted": True,
"Rank": 123,
"Type": "<string>",
"ChildItems": "<array>",
"IconHint": "<string>",
"ColorBlock": 123,
"ExtraInfo": "<string>",
"StyleHint": "<string>",
"FullName": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}
],
"NickName": "<string>",
"WaitingForApproval": True,
"ExtraFields": {},
"CustomFields": {},
"PostSaveCommands": [
{
"Name": "<string>",
"DisplayName": "<string>",
"Description": "<string>",
"ToolTip": "<string>",
"ActionData": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}
],
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
CommandName: '<string>',
User: {
AssociateId: 123,
Name: '<string>',
Rank: 123,
Tooltip: '<string>',
LicenseOwners: [
{
Name: '<string>',
Description: '<string>',
RestrictedModuleLicenses: [
{
Unrestricted: true,
Total: 123,
Tooltip: '<string>',
CanAssign: true,
Free: 123,
InUse: 123,
IsHidden: true,
Assigned: true,
ModuleLicenseId: 123,
Name: '<string>',
Description: '<string>',
PrerequisiteModuleName: '<string>',
SortOrder: 123,
ExtraFlags: 123,
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
],
UnrestrictedModuleLicenses: [
{
Unrestricted: true,
Total: 123,
Tooltip: '<string>',
CanAssign: true,
Free: 123,
InUse: 123,
IsHidden: true,
Assigned: true,
ModuleLicenseId: 123,
Name: '<string>',
Description: '<string>',
PrerequisiteModuleName: '<string>',
SortOrder: 123,
ExtraFlags: 123,
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
],
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
],
Role: {
Id: 123,
Value: '<string>',
Tooltip: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
},
UserGroup: {
Value: '<string>',
Tooltip: '<string>',
Id: 123,
Rank: 123,
Deleted: true,
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
},
OtherGroups: [
{
Value: '<string>',
Tooltip: '<string>',
Id: 123,
Rank: 123,
Deleted: true,
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
],
Person: {
Position: '<string>',
PersonId: 123,
Mrmrs: '<string>',
Firstname: '<string>',
Lastname: '<string>',
MiddleName: '<string>',
Title: '<string>',
Description: '<string>',
Email: '<string>',
FullName: '<string>',
DirectPhone: '<string>',
FormalName: '<string>',
CountryId: 123,
ContactId: 123,
ContactName: '<string>',
Retired: 123,
Rank: 123,
ActiveInterests: 123,
ContactDepartment: '<string>',
ContactCountryId: 123,
ContactOrgNr: '<string>',
FaxPhone: '<string>',
MobilePhone: '<string>',
ContactPhone: '<string>',
AssociateName: '<string>',
AssociateId: 123,
UsePersonAddress: true,
ContactFax: '<string>',
Kanafname: '<string>',
Kanalname: '<string>',
Post1: '<string>',
Post2: '<string>',
Post3: '<string>',
EmailName: '<string>',
ContactFullName: '<string>',
ActiveErpLinks: 123,
TicketPriorityId: 123,
SupportLanguageId: 123,
SupportAssociateId: 123,
CategoryName: '<string>',
PersonNumber: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
},
Deleted: true,
Lastlogin: '2023-11-07T05:31:56Z',
Lastlogout: '2023-11-07T05:31:56Z',
EjUserId: 123,
RequestSignature: '<string>',
IsPersonRetired: true,
IsOnTravel: true,
Credentials: [
{
Type: {
DisplayType: '<string>',
Type: '<string>',
Description: '<string>',
CanCreatePerson: true,
IsUserNameSupported: true,
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
},
Value: '<string>',
DisplayValue: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
],
UserName: '<string>',
TicketCategories: [
{
Id: 123,
Name: '<string>',
ToolTip: '<string>',
Deleted: true,
Rank: 123,
Type: '<string>',
ChildItems: '<array>',
IconHint: '<string>',
ColorBlock: 123,
ExtraInfo: '<string>',
StyleHint: '<string>',
FullName: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
],
NickName: '<string>',
WaitingForApproval: true,
ExtraFields: {},
CustomFields: {},
PostSaveCommands: [
{
Name: '<string>',
DisplayName: '<string>',
Description: '<string>',
ToolTip: '<string>',
ActionData: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
],
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
})
};
fetch('http://localhost:56350/api/v1/Agents/User/ExecuteUserCommand', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"Success": true,
"Message": "<string>",
"Result": "Implicit",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}Headers
Convert string references and multi-language values into a specified language (iso2) code.
Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
Specify the timezone code that you would like date/time responses converted to.
The application token that identifies the partner app. Used when calling Online WebAPI from a server.
Body
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencodedapplication/json-patch+jsonapplication/merge-patch+json
CommandName, ActionResult, User
Executes the custom command for User: Command name, Action result, User entity.
Response
OK
Generic carrier object for entity commands. Carrier object for CommandResult.
The command was successfully executed.
Message which should be displayed in GUI.
The result used in this action.
Available options:
Implicit, Yes, Ok, No, Cancel Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.
Show child attributes
Show child attributes
Field property dictionary mapping field names to field access rights.
Show child attributes
Show child attributes
Related topics
Execute User Command AsyncExecute Document CommandGet User CommandsNSDocumentAgentGet User Commands Async⌘I