POST v1/company/{environment}/{orgId}/settings
Use this method to add custom settings to an org.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| environment |
Environment where the org was created. |
string |
Required |
| orgId |
MaaS Org Id |
integer |
Required |
Body Parameters
The structure that defines the setting values that need be created.
Setting| Name | Description | Type | Additional information |
|---|---|---|---|
| systemId |
Setting internal identifier, most systems using |
string |
None. |
| group |
Property group, note that not all settings storage like company settings support groups yet. Groups are available for Applications, Properties and Users only. |
string |
None. |
| id |
Setting unique identifier. |
string |
None. |
| name |
Setting display name. |
string |
None. |
| value |
Setting value stored. |
string |
None. |
Request Formats
application/json, text/json
{
"systemId": "sample string 1",
"group": "sample string 2",
"id": "sample string 3",
"name": "sample string 4",
"value": "sample string 5"
}
Response Information
Resource Description
Returns the setting created if all values were correct, and appropriate HTTP Status message of created (201).
Setting| Name | Description | Type | Additional information |
|---|---|---|---|
| systemId |
Setting internal identifier, most systems using |
string |
None. |
| group |
Property group, note that not all settings storage like company settings support groups yet. Groups are available for Applications, Properties and Users only. |
string |
None. |
| id |
Setting unique identifier. |
string |
None. |
| name |
Setting display name. |
string |
None. |
| value |
Setting value stored. |
string |
None. |
Response Formats
application/json, text/json
{
"systemId": "sample string 1",
"group": "sample string 2",
"id": "sample string 3",
"name": "sample string 4",
"value": "sample string 5"
}