Jump to

• Request
• Response

Modify the UserPreference object.

put

https://{host}:{port}/{basePath}/UserPreference/

modify the UserPreference object.

Request

Path Parameters

• UserPreferenceId(required):
  UserPreferenceId to modify the associated UserPreference.

Header Parameters

• Auth-Token(required): string
  Auth-Token received from a successful login response.
• opc-request-id: string
  Unique identifier for the request

Supported Media Types

• application/x-www-form-urlencoded

Request Body - application/x-www-form-urlencoded ()

Root Schema : schema

Type: object

Show Source

• userPreference: object UserPreference
  Session preferences for a user.

{
    "properties":{
        "userPreference":{
            "$ref":"#/components/schemas/UserPreference",
            "type":"object"
        }
    }
}

Nested Schema : UserPreference

Type: object

Session preferences for a user.

Show Source

• alphabetizeMode(required): string
  Allowed Values: [ "YES", "NO" ]
• attributeDisplay(required): string
  Allowed Values: [ "DISPLAYNAME", "ATTRIBUTENAME" ]
• endLineCharsDisplayValue(required): string
  Allowed Values: [ "CRLF", "CR", "LF" ]
• faultIds: array faultIds
• outputMode(required): string
  Allowed Values: [ "VERBOSE", "SPARSE", "XML" ]
• userId: object User
  The User object represents a user account.
• wsCallMode(required): string
  Allowed Values: [ "SYNCHRONOUS", "ASYNCHRONOUS" ]
• wsTimeoutInSeconds(required): integer

{
    "properties":{
        "wsCallMode":{
            "description":"",
            "enum":[
                "SYNCHRONOUS",
                "ASYNCHRONOUS"
            ],
            "type":"string"
        },
        "alphabetizeMode":{
            "description":"",
            "enum":[
                "YES",
                "NO"
            ],
            "type":"string"
        },
        "attributeDisplay":{
            "description":"",
            "enum":[
                "DISPLAYNAME",
                "ATTRIBUTENAME"
            ],
            "type":"string"
        },
        "endLineCharsDisplayValue":{
            "description":"",
            "enum":[
                "CRLF",
                "CR",
                "LF"
            ],
            "type":"string"
        },
        "outputMode":{
            "description":"",
            "enum":[
                "VERBOSE",
                "SPARSE",
                "XML"
            ],
            "type":"string"
        },
        "wsTimeoutInSeconds":{
            "description":"",
            "type":"integer"
        },
        "userId":{
            "description":"",
            "$ref":"#/components/schemas/User"
        },
        "faultIds":{
            "description":"",
            "type":"array"
        }
    },
    "required":[
        "wsCallMode",
        "alphabetizeMode",
        "attributeDisplay",
        "endLineCharsDisplayValue",
        "outputMode",
        "wsTimeoutInSeconds"
    ],
    "type":"object",
    "description":"Session preferences for a user."
}

Nested Schema : faultIds

Type: array

Nested Schema : User

Type: object

The User object represents a user account.

Show Source

• authGroupIds: array authGroupIds
• confirmPassword(required): string
  Maximum Length: 100
• defaultUser: boolean
• faultIds: array faultIds
• name(required): string
  Maximum Length: 100
• password(required): string
  Maximum Length: 100
• publicKey(required): string
  Maximum Length: 1000
• userPreferenceId: object UserPreference
  Session preferences for a user.

{
    "properties":{
        "name":{
            "description":"",
            "maxLength":100,
            "type":"string"
        },
        "password":{
            "description":"",
            "maxLength":100,
            "type":"string"
        },
        "confirmPassword":{
            "description":"",
            "maxLength":100,
            "type":"string"
        },
        "publicKey":{
            "description":"",
            "maxLength":1000,
            "type":"string"
        },
        "defaultUser":{
            "description":"",
            "type":"boolean"
        },
        "authGroupIds":{
            "description":"",
            "type":"array"
        },
        "userPreferenceId":{
            "description":"",
            "$ref":"#/components/schemas/UserPreference"
        },
        "faultIds":{
            "description":"",
            "type":"array"
        }
    },
    "required":[
        "name",
        "password",
        "confirmPassword",
        "publicKey"
    ],
    "type":"object",
    "description":"The User object represents a user account."
}

Nested Schema : authGroupIds

Type: array

Nested Schema : faultIds

Type: array

Security

• basicAuth: http
  Type: http

Back to Top

Response

Supported Media Types

• application/json

200 Response

Request completed successfully.

Body ()

Root Schema : Job

Type: object

A Job represents the unit of work required to perform a particular action or set of actions. The Job Id value represents the time when the Job was created in milliseconds since epoch. This will be a unique value in relation to other Job objects.

Show Source

• abortedUser: string
  Maximum Length: 256
• associatedObjId: string
  Maximum Length: 128
• associatedObjType: string
  Maximum Length: 256
• endTime: timestamp
  Read-only and this operation is unsupported. @param endTime Time in milliseconds.
• jobName(required): string
  Maximum Length: 256
• progressMessage: string
  Maximum Length: 1024

  Read-only and this operation is unsupported. @param progressMessage.
• result: AssociatedObj
• runState: string
  Allowed Values: [ "ACTIVE", "SUCCEEDED", "FAILED", "ABORTED" ]
• startTime: timestamp
  Read-only and this operation is unsupported. @param startTime The startTime to set.
• transcript: string
  Maximum Length: 1000
• username: string
  Maximum Length: 64
• workItemIds: array workItemIds
• workRequestId: string
  Maximum Length: 256

{
    "properties":{
        "result":{
            "description":"",
            "type":"AssociatedObj"
        },
        "associatedObjType":{
            "description":"",
            "maxLength":256,
            "type":"string"
        },
        "associatedObjId":{
            "description":"",
            "maxLength":128,
            "type":"string"
        },
        "workRequestId":{
            "description":"",
            "maxLength":256,
            "type":"string"
        },
        "abortedUser":{
            "description":"",
            "maxLength":256,
            "type":"string"
        },
        "endTime":{
            "description":"Read-only and this operation is unsupported. @param endTime Time in milliseconds.",
            "type":"timestamp"
        },
        "jobName":{
            "description":"",
            "maxLength":256,
            "type":"string"
        },
        "progressMessage":{
            "description":"Read-only and this operation is unsupported. @param progressMessage.",
            "maxLength":1024,
            "type":"string"
        },
        "runState":{
            "description":"",
            "enum":[
                "ACTIVE",
                "SUCCEEDED",
                "FAILED",
                "ABORTED"
            ],
            "type":"string"
        },
        "startTime":{
            "description":"Read-only and this operation is unsupported. @param startTime The startTime to set.",
            "type":"timestamp"
        },
        "transcript":{
            "description":"",
            "maxLength":1000,
            "type":"string"
        },
        "username":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "workItemIds":{
            "description":"",
            "type":"array"
        }
    },
    "required":[
        "jobName"
    ],
    "type":"object",
    "description":"A Job represents the unit of work required to perform a particular action or set of actions. The Job Id value represents the time when the Job was created in milliseconds since epoch. This will be a unique value in relation to other Job objects."
}

Nested Schema : workItemIds

Type: array

400 Response

Bad request

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

401 Response

Unauthorized

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

404 Response

Not Found

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

500 Response

Internal Server Error

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

Default Response

An error has occurred

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

Back to Top