Endpoint
/api/v2/tenants/{tenantId}/notes/{noteId}/Deletes a client note and deletes notes from the resource-level.
Path Parameters
tenantIdstring
noteIdstring
Responses
OK
Endpoint
/api/v2/tenants/{tenantId}/notes/{noteId}/Gets client note details.
Path Parameters
tenantIdstring
noteIdstring
Responses
OK
createdByobject
Child Parameters
- 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.
createdTimestring
descriptionstring
Summary describing the note.
expiryDateTypeinteger
Type of expiry. If expiryDateType is set as 1, it indicates Never Expire. If expiryDateType is set as 2, it indicates Validity period.
expiryTimestring
Date and time on which the note expires. This field is mandatory if expiryDateType is set as 2.
idinteger
startTimestring
Date and time from which the note is valid. This is applicable only if expiryDateType is set as 2.
subjectstring
Subject of note.
updatedTimestring
{
"createdBy": {
"changePassword": false,
"email": "john.smith@gmail.com",
"firstName": "John",
"id": "USR0000002095",
"lastName": "Smith",
"loginName": "John.Smith"
},
"createdTime": "2016-03-21T12:02:11+0000",
"description": "The Device is for auditing purpose only-updated",
"expiryTime": "2016-04-26T15:40:10+0000",
"id": 50,
"startTime": "2016-03-26T15:40:10+0000",
"subject": "Device created for maintain logs-updated",
"updatedTime": "2016-03-21T12:06:26+0000"
}Endpoint
/api/v2/tenants/{tenantId}/notes/{noteId}/Updates client note details.
Path Parameters
tenantIdstring
noteIdstring
createdByobject
Child Parameters
- 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.
createdTimestring
descriptionstring
Summary describing the note.
expiryDateTypeinteger
Type of expiry. If expiryDateType is set as 1, it indicates Never Expire. If expiryDateType is set as 2, it indicates Validity period.
expiryTimestring
Date and time on which the note expires. This field is mandatory if expiryDateType is set as 2.
idinteger
startTimestring
Date and time from which the note is valid. This is applicable only if expiryDateType is set as 2.
subjectstring
Subject of note.
updatedTimestring
{
"description": "This client is using for Rest applications",
"subject": "Rest Applications Client"
}{
"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
createdByobject
Child Parameters
- 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.
createdTimestring
descriptionstring
Summary describing the note.
expiryDateTypeinteger
Type of expiry. If expiryDateType is set as 1, it indicates Never Expire. If expiryDateType is set as 2, it indicates Validity period.
expiryTimestring
Date and time on which the note expires. This field is mandatory if expiryDateType is set as 2.
idinteger
startTimestring
Date and time from which the note is valid. This is applicable only if expiryDateType is set as 2.
subjectstring
Subject of note.
updatedTimestring
{
"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": "2016-09-14T00:00:00+0000",
"id": 17,
"startTime": "2016-09-08T00:00:00+0000",
"subject": "Rest Applications Client",
"updatedTime": "2016-09-09T06:19:01+0000"
}