Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
themeEclipse
titleUser - 10000
{
	"userAttributes": [
	{
	    "fdUserAttributeId": 10001,
        "userId": 10000,
        "fdUserAttrDefId": 11478,
        "attributeValue": "true"
	},
	{
		"fdUserAttributeId": 10002,
        "userId": 10000,
        "fdUserAttrDefId": 11479,
        "attributeValue": "true"
	},
	{
		"fdUserAttributeId": 10003,
        "userId": 10000,
        "fdUserAttrDefId": 11490,
        "attributeValue": "true"
	},
	{
		"fdUserAttributeId": 10004,
        "userId": 10000,
        "fdUserAttrDefId": 11491,
        "attributeValue": "true"
	},
	{
		"fdUserAttributeId": 10005,
        "userId": 10000,
        "fdUserAttrDefId": 11492,
        "attributeValue": "true"
	},
	{
		"fdUserAttributeId": 10006,
        "userId": 10000,
        "fdUserAttrDefId": 11493,
        "attributeValue": "true"
	},
	{
		"fdUserAttributeId": 10007,
        "userId": 10000,
        "fdUserAttrDefId": 11494,
        "attributeValue": null
	}
	],
	"userId": 10000,
	"userName": "username",
	"password": "password",
	"userGroups": [],
	"isActive": true,
	"email": "email@company.com",
	"lastName": "Last",
	"firstName": "First",
	"localUser": true,
    "updatedBy": "fdadmin",
    "createdOn": "2021-09-01T17:23:18.288+0000",
    "updatedOn": "2021-09-01T17:23:18.288+0000",
    "versionNumber": 1,
    "createdBy": "fdadmin"
}

When we run a GET request at the following URL

...

Code Block
themeEclipse
titleUser - 10000
{
	"userAttributes": [
	{
	    "fdUserAttributeId": 10001,
        "userId": 10000,
        "fdUserAttrDefId": 11478,
        "attributeValue": "true"
	},
	{
		"fdUserAttributeId": 10002,
        "userId": 10000,
        "fdUserAttrDefId": 11479,
        "attributeValue": "true"
	},
	{
		"fdUserAttributeId": 10003,
        "userId": 10000,
        "fdUserAttrDefId": 11490,
        "attributeValue": "true"
	},
	{
		"fdUserAttributeId": 10004,
        "userId": 10000,
        "fdUserAttrDefId": 11491,
        "attributeValue": "true"
	},
	{
		"fdUserAttributeId": 10005,
        "userId": 10000,
        "fdUserAttrDefId": 11492,
        "attributeValue": "true"
	},
	{
		"fdUserAttributeId": 10006,
        "userId": 10000,
        "fdUserAttrDefId": 11493,
        "attributeValue": "true"
	},
	{
		"fdUserAttributeId": 10007,
        "userId": 10000,
        "fdUserAttrDefId": 11494,
        "attributeValue": null
	}
	],
	"userId": 10000,
	"userName": "username",
	"password": "*****",
	"userGroups": [],
	"isActive": true,
	"email": "email@company.com",
	"lastName": "Last",
	"firstName": "First",
	"localUser": true": true,
    "updatedBy": "fdadmin",
    "createdOn": "2021-09-01T17:23:18.288+0000",
    "updatedOn": "2021-09-01T17:23:18.288+0000",
    "versionNumber": 1,
    "createdBy": "fdadmin"
}

GET (Using Query Parameters)

...

Code Block
themeEclipse
titleUser - 10000
{
	"userAttributes": [
	{
	    "fdUserAttributeId": 10001,
        "userId": 10000,
        "fdUserAttrDefId": 11478,
        "attributeValue": "true"
	},
	{
		"fdUserAttributeId": 10002,
        "userId": 10000,
        "fdUserAttrDefId": 11479,
        "attributeValue": "true"
	},
	{
		"fdUserAttributeId": 10003,
        "userId": 10000,
        "fdUserAttrDefId": 11490,
        "attributeValue": "true"
	},
	{
		"fdUserAttributeId": 10004,
        "userId": 10000,
        "fdUserAttrDefId": 11491,
        "attributeValue": "true"
	},
	{
		"fdUserAttributeId": 10005,
        "userId": 10000,
        "fdUserAttrDefId": 11492,
        "attributeValue": "true"
	},
	{
		"fdUserAttributeId": 10006,
        "userId": 10000,
        "fdUserAttrDefId": 11493,
        "attributeValue": "true"
	},
	{
		"fdUserAttributeId": 10007,
        "userId": 10000,
        "fdUserAttrDefId": 11494,
        "attributeValue": null
	}
	],
	"userId": 10000,
	"userName": "username",
	"password": "password",
	"userGroups": [],
	"isActive": true,
	"email": "employee@company.com",
	"lastName": "Last",
	"firstName": "First",
	"localUser": true,
    "updatedBy": "fdadmin",
    "createdOn": "2021-09-01T17:23:18.288+0000",
    "updatedOn": "2021-09-01T17:23: true18.288+0000",
    "versionNumber": 1,
    "createdBy": "fdadmin"
}

When we run a GET request at the following URL

...

Code Block
themeEclipse
titleUser - 10000
[
{
	"userAttributes": [
	{
	    "fdUserAttributeId": 10001,
        "userId": 10000,
        "fdUserAttrDefId": 11478,
        "attributeValue": "true"
	},
	{
		"fdUserAttributeId": 10002,
        "userId": 10000,
        "fdUserAttrDefId": 11479,
        "attributeValue": "true"
	},
	{
		"fdUserAttributeId": 10003,
        "userId": 10000,
        "fdUserAttrDefId": 11490,
        "attributeValue": "true"
	},
	{
		"fdUserAttributeId": 10004,
        "userId": 10000,
        "fdUserAttrDefId": 11491,
        "attributeValue": "true"
	},
	{
		"fdUserAttributeId": 10005,
        "userId": 10000,
        "fdUserAttrDefId": 11492,
        "attributeValue": "true"
	},
	{
		"fdUserAttributeId": 10006,
        "userId": 10000,
        "fdUserAttrDefId": 11493,
        "attributeValue": "true"
	},
	{
		"fdUserAttributeId": 10007,
        "userId": 10000,
        "fdUserAttrDefId": 11494,
        "attributeValue": null
	}
	],
	"userId": 10000,
	"userName": "username",
	"password": "*****",
	"userGroups": [],
	"isActive": true,
	"email": "employee@company.com",
	"lastName": "Last",
	"firstName": "First",
	"localUser": true,
    "updatedBy": "fdadmin",
    "createdOn": "2021-09-01T17:23:18.288+0000",
    "updatedOn": "2021-09-01T17:23: true18.288+0000",
    "versionNumber": 1,
    "createdBy": "fdadmin"
}
]

POST

This POST service will create a new user with the same attributes as the given JSON object.

...

Code Block
themeEclipse
titleUser - 10000
{
	"userAttributes": [
	{
	    "fdUserAttributeId": 10001,
        "userId": 10000,
        "fdUserAttrDefId": 11478,
        "attributeValue": "true"
	},
	{
		"fdUserAttributeId": 10002,
        "userId": 10000,
        "fdUserAttrDefId": 11479,
        "attributeValue": "true"
	},
	{
		"fdUserAttributeId": 10003,
        "userId": 10000,
        "fdUserAttrDefId": 11490,
        "attributeValue": "true"
	},
	{
		"fdUserAttributeId": 10004,
        "userId": 10000,
        "fdUserAttrDefId": 11491,
        "attributeValue": "true"
	},
	{
		"fdUserAttributeId": 10005,
        "userId": 10000,
        "fdUserAttrDefId": 11492,
        "attributeValue": "true"
	},
	{
		"fdUserAttributeId": 10006,
        "userId": 10000,
        "fdUserAttrDefId": 11493,
        "attributeValue": "true"
	},
	{
		"fdUserAttributeId": 10007,
        "userId": 10000,
        "fdUserAttrDefId": 11494,
        "attributeValue": null
	}
	],
	"userId": 10000,
	"userName": "username",
	"password": "*****",
	"userGroups": 
	[
	{
		"groupId": 11001
		"userId": 10000
	},
	{
		"groupId": 11002
		"userId": 10000
	}
	],
	"isActive": true,
	"email": "email@company.com",
	"lastName": "Last",
	"firstName": "First",
	"localUser": true,
    "updatedBy": "fdadmin",
    "createdOn": "2021-09-01T17:23:18.288+0000",
    "updatedOn": "2021-09-01T17:23: true18.288+0000",
    "versionNumber": 1,
    "createdBy": "fdadmin"
}

Example without Groups

If the POST request receives the following JSON user object,

...

Code Block
themeEclipse
titleUser - 10000
{
	"userAttributes": [
	{
	    "fdUserAttributeId": 10001,
        "userId": 10000,
        "fdUserAttrDefId": 11478,
        "attributeValue": "true"
	},
	{
		"fdUserAttributeId": 10002,
        "userId": 10000,
        "fdUserAttrDefId": 11479,
        "attributeValue": "true"
	},
	{
		"fdUserAttributeId": 10003,
        "userId": 10000,
        "fdUserAttrDefId": 11490,
        "attributeValue": "true"
	},
	{
		"fdUserAttributeId": 10004,
        "userId": 10000,
        "fdUserAttrDefId": 11491,
        "attributeValue": "true"
	},
	{
		"fdUserAttributeId": 10005,
        "userId": 10000,
        "fdUserAttrDefId": 11492,
        "attributeValue": "true"
	},
	{
		"fdUserAttributeId": 10006,
        "userId": 10000,
        "fdUserAttrDefId": 11493,
        "attributeValue": "true"
	},
	{
		"fdUserAttributeId": 10007,
        "userId": 10000,
        "fdUserAttrDefId": 11494,
        "attributeValue": null
	}
	],
	"userId": 10000,
	"userName": "username",
	"password": "*****",
	"userGroups": [],
	"isActive": true,
	"email": "email@company.com",
	"lastName": "Last",
	"firstName": "First",
	"localUser": true,
    "updatedBy": "fdadmin",
    "createdOn": "2021-09-01T17:23:18.288+0000",
    "updatedOn": "2021-09-01T17:23: true18.288+0000",
    "versionNumber": 1,
    "createdBy": "fdadmin"
}

PUT

This PUT service will update all attributes of a user with the given Id based on the attributes of a JSON object parameters. Attributes that are not provided will become their default values.

...

Code Block
themeEclipse
titleUser - 10000
{
	"userAttributes": [
	{
	    "fdUserAttributeId": 10001,
        "userId": 10000,
        "fdUserAttrDefId": 11478,
        "attributeValue": "true"
	},
	{
		"fdUserAttributeId": 10002,
        "userId": 10000,
        "fdUserAttrDefId": 11479,
        "attributeValue": "true"
	},
	{
		"fdUserAttributeId": 10003,
        "userId": 10000,
        "fdUserAttrDefId": 11490,
        "attributeValue": "true"
	},
	{
		"fdUserAttributeId": 10004,
        "userId": 10000,
        "fdUserAttrDefId": 11491,
        "attributeValue": "true"
	},
	{
		"fdUserAttributeId": 10005,
        "userId": 10000,
        "fdUserAttrDefId": 11492,
        "attributeValue": "true"
	},
	{
		"fdUserAttributeId": 10006,
        "userId": 10000,
        "fdUserAttrDefId": 11493,
        "attributeValue": "true"
	},
	{
		"fdUserAttributeId": 10007,
        "userId": 10000,
        "fdUserAttrDefId": 11494,
        "attributeValue": null
	}
	],
	"userId": 10000,
	"userName": "username",
	"password": "password",
	"userGroups": [
	{
		"groupId": 11001
		"userId": 10000
	}
	],
	"isActive": true,
	"email": "email@company.com",
	"lastName": "Last",
	"firstName": "First",
	"localUser": true,
    "updatedBy": "fdadmin",
    "createdOn": "2021-09-01T17:23:18.288+0000",
    "updatedOn": "2021-09-01T17:23: true18.288+0000",
    "versionNumber": 1,
    "createdBy": "fdadmin"
}

When we run a PUT request at the following URL

...

Code Block
themeEclipse
titleUser - 10000
{
	"userAttributes": [
	{
	    "fdUserAttributeId": 10001,
        "userId": 10000,
        "fdUserAttrDefId": 11478,
        "attributeValue": "false"
	},
	{
		"fdUserAttributeId": 10002,
        "userId": 10000,
        "fdUserAttrDefId": 11479,
        "attributeValue": "true"
	},
	{
		"fdUserAttributeId": 10003,
        "userId": 10000,
        "fdUserAttrDefId": 11490,
        "attributeValue": "true"
	},
	{
		"fdUserAttributeId": 10004,
        "userId": 10000,
        "fdUserAttrDefId": 11491,
        "attributeValue": "true"
	},
	{
		"fdUserAttributeId": 10005,
        "userId": 10000,
        "fdUserAttrDefId": 11492,
        "attributeValue": "true"
	},
	{
		"fdUserAttributeId": 10006,
        "userId": 10000,
        "fdUserAttrDefId": 11493,
        "attributeValue": "true"
	},
	{
		"fdUserAttributeId": 10007,
        "userId": 10000,
        "fdUserAttrDefId": 11494,
        "attributeValue": null
	}
	],
	"userId": 10000,
	"userName": "newusername",
	"password": "*****",
	"userGroups": [
	{
		"groupId": 11002
		"userId": 10000
	}
	],
	"isActive": true,
	"email": "newemail@company.com",
	"lastName": "Lastname",
	"firstName": "Firstname",
	"localUser": true,
    "updatedBy": "fdadmin",
    "createdOn": "2021-09-01T17:23:18.288+0000",
    "updatedOn": "2021-09-10T06:32: true19.147+0000",
    "versionNumber": 2,
    "createdBy": "fdadmin"
}

PATCH

This PATCH service will update an existing user with the information passed through a JSON object. If an attribute of the JSON is null it will not be updated in the user. Groups that are included in a PATCH will be added, but existing groups will still remain.

...

Code Block
themeEclipse
titleUser - 10000
{
	"userAttributes": [
	{
	    "fdUserAttributeId": 10001,
        "userId": 10000,
        "fdUserAttrDefId": 11478,
        "attributeValue": "true"
	},
	{
		"fdUserAttributeId": 10002,
        "userId": 10000,
        "fdUserAttrDefId": 11479,
        "attributeValue": "true"
	},
	{
		"fdUserAttributeId": 10003,
        "userId": 10000,
        "fdUserAttrDefId": 11490,
        "attributeValue": "true"
	},
	{
		"fdUserAttributeId": 10004,
        "userId": 10000,
        "fdUserAttrDefId": 11491,
        "attributeValue": "true"
	},
	{
		"fdUserAttributeId": 10005,
        "userId": 10000,
        "fdUserAttrDefId": 11492,
        "attributeValue": "true"
	},
	{
		"fdUserAttributeId": 10006,
        "userId": 10000,
        "fdUserAttrDefId": 11493,
        "attributeValue": "true"
	},
	{
		"fdUserAttributeId": 10007,
        "userId": 10000,
        "fdUserAttrDefId": 11494,
        "attributeValue": null
	}
	],
	"userId": 10000,
	"userName": "username",
	"password": "password",
	"userGroups": [
	{
		"groupId": 11001
		"userId": 10000
	}
	],
	"isActive": true,
	"email": "email@company.com",
	"lastName": "Last",
	"firstName": "First",
	"localUser": true,
    "updatedBy": "fdadmin",
    "createdOn": "2021-09-01T17:23:18.288+0000",
    "updatedOn": "2021-09-01T17:23: true18.288+0000",
    "versionNumber": 1,
    "createdBy": "fdadmin"
}

When we run a PATCH request at the following URL

...

Code Block
themeEclipse
titleUser - 10000
{
	"userAttributes": [
	{
	    "fdUserAttributeId": 10001,
        "userId": 10000,
        "fdUserAttrDefId": 11478,
        "attributeValue": "false"
	},
	{
		"fdUserAttributeId": 10002,
        "userId": 10000,
        "fdUserAttrDefId": 11479,
        "attributeValue": "true"
	},
	{
		"fdUserAttributeId": 10003,
        "userId": 10000,
        "fdUserAttrDefId": 11490,
        "attributeValue": "true"
	},
	{
		"fdUserAttributeId": 10004,
        "userId": 10000,
        "fdUserAttrDefId": 11491,
        "attributeValue": "true"
	},
	{
		"fdUserAttributeId": 10005,
        "userId": 10000,
        "fdUserAttrDefId": 11492,
        "attributeValue": "true"
	},
	{
		"fdUserAttributeId": 10006,
        "userId": 10000,
        "fdUserAttrDefId": 11493,
        "attributeValue": "true"
	},
	{
		"fdUserAttributeId": 10007,
        "userId": 10000,
        "fdUserAttrDefId": 11494,
        "attributeValue": null
	}
	],
	"userId": 10000,
	"userName": "username",
	"password": "*****",
	"userGroups": [
	{
		"groupId": 11001
		"userId": 10000
	},
	{
		"groupId": 11002
		"userId": 10000
	}
	],
	"isActive": true,
	"email": "email@company.com",
	"lastName": "Last",
	"firstName": "First",
	"localUser": true,
    "updatedBy": "fdadmin",
    "createdOn": "2021-09-01T17:23:18.288+0000",
    "updatedOn": "2021-09-10T06:32:19.147+0000",
    "versionNumber": 2,
    "createdBy": "fdadmin"
}