Jump to

• Request
• Response

Create Web User

post

/rest/apis/customer/service/webUsers/

This operation creates a new web user.

Request

There are no request parameters for this operation.

Supported Media Types

• application/xml
• application/json

Request Body - application/xml ()

Root Schema : schema

Type: object

Show Source

• clientWebUserId: string
  Maximum Length: 254

  Client Web User ID

  Example: ClientUser31
• contact: object contact
• person: object person
• status: string
  Maximum Length: 12

  status
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  version

  Example: 1
• webUserActiveInactive: string
  Allowed Values: [ "C1AC", "C1IN" ]

  Web User Status * `C1AC` - Active, * `C1IN` - Inactive

  Example: C1AC
• webUserName: string
  Maximum Length: 254

  Web User Name

  Example: testUser31
• webUserRole: string
  Maximum Length: 254

  Web User Role

  Example: WSSAdminGroup

{
    "type":"object",
    "properties":{
        "webUserName":{
            "type":"string",
            "maxLength":254,
            "description":"Web User Name",
            "example":"testUser31"
        },
        "clientWebUserId":{
            "type":"string",
            "maxLength":254,
            "description":"Client Web User ID",
            "example":"ClientUser31"
        },
        "status":{
            "type":"string",
            "maxLength":12,
            "description":"status"
        },
        "webUserActiveInactive":{
            "type":"string",
            "enum":[
                "C1AC",
                "C1IN"
            ],
            "description":"Web User Status\n* `C1AC` - Active,\n* `C1IN` - Inactive",
            "example":"C1AC"
        },
        "webUserRole":{
            "type":"string",
            "maxLength":254,
            "description":"Web User Role",
            "example":"WSSAdminGroup"
        },
        "person":{
            "type":"object",
            "properties":{
                "personId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Person ID",
                    "example":"8964620166"
                }
            }
        },
        "contact":{
            "type":"object",
            "properties":{
                "contactDetail":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Person Contact"
                }
            }
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"version",
            "example":"1"
        }
    },
    "xml":{
        "name":"C1-WebUser"
    }
}

Nested Schema : contact

Type: object

Show Source

• contactDetail: string
  Maximum Length: 10

  Person Contact

{
    "type":"object",
    "properties":{
        "contactDetail":{
            "type":"string",
            "maxLength":10,
            "description":"Person Contact"
        }
    }
}

Nested Schema : person

Type: object

Show Source

• personId: string
  Maximum Length: 10

  Person ID

  Example: 8964620166

{
    "type":"object",
    "properties":{
        "personId":{
            "type":"string",
            "maxLength":10,
            "description":"Person ID",
            "example":"8964620166"
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• clientWebUserId: string
  Maximum Length: 254

  Client Web User ID

  Example: ClientUser31
• contact: object contact
• person: object person
• status: string
  Maximum Length: 12

  status
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  version

  Example: 1
• webUserActiveInactive: string
  Allowed Values: [ "C1AC", "C1IN" ]

  Web User Status * `C1AC` - Active, * `C1IN` - Inactive

  Example: C1AC
• webUserName: string
  Maximum Length: 254

  Web User Name

  Example: testUser31
• webUserRole: string
  Maximum Length: 254

  Web User Role

  Example: WSSAdminGroup

{
    "type":"object",
    "properties":{
        "webUserName":{
            "type":"string",
            "maxLength":254,
            "description":"Web User Name",
            "example":"testUser31"
        },
        "clientWebUserId":{
            "type":"string",
            "maxLength":254,
            "description":"Client Web User ID",
            "example":"ClientUser31"
        },
        "status":{
            "type":"string",
            "maxLength":12,
            "description":"status"
        },
        "webUserActiveInactive":{
            "type":"string",
            "enum":[
                "C1AC",
                "C1IN"
            ],
            "description":"Web User Status\n* `C1AC` - Active,\n* `C1IN` - Inactive",
            "example":"C1AC"
        },
        "webUserRole":{
            "type":"string",
            "maxLength":254,
            "description":"Web User Role",
            "example":"WSSAdminGroup"
        },
        "person":{
            "type":"object",
            "properties":{
                "personId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Person ID",
                    "example":"8964620166"
                }
            }
        },
        "contact":{
            "type":"object",
            "properties":{
                "contactDetail":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Person Contact"
                }
            }
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"version",
            "example":"1"
        }
    },
    "xml":{
        "name":"C1-WebUser"
    }
}

Nested Schema : contact

Type: object

Show Source

• contactDetail: string
  Maximum Length: 10

  Person Contact

{
    "type":"object",
    "properties":{
        "contactDetail":{
            "type":"string",
            "maxLength":10,
            "description":"Person Contact"
        }
    }
}

Nested Schema : person

Type: object

Show Source

• personId: string
  Maximum Length: 10

  Person ID

  Example: 8964620166

{
    "type":"object",
    "properties":{
        "personId":{
            "type":"string",
            "maxLength":10,
            "description":"Person ID",
            "example":"8964620166"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : C1-WebUser

Type: object

Show Source

• _self: string
  _self
• clientWebUserId: string
  Maximum Length: 254

  Client Web User ID

  Example: ClientUser31
• contact: object contact
• person: object person
• status: string
  Maximum Length: 12

  status
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  version

  Example: 1
• webUserActiveInactive: string
  Allowed Values: [ "C1AC", "C1IN" ]

  Web User Status * `C1AC` - Active, * `C1IN` - Inactive

  Example: C1AC
• webUserName: string
  Maximum Length: 254

  Web User Name

  Example: testUser31
• webUserRole: string
  Maximum Length: 254

  Web User Role

  Example: WSSAdminGroup

{
    "type":"object",
    "properties":{
        "_self":{
            "type":"string",
            "description":"_self"
        },
        "webUserName":{
            "type":"string",
            "maxLength":254,
            "description":"Web User Name",
            "example":"testUser31"
        },
        "clientWebUserId":{
            "type":"string",
            "maxLength":254,
            "description":"Client Web User ID",
            "example":"ClientUser31"
        },
        "status":{
            "type":"string",
            "maxLength":12,
            "description":"status"
        },
        "webUserActiveInactive":{
            "type":"string",
            "enum":[
                "C1AC",
                "C1IN"
            ],
            "description":"Web User Status\n* `C1AC` - Active,\n* `C1IN` - Inactive",
            "example":"C1AC"
        },
        "webUserRole":{
            "type":"string",
            "maxLength":254,
            "description":"Web User Role",
            "example":"WSSAdminGroup"
        },
        "person":{
            "type":"object",
            "properties":{
                "personId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Person ID",
                    "example":"8964620166"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "contact":{
            "type":"object",
            "properties":{
                "contactDetail":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Person Contact"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"version",
            "example":"1"
        }
    },
    "xml":{
        "name":"C1-WebUser"
    }
}

Nested Schema : contact

Type: object

Show Source

• _link: string
  _link
• contactDetail: string
  Maximum Length: 10

  Person Contact

{
    "type":"object",
    "properties":{
        "contactDetail":{
            "type":"string",
            "maxLength":10,
            "description":"Person Contact"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : person

Type: object

Show Source

• _link: string
  _link
• personId: string
  Maximum Length: 10

  Person ID

  Example: 8964620166

{
    "type":"object",
    "properties":{
        "personId":{
            "type":"string",
            "maxLength":10,
            "description":"Person ID",
            "example":"8964620166"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

400 Response

Bad Request

Body ()

Root Schema : problemDetailDocument

Type: object

Show Source

• detail: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• httpStatus: number
  Minimum Value: 0

  Maximum Value: 9999

  The HTTP Status code for the error.
• problemInstance: string
  Maximum Length: 60

  Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction.
• problemType: string
  Maximum Length: 60

  URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework.
• serverMessage: object serverMessage
• stackTrace: string
  Maximum Length: 60

  The stack trace shows where the error occurs during the execution of a program.
• title: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":60,
            "description":"URL of the format \"A/message/X/Y\" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework."
        },
        "title":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":9999,
            "minimum":0,
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":60,
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":0,
                    "minimum":0,
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

• callSequence: string
  Maximum Length: 60

  Delimited sequence of programs called.
• longDescription: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• messageCategory: number
  Minimum Value: 0

  Maximum Value: 0

  Message Category within Oracle Utilities Application Framework.
• messageNbr: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message Number within Oracle Utilities Application Framework.
• messageText: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
• programName: string
  Maximum Length: 60

  Name of the program that encountered the error.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":0,
            "minimum":0,
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":60,
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":60,
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}

500 Response

Internal Server Error

Body ()

Root Schema : problemDetailDocument

Type: object

Show Source

• detail: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• httpStatus: number
  Minimum Value: 0

  Maximum Value: 9999

  The HTTP Status code for the error.
• problemInstance: string
  Maximum Length: 60

  Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction.
• problemType: string
  Maximum Length: 60

  URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework.
• serverMessage: object serverMessage
• stackTrace: string
  Maximum Length: 60

  The stack trace shows where the error occurs during the execution of a program.
• title: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":60,
            "description":"URL of the format \"A/message/X/Y\" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework."
        },
        "title":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":9999,
            "minimum":0,
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":60,
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":0,
                    "minimum":0,
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

• callSequence: string
  Maximum Length: 60

  Delimited sequence of programs called.
• longDescription: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• messageCategory: number
  Minimum Value: 0

  Maximum Value: 0

  Message Category within Oracle Utilities Application Framework.
• messageNbr: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message Number within Oracle Utilities Application Framework.
• messageText: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
• programName: string
  Maximum Length: 60

  Name of the program that encountered the error.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":0,
            "minimum":0,
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":60,
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":60,
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}

Back to Top