User Profile¶
Get¶
HTTP Request
GET /api/v1/user-profiles/{id}
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
none |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "field": "string",
9 "errorKey": "string",
10 "errorMessage": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "userName": "string",
17 "profileDisplayId": "string",
18 "profileId": 0,
19 "profileName": "string",
20 "vendorSecurityProfileDisplayId": "string",
21 "vendorSecurityProfileId": 0,
22 "vendorSecurityProfileName": "string",
23 "rowNumber": 0,
24 "rowIdentifier": "string",
25 "errors": [
26 "string"
27 ],
28 "linkedErrors": [
29 "string"
30 ],
31 "warnings": [
32 "string"
33 ],
34 "remarks": [
35 "string"
36 ],
37 "skipMessage": "string"
38 }
39}
Update¶
HTTP Request
PUT /api/v1/user-profiles/{id}
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
none |
body |
body |
true |
none |
Body Parameters
1{
2 "id": 0,
3 "userName": "string",
4 "profileDisplayId": "string",
5 "profileId": 0,
6 "profileName": "string",
7 "vendorSecurityProfileDisplayId": "string",
8 "vendorSecurityProfileId": 0,
9 "vendorSecurityProfileName": "string",
10 "rowNumber": 0,
11 "rowIdentifier": "string",
12 "errors": [
13 "string"
14 ],
15 "linkedErrors": [
16 "string"
17 ],
18 "warnings": [
19 "string"
20 ],
21 "remarks": [
22 "string"
23 ],
24 "skipMessage": "string"
25}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "field": "string",
9 "errorKey": "string",
10 "errorMessage": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "userName": "string",
17 "profileDisplayId": "string",
18 "profileId": 0,
19 "profileName": "string",
20 "vendorSecurityProfileDisplayId": "string",
21 "vendorSecurityProfileId": 0,
22 "vendorSecurityProfileName": "string",
23 "rowNumber": 0,
24 "rowIdentifier": "string",
25 "errors": [
26 "string"
27 ],
28 "linkedErrors": [
29 "string"
30 ],
31 "warnings": [
32 "string"
33 ],
34 "remarks": [
35 "string"
36 ],
37 "skipMessage": "string"
38 }
39}
Delete¶
HTTP Request
DELETE /api/v1/user-profiles/{id}
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
none |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "field": "string",
9 "errorKey": "string",
10 "errorMessage": "string"
11 }
12 ]
13 },
14 "object": {}
15}
Create Or Update Bulk¶
HTTP Request
PUT /api/v1/user-profiles/createOrUpdate/bulk
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
none |
Body Parameters
1[
2 {
3 "id": 0,
4 "userName": "string",
5 "profileDisplayId": "string",
6 "profileId": 0,
7 "profileName": "string",
8 "vendorSecurityProfileDisplayId": "string",
9 "vendorSecurityProfileId": 0,
10 "vendorSecurityProfileName": "string",
11 "rowNumber": 0,
12 "rowIdentifier": "string",
13 "errors": [
14 "string"
15 ],
16 "linkedErrors": [
17 "string"
18 ],
19 "warnings": [
20 "string"
21 ],
22 "remarks": [
23 "string"
24 ],
25 "skipMessage": "string"
26 }
27]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "field": "string",
9 "errorKey": "string",
10 "errorMessage": "string"
11 }
12 ]
13 },
14 "object": [
15 {
16 "id": 0,
17 "userName": "string",
18 "profileDisplayId": "string",
19 "profileId": 0,
20 "profileName": "string",
21 "vendorSecurityProfileDisplayId": "string",
22 "vendorSecurityProfileId": 0,
23 "vendorSecurityProfileName": "string",
24 "rowNumber": 0,
25 "rowIdentifier": "string",
26 "errors": [
27 "string"
28 ],
29 "linkedErrors": [
30 "string"
31 ],
32 "warnings": [
33 "string"
34 ],
35 "remarks": [
36 "string"
37 ],
38 "skipMessage": "string"
39 }
40 ]
41}
Create Or Update¶
HTTP Request
PUT /api/v1/user-profiles/createOrUpdate
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
none |
Body Parameters
1{
2 "id": 0,
3 "userName": "string",
4 "profileDisplayId": "string",
5 "profileId": 0,
6 "profileName": "string",
7 "vendorSecurityProfileDisplayId": "string",
8 "vendorSecurityProfileId": 0,
9 "vendorSecurityProfileName": "string",
10 "rowNumber": 0,
11 "rowIdentifier": "string",
12 "errors": [
13 "string"
14 ],
15 "linkedErrors": [
16 "string"
17 ],
18 "warnings": [
19 "string"
20 ],
21 "remarks": [
22 "string"
23 ],
24 "skipMessage": "string"
25}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "field": "string",
9 "errorKey": "string",
10 "errorMessage": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "userName": "string",
17 "profileDisplayId": "string",
18 "profileId": 0,
19 "profileName": "string",
20 "vendorSecurityProfileDisplayId": "string",
21 "vendorSecurityProfileId": 0,
22 "vendorSecurityProfileName": "string",
23 "rowNumber": 0,
24 "rowIdentifier": "string",
25 "errors": [
26 "string"
27 ],
28 "linkedErrors": [
29 "string"
30 ],
31 "warnings": [
32 "string"
33 ],
34 "remarks": [
35 "string"
36 ],
37 "skipMessage": "string"
38 }
39}
Bulk Update¶
HTTP Request
PUT /api/v1/user-profiles/bulk
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
none |
Body Parameters
1[
2 {
3 "id": 0,
4 "userName": "string",
5 "profileDisplayId": "string",
6 "profileId": 0,
7 "profileName": "string",
8 "vendorSecurityProfileDisplayId": "string",
9 "vendorSecurityProfileId": 0,
10 "vendorSecurityProfileName": "string",
11 "rowNumber": 0,
12 "rowIdentifier": "string",
13 "errors": [
14 "string"
15 ],
16 "linkedErrors": [
17 "string"
18 ],
19 "warnings": [
20 "string"
21 ],
22 "remarks": [
23 "string"
24 ],
25 "skipMessage": "string"
26 }
27]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "field": "string",
9 "errorKey": "string",
10 "errorMessage": "string"
11 }
12 ]
13 },
14 "object": [
15 {
16 "id": 0,
17 "userName": "string",
18 "profileDisplayId": "string",
19 "profileId": 0,
20 "profileName": "string",
21 "vendorSecurityProfileDisplayId": "string",
22 "vendorSecurityProfileId": 0,
23 "vendorSecurityProfileName": "string",
24 "rowNumber": 0,
25 "rowIdentifier": "string",
26 "errors": [
27 "string"
28 ],
29 "linkedErrors": [
30 "string"
31 ],
32 "warnings": [
33 "string"
34 ],
35 "remarks": [
36 "string"
37 ],
38 "skipMessage": "string"
39 }
40 ]
41}
Bulk Delete¶
HTTP Request
DELETE /api/v1/user-profiles/bulk
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
array[integer] |
true |
none |
Body Parameters
1[
2 0
3]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "field": "string",
9 "errorKey": "string",
10 "errorMessage": "string"
11 }
12 ]
13 },
14 "object": {}
15}
Search¶
HTTP Request
POST /api/v1/user-profiles/search
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
page |
query |
integer |
false |
Zero-based page index (0..N) |
size |
query |
integer |
false |
The size of the page to be returned |
sort |
query |
array[string] |
false |
Sorting criteria in the format: property,(asc |
body |
body |
false |
none |
Default Values¶
Parameter |
Default |
Type |
|---|---|---|
page |
|
query |
size |
|
query |
sort |
|
query |
Parameter Constraints¶
Parameter |
Constraints |
|---|---|
page |
Min: 0 |
size |
Min: 1 |
Body Parameters
1{
2 "idIn": [
3 0
4 ],
5 "idEqual": 0,
6 "idLike": "string",
7 "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
8 "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
9 "createdByLike": "string",
10 "createdByEqual": "string",
11 "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
12 "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
13 "modifiedByLike": "string",
14 "modifiedByEqual": "string",
15 "profileLike": "string",
16 "userNameLike": "string",
17 "profileDisplayIdLike": "string",
18 "profileNameLike": "string",
19 "vendorSecurityProfileDisplayIdLike": "string",
20 "vendorSecurityProfileNameLike": "string"
21}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalPages": 0,
3 "totalElements": 0,
4 "pageable": {
5 "pageNumber": 0,
6 "pageSize": 0,
7 "unpaged": true,
8 "paged": true,
9 "offset": 0,
10 "sort": {
11 "sorted": true,
12 "unsorted": true,
13 "empty": true
14 }
15 },
16 "numberOfElements": 0,
17 "size": 0,
18 "content": [
19 {
20 "id": 0,
21 "userName": "string",
22 "profileDisplayId": "string",
23 "profileId": 0,
24 "profileName": "string",
25 "vendorSecurityProfileDisplayId": "string",
26 "vendorSecurityProfileId": 0,
27 "vendorSecurityProfileName": "string",
28 "rowNumber": 0,
29 "rowIdentifier": "string",
30 "errors": [
31 "string"
32 ],
33 "linkedErrors": [
34 "string"
35 ],
36 "warnings": [
37 "string"
38 ],
39 "remarks": [
40 "string"
41 ],
42 "skipMessage": "string"
43 }
44 ],
45 "number": 0,
46 "sort": {
47 "sorted": true,
48 "unsorted": true,
49 "empty": true
50 },
51 "first": true,
52 "last": true,
53 "empty": true
54}
Get User Profile¶
HTTP Request
GET /api/v1/user-profiles/username/{userName}
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
userName |
path |
string |
true |
none |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "id": 0,
3 "userName": "string",
4 "profileDisplayId": "string",
5 "profileId": 0,
6 "profileName": "string",
7 "vendorSecurityProfileDisplayId": "string",
8 "vendorSecurityProfileId": 0,
9 "vendorSecurityProfileName": "string",
10 "rowNumber": 0,
11 "rowIdentifier": "string",
12 "errors": [
13 "string"
14 ],
15 "linkedErrors": [
16 "string"
17 ],
18 "warnings": [
19 "string"
20 ],
21 "remarks": [
22 "string"
23 ],
24 "skipMessage": "string"
25}
Find All¶
HTTP Request
GET /api/v1/user-profiles
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
none |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalPages": 0,
3 "totalElements": 0,
4 "pageable": {
5 "pageNumber": 0,
6 "pageSize": 0,
7 "unpaged": true,
8 "paged": true,
9 "offset": 0,
10 "sort": {
11 "sorted": true,
12 "unsorted": true,
13 "empty": true
14 }
15 },
16 "numberOfElements": 0,
17 "size": 0,
18 "content": [
19 {
20 "id": 0,
21 "userName": "string",
22 "profileDisplayId": "string",
23 "profileId": 0,
24 "profileName": "string",
25 "vendorSecurityProfileDisplayId": "string",
26 "vendorSecurityProfileId": 0,
27 "vendorSecurityProfileName": "string",
28 "rowNumber": 0,
29 "rowIdentifier": "string",
30 "errors": [
31 "string"
32 ],
33 "linkedErrors": [
34 "string"
35 ],
36 "warnings": [
37 "string"
38 ],
39 "remarks": [
40 "string"
41 ],
42 "skipMessage": "string"
43 }
44 ],
45 "number": 0,
46 "sort": {
47 "sorted": true,
48 "unsorted": true,
49 "empty": true
50 },
51 "first": true,
52 "last": true,
53 "empty": true
54}