Endpoint
/api/v2/tenants/{tenantId}/notes
Path Parameters
tenantId
string

Describes the clientId or mspId of the tenant

createdBy
object

createdBy.address
(Optional) User address.
createdBy.altEmail
createdBy.authType
createdBy.changePassword
createdBy.city
(Optional) City name.
createdBy.country
Country name. To get the list of countries, use Get Countries API.
createdBy.createdTime
createdBy.designation
(Optional) User designation.
createdBy.email
Email of the user. (Alert and report notifications are sent to the email address.)
createdBy.firstName
User first name.
createdBy.id
createdBy.lastName
User last name
createdBy.loginName
User login name.
createdBy.mobileNumber
(Optional) User mobile number.
createdBy.orgId
createdBy.organizationName
createdBy.password
Password must have a minimum of 7 characters with at least: - One number (0-9) - One special character (#,!, $,*) - One lowercase (a-z) - One uppercase (A-Z) character
createdBy.phoneNumber
(Optional) User phone number.
createdBy.profileImage
createdBy.roles
(Optional) Defines permission sets to user and user groups on devices and device groups. Assign roles to a user. See Search Roles API to get roles created under a partner or client.
createdBy.state
(Optional) State name.
createdBy.status
createdBy.timeZone
Time zone of the country. Use the Get Timezones API to get the list of timezones. Example: "timeZone": { "code": "EST"}
createdBy.updatedTime
createdBy.userAccountType
(Optional) User account type: - REGULAR - BUSINESS
createdBy.userGroupType
(Optional) Assign users to all user groups, or specific users groups. A user can also be an individual user, NOT being part of any user group. Supported Values: ALL, NONE - If a user should be part of all user groups, provide userGroupType: ALL - If a user should be part of a specific user group, provide user group name. Example:"userGroups": [{ "name": "Luminalto Admins" }] - If a user should NOT be part of any user group, provide userGroupType: NONE
createdBy.userGroups
(Optional) Assign users to specific user groups. Provide name of the user group.Use Search User Groups API to get details of user groups.
createdBy.userNotifications
(Optional) Email to which the alert and report notifications are sent.
createdBy.zip
(Optional) Zip code.
createdTime
string

description
string

Summary describing the note.

expiryDateType
integer

Type of expiry. If expiryDateType is set as 1, it indicates Never Expire. If expiryDateType is set as 2, it indicates Validity period.

expiryTime
string

Date and time on which the note expires. This field is mandatory if expiryDateType is set as 2.

id
integer

startTime
string

Date and time from which the note is valid. This is applicable only if expiryDateType is set as 2.

subject
string

Subject of note.

updatedTime
string

{
  "description": "This client is using for Rest applications",
  "expiryDateType": 1,
  "subject": "Rest Applications Client"
}
{
  "description": "This client is using for Rest applications",
  "expiryDateType": 2,
  "expiryTime": "2016-09-30T05:57:32+0000",
  "startTime": "2016-09-08T05:57:32+0000",
  "subject": "Rest Applications Client"
}

Responses

OK

createdBy
object

createdBy.address
(Optional) User address.
createdBy.altEmail
createdBy.authType
createdBy.changePassword
createdBy.city
(Optional) City name.
createdBy.country
Country name. To get the list of countries, use Get Countries API.
createdBy.createdTime
createdBy.designation
(Optional) User designation.
createdBy.email
Email of the user. (Alert and report notifications are sent to the email address.)
createdBy.firstName
User first name.
createdBy.id
createdBy.lastName
User last name
createdBy.loginName
User login name.
createdBy.mobileNumber
(Optional) User mobile number.
createdBy.orgId
createdBy.organizationName
createdBy.password
Password must have a minimum of 7 characters with at least: - One number (0-9) - One special character (#,!, $,*) - One lowercase (a-z) - One uppercase (A-Z) character
createdBy.phoneNumber
(Optional) User phone number.
createdBy.profileImage
createdBy.roles
(Optional) Defines permission sets to user and user groups on devices and device groups. Assign roles to a user. See Search Roles API to get roles created under a partner or client.
createdBy.state
(Optional) State name.
createdBy.status
createdBy.timeZone
Time zone of the country. Use the Get Timezones API to get the list of timezones. Example: "timeZone": { "code": "EST"}
createdBy.updatedTime
createdBy.userAccountType
(Optional) User account type: - REGULAR - BUSINESS
createdBy.userGroupType
(Optional) Assign users to all user groups, or specific users groups. A user can also be an individual user, NOT being part of any user group. Supported Values: ALL, NONE - If a user should be part of all user groups, provide userGroupType: ALL - If a user should be part of a specific user group, provide user group name. Example:"userGroups": [{ "name": "Luminalto Admins" }] - If a user should NOT be part of any user group, provide userGroupType: NONE
createdBy.userGroups
(Optional) Assign users to specific user groups. Provide name of the user group.Use Search User Groups API to get details of user groups.
createdBy.userNotifications
(Optional) Email to which the alert and report notifications are sent.
createdBy.zip
(Optional) Zip code.
createdTime
string

description
string

Summary describing the note.

expiryDateType
integer

Type of expiry. If expiryDateType is set as 1, it indicates Never Expire. If expiryDateType is set as 2, it indicates Validity period.

expiryTime
string

Date and time on which the note expires. This field is mandatory if expiryDateType is set as 2.

id
integer

startTime
string

Date and time from which the note is valid. This is applicable only if expiryDateType is set as 2.

subject
string

Subject of note.

updatedTime
string

{
  "createdBy": {
    "email": "john.smith@gmail.com",
    "firstName": "John",
    "lastName": "Smith",
    "loginName": "john.smith"
  },
  "createdTime": "2016-09-09T05:57:32+0000",
  "description": "This client is using for Rest applications",
  "expiryTime": "",
  "id": 17,
  "startTime": "",
  "subject": "Rest Applications Client",
  "updatedTime": "2016-09-09T05:57:32+0000"
}