Modify Client Properties

This operation updates the properties associated with a client.

More Details

Path Parameters

• clientId integer required

  The client ID of the client. If the client ID is not known, use the Get Client ID API to retrieve it

application/json

Request Body

• clientProperties object

  clientProps object

  clientSecurity object

  associatedUserGroups object[]

  userGroupName string

  ownerCapabilities object

  activityControl object

  clientActivityControl object

  activityControlOptions object[]

  client object

  displayName string

  clientDescription string

  installDirectory string

  jobResulsDir object

  path string

  userAccount object

  userName string

  osInfo object

  Type string

  SubType string

  Version string

  OsDisplayInfo object

  ProcessorType string

  OSName string

  clientEntity object

  hostName string

  clientName string

  commCellName string

  TimeZone object

  TimeZoneName string
• association object

  entity object[]

  displayName string

  clientName string

Responses

• 200

---

OK

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• processinginstructioninfo object

  attributes object[]

  name string

  value string
• response object[]

  errorCode integer

  entity object

  clientId integer

  clientName string

  _type_ integer

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "string",
        "value": "string"
      }
    ]
  },
  "response": [
    {
      "errorCode": 0,
      "entity": {
        "clientId": 0,
        "clientName": "string",
        "_type_": 0
      }
    }
  ]
}

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "exitval",
        "value": "0"
      }
    ]
  },
  "response": [
    {
      "errorCode": 0,
      "entity": {
        "clientId": 1085,
        "clientName": "vsaqa",
        "_type_": 3
      }
    }
  ]
}

Loading...