Error
A valid request URL is required to generate request examples{
"profile": {
"defaultChargeCode": "...",
"middleInitial": "...",
"city": "...",
"statusMessage": "...",
"address1": "...",
"sysidLanguage": 12345,
"userEmailPreferences": [
{
"sysidUserEmailPreference": 12345,
"sendEmail": true,
"sysidEmailPreferenceType": 12345
},
{
"sysidUserEmailPreference": 12345,
"sendEmail": true,
"sysidEmailPreferenceType": 12345
}
],
"userId": 12345,
"country": "...",
"myResources": [
{
"sysidResource": 12345,
"sysidMyResources": 12345
},
{
"sysidResource": 12345,
"sysidMyResources": 12345
}
],
"myDelegates": [
{
"sysidUserDelegate": 12345,
"sysidDelegate": 12345
},
{
"sysidUserDelegate": 12345,
"sysidDelegate": 12345
}
],
"address2": "...",
"myPeople": [
{
"sysidPerson": 12345,
"display": true,
"sysidMyPeople": 12345
},
{
"sysidPerson": 12345,
"display": true,
"sysidMyPeople": 12345
}
],
"preferences": [
{
"keyValue": "...",
"sysidUserPreferenceType": 12345,
"sysidUserPreference": 12345
},
{
"keyValue": "...",
"sysidUserPreferenceType": 12345,
"sysidUserPreference": 12345
}
],
"userContacts": [
{
"value": "...",
"sysidUserContacts": 12345,
"sysidContactType": 12345
},
{
"value": "...",
"sysidUserContacts": 12345,
"sysidContactType": 12345
}
],
"sysidDefaultResCategory": 12345,
"sysidDefaultResType": 12345,
"comments": "...",
"privateProfile": true,
"stateProvince": "...",
"postalCode": "...",
"lastName": "...",
"sysidAccount": 12345,
"originalUser": true,
"preferredName": "...",
"firstName": "...",
"userImages": [
{
"sysidUserImage": 12345,
"name": "...",
"width": 12345,
"height": 12345,
"description": "...",
"defaultImage": true,
"displayOrder": 12345,
"thumbnailSource": "...",
"imageSource": "..."
},
{
"sysidUserImage": 12345,
"name": "...",
"width": 12345,
"height": 12345,
"description": "...",
"defaultImage": true,
"displayOrder": 12345,
"thumbnailSource": "...",
"imageSource": "..."
}
],
"calendarURL": "..."
},
"business": {
"gapConflictingWorkspace": true,
"userAttributeValue": [
{
"dateTimeValue": 12345,
"sysidUserAttribute": 12345,
"aqDateTimeValue": {},
"booleanValue": true,
"sysidUserAttributeValue": 12345,
"sysidAttributeDataType": 12345,
"numberValue": 12345,
"stringValue": "..."
},
{
"dateTimeValue": 12345,
"sysidUserAttribute": 12345,
"aqDateTimeValue": {},
"booleanValue": true,
"sysidUserAttributeValue": 12345,
"sysidAttributeDataType": 12345,
"numberValue": 12345,
"stringValue": "..."
}
],
"userAuthRules": [
{
"sysidAuthorizationRule": 12345
},
{
"sysidAuthorizationRule": 12345
}
],
"emailAddress": "...",
"workSpaceLimit": 12345,
"autoBumpFreesLtr": true,
"disableUiLogin": true,
"sysidRole": 12345,
"bumpFreesLtr": true,
"groupMemberships": [
{
"sysidUserGroupMember": 12345,
"sysidUserGroup": 12345
},
{
"sysidUserGroupMember": 12345,
"sysidUserGroup": 12345
}
],
"autoBumpable": true,
"seatAssignment": {
"sysidSeatAssignment": 12345,
"sysidResource": 12345
},
"maxFutureReservationDays": 12345,
"manualBumpable": true,
"reservationSpendingLimit": 12345
},
"account": {
"accountLocked": true,
"sysidManager": 12345,
"sysidDepartment": 12345,
"sysidUserStatus": 12345,
"sysidTitle": 12345,
"emailAddress": "...",
"userPassword": "...",
"sysidDefaultLocation": 12345,
"aqPasswordExpDate": {
"discriminator": "AqDate",
"hour": 12345,
"tzIdValue": "...",
"year": 12345,
"month": 12345,
"dayOfMonth": 12345,
"minute": 12345,
"noEndDate": true
},
"sysidHomeLocation": 12345,
"sysidBusinessUnit": 12345,
"userCredentials": [
{
"value": "...",
"sysidUserCredentials": 12345,
"sysidCredentialsType": 12345
},
{
"value": "...",
"sysidUserCredentials": 12345,
"sysidCredentialsType": 12345
}
],
"forums": [
{
"visited": true,
"sysidForum": 12345
},
{
"visited": true,
"sysidForum": 12345
}
]
}
}UserService
Post userssearch
Retrieves an existing User Data profile as identified by the provided search criteria.
The requesting User must have the following rights to perform this task:
The operation requires a Search User Request value with the following fields:
The operation returns a User Data value.
POST
/
users
/
search
Error
A valid request URL is required to generate request examples{
"profile": {
"defaultChargeCode": "...",
"middleInitial": "...",
"city": "...",
"statusMessage": "...",
"address1": "...",
"sysidLanguage": 12345,
"userEmailPreferences": [
{
"sysidUserEmailPreference": 12345,
"sendEmail": true,
"sysidEmailPreferenceType": 12345
},
{
"sysidUserEmailPreference": 12345,
"sendEmail": true,
"sysidEmailPreferenceType": 12345
}
],
"userId": 12345,
"country": "...",
"myResources": [
{
"sysidResource": 12345,
"sysidMyResources": 12345
},
{
"sysidResource": 12345,
"sysidMyResources": 12345
}
],
"myDelegates": [
{
"sysidUserDelegate": 12345,
"sysidDelegate": 12345
},
{
"sysidUserDelegate": 12345,
"sysidDelegate": 12345
}
],
"address2": "...",
"myPeople": [
{
"sysidPerson": 12345,
"display": true,
"sysidMyPeople": 12345
},
{
"sysidPerson": 12345,
"display": true,
"sysidMyPeople": 12345
}
],
"preferences": [
{
"keyValue": "...",
"sysidUserPreferenceType": 12345,
"sysidUserPreference": 12345
},
{
"keyValue": "...",
"sysidUserPreferenceType": 12345,
"sysidUserPreference": 12345
}
],
"userContacts": [
{
"value": "...",
"sysidUserContacts": 12345,
"sysidContactType": 12345
},
{
"value": "...",
"sysidUserContacts": 12345,
"sysidContactType": 12345
}
],
"sysidDefaultResCategory": 12345,
"sysidDefaultResType": 12345,
"comments": "...",
"privateProfile": true,
"stateProvince": "...",
"postalCode": "...",
"lastName": "...",
"sysidAccount": 12345,
"originalUser": true,
"preferredName": "...",
"firstName": "...",
"userImages": [
{
"sysidUserImage": 12345,
"name": "...",
"width": 12345,
"height": 12345,
"description": "...",
"defaultImage": true,
"displayOrder": 12345,
"thumbnailSource": "...",
"imageSource": "..."
},
{
"sysidUserImage": 12345,
"name": "...",
"width": 12345,
"height": 12345,
"description": "...",
"defaultImage": true,
"displayOrder": 12345,
"thumbnailSource": "...",
"imageSource": "..."
}
],
"calendarURL": "..."
},
"business": {
"gapConflictingWorkspace": true,
"userAttributeValue": [
{
"dateTimeValue": 12345,
"sysidUserAttribute": 12345,
"aqDateTimeValue": {},
"booleanValue": true,
"sysidUserAttributeValue": 12345,
"sysidAttributeDataType": 12345,
"numberValue": 12345,
"stringValue": "..."
},
{
"dateTimeValue": 12345,
"sysidUserAttribute": 12345,
"aqDateTimeValue": {},
"booleanValue": true,
"sysidUserAttributeValue": 12345,
"sysidAttributeDataType": 12345,
"numberValue": 12345,
"stringValue": "..."
}
],
"userAuthRules": [
{
"sysidAuthorizationRule": 12345
},
{
"sysidAuthorizationRule": 12345
}
],
"emailAddress": "...",
"workSpaceLimit": 12345,
"autoBumpFreesLtr": true,
"disableUiLogin": true,
"sysidRole": 12345,
"bumpFreesLtr": true,
"groupMemberships": [
{
"sysidUserGroupMember": 12345,
"sysidUserGroup": 12345
},
{
"sysidUserGroupMember": 12345,
"sysidUserGroup": 12345
}
],
"autoBumpable": true,
"seatAssignment": {
"sysidSeatAssignment": 12345,
"sysidResource": 12345
},
"maxFutureReservationDays": 12345,
"manualBumpable": true,
"reservationSpendingLimit": 12345
},
"account": {
"accountLocked": true,
"sysidManager": 12345,
"sysidDepartment": 12345,
"sysidUserStatus": 12345,
"sysidTitle": 12345,
"emailAddress": "...",
"userPassword": "...",
"sysidDefaultLocation": 12345,
"aqPasswordExpDate": {
"discriminator": "AqDate",
"hour": 12345,
"tzIdValue": "...",
"year": 12345,
"month": 12345,
"dayOfMonth": 12345,
"minute": 12345,
"noEndDate": true
},
"sysidHomeLocation": 12345,
"sysidBusinessUnit": 12345,
"userCredentials": [
{
"value": "...",
"sysidUserCredentials": 12345,
"sysidCredentialsType": 12345
},
{
"value": "...",
"sysidUserCredentials": 12345,
"sysidCredentialsType": 12345
}
],
"forums": [
{
"visited": true,
"sysidForum": 12345
},
{
"visited": true,
"sysidForum": 12345
}
]
}
}Body
application/json
: Object containing User SYSID or Email Address to use for finding the desired User Data element.
Response
201 - application/json
UserData (or Response(AgilquestExceptionData) if there are any Agilquest.com Exceptions)
com.agilquest.phoenix.shared.data.user.UserData
Show child attributes
Show child attributes
Example:
{ "defaultChargeCode": "...", "middleInitial": "...", "city": "...", "statusMessage": "...", "address1": "...", "sysidLanguage": 12345, "userEmailPreferences": [ { "sysidUserEmailPreference": 12345, "sendEmail": true, "sysidEmailPreferenceType": 12345 }, { "sysidUserEmailPreference": 12345, "sendEmail": true, "sysidEmailPreferenceType": 12345 } ], "userId": 12345, "country": "...", "myResources": [ { "sysidResource": 12345, "sysidMyResources": 12345 }, { "sysidResource": 12345, "sysidMyResources": 12345 } ], "myDelegates": [ { "sysidUserDelegate": 12345, "sysidDelegate": 12345 }, { "sysidUserDelegate": 12345, "sysidDelegate": 12345 } ], "address2": "...", "myPeople": [ { "sysidPerson": 12345, "display": true, "sysidMyPeople": 12345 }, { "sysidPerson": 12345, "display": true, "sysidMyPeople": 12345 } ], "preferences": [ { "keyValue": "...", "sysidUserPreferenceType": 12345, "sysidUserPreference": 12345 }, { "keyValue": "...", "sysidUserPreferenceType": 12345, "sysidUserPreference": 12345 } ], "userContacts": [ { "value": "...", "sysidUserContacts": 12345, "sysidContactType": 12345 }, { "value": "...", "sysidUserContacts": 12345, "sysidContactType": 12345 } ], "sysidDefaultResCategory": 12345, "sysidDefaultResType": 12345, "comments": "...", "privateProfile": true, "stateProvince": "...", "postalCode": "...", "lastName": "...", "sysidAccount": 12345, "originalUser": true, "preferredName": "...", "firstName": "...", "userImages": [ { "sysidUserImage": 12345, "name": "...", "width": 12345, "height": 12345, "description": "...", "defaultImage": true, "displayOrder": 12345, "thumbnailSource": "...", "imageSource": "..." }, { "sysidUserImage": 12345, "name": "...", "width": 12345, "height": 12345, "description": "...", "defaultImage": true, "displayOrder": 12345, "thumbnailSource": "...", "imageSource": "..." } ], "calendarURL": "..." }
Show child attributes
Show child attributes
Example:
{ "gapConflictingWorkspace": true, "userAttributeValue": [ { "dateTimeValue": 12345, "sysidUserAttribute": 12345, "aqDateTimeValue": { "discriminator": "AqDate", "hour": 12345, "tzIdValue": "...", "year": 12345, "month": 12345, "dayOfMonth": 12345, "minute": 12345, "noEndDate": true }, "booleanValue": true, "sysidUserAttributeValue": 12345, "sysidAttributeDataType": 12345, "numberValue": 12345, "stringValue": "..." }, { "dateTimeValue": 12345, "sysidUserAttribute": 12345, "aqDateTimeValue": { "discriminator": "AqDate", "hour": 12345, "tzIdValue": "...", "year": 12345, "month": 12345, "dayOfMonth": 12345, "minute": 12345, "noEndDate": true }, "booleanValue": true, "sysidUserAttributeValue": 12345, "sysidAttributeDataType": 12345, "numberValue": 12345, "stringValue": "..." } ], "userAuthRules": [ { "sysidAuthorizationRule": 12345 }, { "sysidAuthorizationRule": 12345 } ], "emailAddress": "...", "workSpaceLimit": 12345, "autoBumpFreesLtr": true, "disableUiLogin": true, "sysidRole": 12345, "bumpFreesLtr": true, "groupMemberships": [ { "sysidUserGroupMember": 12345, "sysidUserGroup": 12345 }, { "sysidUserGroupMember": 12345, "sysidUserGroup": 12345 } ], "autoBumpable": true, "seatAssignment": { "sysidSeatAssignment": 12345, "sysidResource": 12345 }, "maxFutureReservationDays": 12345, "manualBumpable": true, "reservationSpendingLimit": 12345 }
Show child attributes
Show child attributes
Example:
{ "accountLocked": true, "sysidManager": 12345, "sysidDepartment": 12345, "sysidUserStatus": 12345, "sysidTitle": 12345, "emailAddress": "...", "userPassword": "...", "sysidDefaultLocation": 12345, "aqPasswordExpDate": { "discriminator": "AqDate", "hour": 12345, "tzIdValue": "...", "year": 12345, "month": 12345, "dayOfMonth": 12345, "minute": 12345, "noEndDate": true }, "sysidHomeLocation": 12345, "sysidBusinessUnit": 12345, "userCredentials": [ { "value": "...", "sysidUserCredentials": 12345, "sysidCredentialsType": 12345 }, { "value": "...", "sysidUserCredentials": 12345, "sysidCredentialsType": 12345 } ], "forums": [ { "visited": true, "sysidForum": 12345 }, { "visited": true, "sysidForum": 12345 } ] }

