Directory Entry Comments

Directory Entry Comments

Returns a list of records with the specified entry_id (public)

Returns a list of records with the specified entry_id

Request
path Parameters
tenantId
required
string

The tenant

directory_service
required
string

The directory_service to use to for record lookup

directory_id
required
string

The directory_id to use to for record lookup

entry_id
required
string

The entry_id to use to for record lookup

query Parameters
fields
string

The fields that you want to retrieve; if omitted, the entire object is returned

exclusiveStartKey
string

If paging, this allows you to return the next set of results

Responses
200The records were retrieved successfully
400The request was not valid.
401Unauthorized.
403Forbidden
404Unable to locate records
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
get/directoryEntryComments/public/{tenantId}/entry/{directory_service}/{directory_id}/{entry_id}
Request samples
curl -i -X GET \
  'https://platform.api.rhythmsoftware.com/directoryEntryComments/public/:tenantId/entry/:directory_service/:directory_id/:entry_id?fields=string&exclusiveStartKey=string'
Response samples
application/json
{
  • "Count": 0,
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Creates a new directory entry comment record that does not already exist.

This method will auto-generate an ID and create a new directory entry comment. If an ID is specified for the directory entry comment, an error will be thrown.

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

Request Body schema: application/json

The directory entry comment that you would like to be saved.

comments
string (Comments)

Comments

Array of objects (Custom Field Values)
date
required
string <date-time> (Date)

The date

directory_id
required
string (Directory)

The ID of the directory to which this comment belongs

directory_service
required
string (Directory Service)

The service of the directory to which this comment belongs

entry_id
required
string (Entry)

The entry that holds the comments

id
required
string (ID) ^[\w:|-]+$

The unique, string identifier of this directory entry comment

rating
number <float> (Rating)

The numeric rating

submitter_id
required
string (Submitter)

The user that submitted the comments

sys_bulk_load_at
string (Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_id
string (Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pk
string (Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_no
number <float> (Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_file
string (Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_error
string (Sys Calculated Field Error)

The error associated with the calculated field

Array of objects
sys_configuration_snapshot_id
string (Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_at
required
string <date-time> (Sys Created At)

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_id
required
string (Sys Created By)

The ID of the user that created this record

sys_deleted_by_id
string (Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directive
string (Sys Directive)

Means for passing directive information into an object processing logic

sys_external_id
string (Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3
boolean (Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_id
string (Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_version
string (Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_at
required
string <date-time> (Sys Last Modified At)

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_id
required
string (Sys Last Modified By)

The ID of the user that last modified this record

sys_last_security_context
object (Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_locked
boolean (Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_version
number <float> (Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_version
number <float> (Sys Version)

A number representing the version of this record in the database

Responses
200The directory entry comment was saved successfully.
400The directory entry comment you supplied was invalid.
401Unauthorized.
403Forbidden.
404The resource could not be found
409The directory entry comment could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to add directory entry comment based on tenant limits.
500General server error.
post/directoryEntryComments/{tenantId}
Request samples
    1 more
    Python
application/json
{
  • "comments": "string",
  • "custom_field_values": [
    ],
  • "date": "2019-08-24T14:15:22Z",
  • "directory_id": "string",
  • "directory_service": "string",
  • "entry_id": "string",
  • "id": "string",
  • "rating": 0,
  • "submitter_id": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_calculated_field_error": "string",
  • "sys_calculated_field_errors": [
    ],
  • "sys_configuration_snapshot_id": "string",
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_deleted_by_id": "string",
  • "sys_directive": "string",
  • "sys_external_id": "string",
  • "sys_has_files_in_s3": true,
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_by_id": "string",
  • "sys_last_security_context": { },
  • "sys_locked": true,
  • "sys_snapshot_base_version": 0,
  • "sys_version": 0
}
Response samples
application/json
{
  • "comments": "string",
  • "custom_field_values": [
    ],
  • "date": "2019-08-24T14:15:22Z",
  • "directory_id": "string",
  • "directory_service": "string",
  • "entry_id": "string",
  • "id": "string",
  • "rating": 0,
  • "submitter_id": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_calculated_field_error": "string",
  • "sys_calculated_field_errors": [
    ],
  • "sys_configuration_snapshot_id": "string",
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_deleted_by_id": "string",
  • "sys_directive": "string",
  • "sys_external_id": "string",
  • "sys_has_files_in_s3": true,
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_by_id": "string",
  • "sys_last_security_context": { },
  • "sys_locked": true,
  • "sys_snapshot_base_version": 0,
  • "sys_version": 0
}

Execute Batch Operations

TAllows you to perform up to 100 parallel patch/delete operations

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

Request Body schema: application/json

The batch request

Array of objects
Responses
200Request completed successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The directory entry comment could not be found.
429Limit exceeded... unable to retrieve directory entry comment based on tenant limits.
500General server error.
post/directoryEntryComments/{tenantId}/batch
Request samples
    1 more
    Python
application/json
{
  • "operations": [
    ]
}
Response samples
application/json
{
  • "error_count": 0,
  • "results": [
    ],
  • "success_count": 0
}

Returns a list of records with the specified directory_id

Returns a list of records with the specified directory_id

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

directory_service
required
string

The directory_service to use to for record lookup

directory_id
required
string

The directory_id to use to for record lookup

query Parameters
fields
string

The fields that you want to retrieve; if omitted, the entire object is returned

exclusiveStartKey
string

If paging, this allows you to return the next set of results

Responses
200The records were retrieved successfully
400The request was not valid.
401Unauthorized.
403Forbidden
404Unable to locate records
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
get/directoryEntryComments/{tenantId}/directory/{directory_service}/{directory_id}
Request samples
curl -i -X GET \
  'https://platform.api.rhythmsoftware.com/directoryEntryComments/:tenantId/directory/:directory_service/:directory_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "Count": 0,
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Returns a list of records with the specified entry_id

Returns a list of records with the specified entry_id

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

directory_service
required
string

The directory_service to use to for record lookup

directory_id
required
string

The directory_id to use to for record lookup

entry_id
required
string

The entry_id to use to for record lookup

query Parameters
fields
string

The fields that you want to retrieve; if omitted, the entire object is returned

exclusiveStartKey
string

If paging, this allows you to return the next set of results

Responses
200The records were retrieved successfully
400The request was not valid.
401Unauthorized.
403Forbidden
404Unable to locate records
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
get/directoryEntryComments/{tenantId}/entry/{directory_service}/{directory_id}/{entry_id}
Request samples
curl -i -X GET \
  'https://platform.api.rhythmsoftware.com/directoryEntryComments/:tenantId/entry/:directory_service/:directory_id/:entry_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "Count": 0,
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Returns a list of records with the specified submitter_id

Returns a list of records with the specified submitter_id

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

submitter_id
required
string

The submitter_id to use to for record lookup

query Parameters
fields
string

The fields that you want to retrieve; if omitted, the entire object is returned

exclusiveStartKey
string

If paging, this allows you to return the next set of results

Responses
200The records were retrieved successfully
400The request was not valid.
401Unauthorized.
403Forbidden
404Unable to locate records
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
get/directoryEntryComments/{tenantId}/submitter/{submitter_id}
Request samples
curl -i -X GET \
  'https://platform.api.rhythmsoftware.com/directoryEntryComments/:tenantId/submitter/:submitter_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "Count": 0,
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Returns a directory entry comment from the system by its ID.

This method will delete a directory entry comment with the specified ID.

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the directory entry comment to delete.

Responses
200The directory entry comment was deleted successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The directory entry comment could not be found.
409The directory entry comment could not be deleted because other objects refers to/depends on this one.
429Limit exceeded... unable to delete directory entry comment based on tenant limits.
500General server error.
delete/directoryEntryComments/{tenantId}/{id}
Request samples
curl -i -X DELETE \
  https://platform.api.rhythmsoftware.com/directoryEntryComments/:tenantId/:id \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
"string"

Returns a directory entry comment from the system by its ID.

This method will look up a directory entry comment by the specified ID and return it back.

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the directory entry comment to return.

query Parameters
fields
string

The fields that you want to retrieve; if omitted, the entire object is returned.

consistentRead
string

Indicates the API should force a consistent read on the data source.

Responses
200The directory entry comment was retrieved successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The directory entry comment could not be found.
429Limit exceeded... unable to retrieve directory entry comment based on tenant limits.
500General server error.
get/directoryEntryComments/{tenantId}/{id}
Request samples
curl -i -X GET \
  'https://platform.api.rhythmsoftware.com/directoryEntryComments/:tenantId/:id?fields=string&consistentRead=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "comments": "string",
  • "custom_field_values": [
    ],
  • "date": "2019-08-24T14:15:22Z",
  • "directory_id": "string",
  • "directory_service": "string",
  • "entry_id": "string",
  • "id": "string",
  • "rating": 0,
  • "submitter_id": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_calculated_field_error": "string",
  • "sys_calculated_field_errors": [
    ],
  • "sys_configuration_snapshot_id": "string",
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_deleted_by_id": "string",
  • "sys_directive": "string",
  • "sys_external_id": "string",
  • "sys_has_files_in_s3": true,
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_by_id": "string",
  • "sys_last_security_context": { },
  • "sys_locked": true,
  • "sys_snapshot_base_version": 0,
  • "sys_version": 0
}

Partially updates a directory entry comment with the specified ID.

This method will patch an existing directory entry comment with the specified ID, using the HTTP PATCH specification.

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the directory entry comment to patch.

Request Body schema: application/json

The patch directives conforming to RFC 6902.

Array
op
required
string (Op)

The operation

Enum: "add" "copy" "move" "remove" "replace" "test"
path
required
string (Path)

The JSON path

value
string (Value)

The updated value

Responses
200The directory entry comment was patched successfully.
400The JSON patch directive you supplied was not valid.
401Unauthorized.
403Forbidden.
404The directory entry comment could not be found.
409The directory entry comment could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve directory entry comment based on tenant limits.
500General server error.
patch/directoryEntryComments/{tenantId}/{id}
Request samples
    1 more
    Python
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "comments": "string",
  • "custom_field_values": [
    ],
  • "date": "2019-08-24T14:15:22Z",
  • "directory_id": "string",
  • "directory_service": "string",
  • "entry_id": "string",
  • "id": "string",
  • "rating": 0,
  • "submitter_id": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_calculated_field_error": "string",
  • "sys_calculated_field_errors": [
    ],
  • "sys_configuration_snapshot_id": "string",
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_deleted_by_id": "string",
  • "sys_directive": "string",
  • "sys_external_id": "string",
  • "sys_has_files_in_s3": true,
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_by_id": "string",
  • "sys_last_security_context": { },
  • "sys_locked": true,
  • "sys_snapshot_base_version": 0,
  • "sys_version": 0
}

Updates a directory entry comment with the specified ID.

This method will update an existing directory entry comment with the specified ID.

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the directory entry comment to update.

Request Body schema: application/json

The updated directory entry comment that will be saved.

comments
string (Comments)

Comments

Array of objects (Custom Field Values)
date
required
string <date-time> (Date)

The date

directory_id
required
string (Directory)

The ID of the directory to which this comment belongs

directory_service
required
string (Directory Service)

The service of the directory to which this comment belongs

entry_id
required
string (Entry)

The entry that holds the comments

id
required
string (ID) ^[\w:|-]+$

The unique, string identifier of this directory entry comment

rating
number <float> (Rating)

The numeric rating

submitter_id
required
string (Submitter)

The user that submitted the comments

sys_bulk_load_at
string (Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_id
string (Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pk
string (Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_no
number <float> (Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_file
string (Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_error
string (Sys Calculated Field Error)

The error associated with the calculated field

Array of objects
sys_configuration_snapshot_id
string (Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_at
required
string <date-time> (Sys Created At)

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_id
required
string (Sys Created By)

The ID of the user that created this record

sys_deleted_by_id
string (Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directive
string (Sys Directive)

Means for passing directive information into an object processing logic

sys_external_id
string (Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3
boolean (Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_id
string (Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_version
string (Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_at
required
string <date-time> (Sys Last Modified At)

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_id
required
string (Sys Last Modified By)

The ID of the user that last modified this record

sys_last_security_context
object (Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_locked
boolean (Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_version
number <float> (Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_version
number <float> (Sys Version)

A number representing the version of this record in the database

Responses
200The directory entry comment was updated successfully.
400The directory entry comment supplied was not valid.
401Unauthorized.
403Forbidden.
404The directory entry comment could not be found.
409The directory entry comment could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve directory entry comment based on tenant limits.
500General server error.
put/directoryEntryComments/{tenantId}/{id}
Request samples
    1 more
    Python
application/json
{
  • "comments": "string",
  • "custom_field_values": [
    ],
  • "date": "2019-08-24T14:15:22Z",
  • "directory_id": "string",
  • "directory_service": "string",
  • "entry_id": "string",
  • "id": "string",
  • "rating": 0,
  • "submitter_id": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_calculated_field_error": "string",
  • "sys_calculated_field_errors": [
    ],
  • "sys_configuration_snapshot_id": "string",
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_deleted_by_id": "string",
  • "sys_directive": "string",
  • "sys_external_id": "string",
  • "sys_has_files_in_s3": true,
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_by_id": "string",
  • "sys_last_security_context": { },
  • "sys_locked": true,
  • "sys_snapshot_base_version": 0,
  • "sys_version": 0
}
Response samples
application/json
{
  • "comments": "string",
  • "custom_field_values": [
    ],
  • "date": "2019-08-24T14:15:22Z",
  • "directory_id": "string",
  • "directory_service": "string",
  • "entry_id": "string",
  • "id": "string",
  • "rating": 0,
  • "submitter_id": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_calculated_field_error": "string",
  • "sys_calculated_field_errors": [
    ],
  • "sys_configuration_snapshot_id": "string",
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_deleted_by_id": "string",
  • "sys_directive": "string",
  • "sys_external_id": "string",
  • "sys_has_files_in_s3": true,
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_by_id": "string",
  • "sys_last_security_context": { },
  • "sys_locked": true,
  • "sys_snapshot_base_version": 0,
  • "sys_version": 0
}