The CdmEditorApi provides endpoints that enable you to create nodes, update nodes, include existing nodes under other nodes, delete nodes, and retrieve nodes and node includes.

You must have one of the following roles to access this API:
  • Scripted REST CDM View ACL (sn_cdm.cdm.viewer)
  • Scripted REST CDM Editor ACL (sn_cdm.cdm_editor)

To view fields that have been encrypted, you must have the CDM Secret role.

In addition, the Configuration Data Management (CDM) plugin must be activated for this API to be available in an instance.

Note: The CdmEditorApi API cannot be used to modify any files. Only file deletion is allowed currently.

CdmEditorApi - DELETE /sn_cdm/editor/nodes

Deletes a specified node.

The caller of this endpoint must have the CDM Editor role.

URL format

Versioned URL: /api/sn_cdm/{api_version}/editor/nodes

Default URL: /api/sn_cdm/editor/nodes

Note: Available versions are specified in the REST API Explorer. For scripted REST APIs there is additional version information on the Scripted REST Service form.

Supported request parameters

Table 1. Path parameters
Name Description
api_version Optional. Version of the endpoint to access. For example, v1 or v2. Only specify this value to use an endpoint version other than the latest.

Data type: String
Table 2. Query parameters
Name Description
changesetNumber Required.
Unique identifier of the associated changeset, such as "Chset-10".

Data type: String

Table: CDM Changeset [sn_cdm_changeset]
fullNamePath Required. Path name of the node to delete.
You can pass the name path in any of the following formats. For example, to delete the following node testApp/deployables/Development1/cdi1:
  • Backslash format: testApp/deployables/Development1/cdi1
    Note: If your node name contains a backslash ("/"), you can’t use this format.
  • Backend name path with replacement characters: testApp�deployables�​Development1​�​cdi1
  • Array: ['testApp','deployables','Development1','cdi1']

Data type: String
Table 3. Request body parameters
Name Description
None

Headers

The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.

Table 4. Request headers
Header Description
Accept Data format of the response body. Only supports application/json.
Table 5. Response headers
Header Description
None

Status codes

The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.

Table 6. Status codes
Status code Description
200 Successful. The request was successfully processed.
400 Bad Request. A bad request type or malformed request was detected.
500 Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.

Response body parameters

Name Description
None

Example: cURL request

The following code example shows how to delete the node "cdi88".

curl "http://instance.servicenow.com/api/sn_cdm/editor/nodes?changesetNumber=Chset783&fullNamePath=%2FtestApp%2Fdeployables%2FDevelopment-1%2Fcdi88" \
--request DELETE \
--header "Accept:application/json" \
--user 'username':'password'

Return result:

None - just the associated HTTP status code

CdmEditorApi - GET /sn_cdm/editor/includes

Returns the list of nodes that were include within a specified node path.

The caller of this endpoint must have the CDM Viewer role.

URL format

Versioned URL: /api/sn_cdm/{api_version}/editor/includes

Default URL: /api/sn_cdm/editor/includes

Note: Available versions are specified in the REST API Explorer. For scripted REST APIs there is additional version information on the Scripted REST Service form.

Supported request parameters

Table 7. Path parameters
Name Description
api_version Optional. Version of the endpoint to access. For example, v1 or v2. Only specify this value to use an endpoint version other than the latest.

Data type: String
Table 8. Query parameters
Name Description
None
Table 9. Request body parameters
Name Description
changesetNumber
Unique identifier of the associated changeset, such as "Chset-10".

Data type: String

Table: CDM Changeset [sn_cdm_changeset]
returnFields List of fields to return as part of the response. Pass the record column names such as sys_id, sys_updated_by, or state.

Data type: Array

Default: All fields as determined by the endpoint
sourceFullNamePath Required. Path name of the source node for which to return the included nodes.
You can pass the name path in any of the following formats. For example, to return the includes for the collectionA node in the testApp/collections directory:
  • Backslash format: testApp/collections/collectionA
    Note: If your node name contains a backslash ("/"), you can't use this format.
  • Backend name path with replacement characters: testApp�collections�​collectionA
  • Array: ['testApp','collections','collectionA']

Data type: String

Headers

The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.

Table 10. Request headers
Header Description
Accept Data format of the response body. Only supports application/json.
Table 11. Response headers
Header Description
None

Status codes

The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.

Table 12. Status codes
Status code Description
200 Successful. The request was successfully processed.
400 Bad Request. A bad request type or malformed request was detected.
500 Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.

Response body parameters

NameDescription
changeset_id
Unique identifier of the associated changeset, such as "Chset-10".

Data type: String

Table: CDM Changeset [sn_cdm_changeset]
conflict Flag that indicates whether there was a conflict when processing the node.
Possible values:
  • true: Conflict detected.
  • false: No conflict was detected.

Data type: Boolean
conflict_type If the conflict parameter is true, the type of conflict detected. Null if no conflict is detected.
Possible values:
  • corrupted_node
  • deleted_node
  • duplicated_node
  • incomplete_deleted_parent
  • incomplete_deleted_ref
  • incomplete_renamed_ref
  • invalid_include
  • orphaned_descendant
  • related_conflict
  • unlinked_include
  • unrenamed_include
  • updated_node

Data type: String
description Short description of the purpose of the node.

Data type: String
effective_from Timestamp (converted to a long integer) when the node was committed as part of the changeset. If the node hasn't been committed, this value is "null".

Data type: Number (Integer)
effective_to Timestamp (converted to a long integer) of the node when it was either deleted or superseded by another node, otherwise "null".

Data type: Number (Integer)
error If an error occurred during processing, the details about the error.

Data type: Object

"error": {
  "detail": "String",
  "message": "String"
}
error.detail Additional information about the error.

Data type: String
error.message Error message that was generated while trying to process the request.

Data type: String
level Level of the node, starting from the root node, which is always 0. For example, the node /AppA/components/compA has two levels.

Data type: String
linked_to The main_id parameter of the referenced node to which this node is linked.

If this node isn't linked to a reference node, the value is "null".

Data type: String
main_id Primary identifier for the node. You can use this value in the CdmQuery() script include to retrieve a JSON tree. For example: CdmQuery().mainId(‘123’)/query().getTree();

Data type: String
main_id_encoded RADIX 57 string representation of the node's main_id parameter.

Data type: String
name Name of the node that was included under the target path.

Data type: String
node_classifier Classifier hierarchy of the node. Use this information to locate a node within the folder hierarchy.

For example, a deployable would have a hierarchy of /application/deployables/env:Development

While a collection would have a hierarchy of /applications/collections

Data type: String
node_path Full path name of the node that was included in the target path, such as /Production/deployables/Development1/cdi1.

Data type: String
position Node position.
For example: If you upload the following array: 
arrayNode1: [
  "literal1", 
  {"cdi1": 1},
  "literal3"
]
The position values are set as follows:
  • arrayNode1.literal1 = 1000
  • arrayNode1.2000 = 2000
  • arrayNode1.literal3 = 3000
If a complex object is uploaded under an array, in this case {"cdi1": 1}, the endpoint creates a new virtual node with the name equal to its position. In the example above, this is 2000. For includes, the position is always empty.

Data type: String
previous_version Details of the previous version of the node record.
Note: If a new node was created, the endpoint returns "previous_version" = null for this parameter.

Data type: Object

"previous_version": {
  "link": "String",
  "value": "String"
}
restricted_to Details of the group that has access the associated the node.

Data type: Object

"restricted_to": {
  "link": "String",
  "value": "String"
}
secure_value If this value was flagged to be secured, the encrypted field (returned masked).

A user must have the sn_cdm.cdm_secrets role to decrypt this information. You can direct the endpoint not to return these fields by setting the returnFields query parameter field.

Data type: String
status Node status.
Possible values:
  • DELETED
  • NEW
  • SUPERSEDED
  • UPDATED
  • VALID

Data type: String
sys_id Sys_id of the node.

Data type: String

Table: CDM Node [sn_cdm_node]
system_folder Flag that indicates whether the associated node is a system folder.
Possible values:
  • true: Node is a system folder.
  • false: Node isn't a system folder.

Data type: Boolean
type
Node type.
Possible values:
  • sn_cdm_node_cdi
  • sn_cdm_node_collection
  • sn_cdm_node_component
  • sn_cdm_node_folder
  • sn_cdm_node_variable

Data type: String
value Node value.

Data type: String

Example: cURL request

This code example shows how retrieve the includes in the source path /testApp/collections/collA.

curl "http://instance.servicenow.com/api/sn_cdm/editor/includes?changesetNumber=Chset5&sourceFullNamePath=%2FtestApp%2Fcollections%2FcollA" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

Return result:

{ 
  "result": [ 
    { 
      "sys_id": "a1c517a953b70110a1d3ddeeff7b129b", 
      "type": "sn_cdm_node_deployable", 
      "main_id": "6", 
      "main_id_encoded": ",", 
      "node_path": "!$!+!,", 
      "level": 2, 
      "status": "valid", 
      "node_classifier": "/application/deployables/env:Development", 
      "position": null, 
      "restricted_to": null, 
      "changeset_id": "e9c517a953b70110a1d3ddeeff7b1299", 
      "previous_version": null, 
      "effective_from": "1654002206866", 
      "effective_to": null, 
      "name": "Development_1", 
      "description": null, 
      "value": null, 
      "secure_value": null, 
      "system_folder": "0", 
      "linked_to": null, 
      "conflict": "0", 
      "conflict_type": null 
    } 
  ] 
}

CdmEditorApi - GET /sn_cdm/editor/nodes

Returns the details of a specified node or a list of child Configuration Data Management (CDM) nodes for a specified parent node.

The caller of this endpoint must have the CDM Viewer role.

URL format

Versioned URL: /api/sn_cdm/{api_version}/editor/nodes

Default URL: /api/sn_cdm/editor/nodes

Note: Available versions are specified in the REST API Explorer. For scripted REST APIs there is additional version information on the Scripted REST Service form.

Supported request parameters

Table 13. Path parameters
Name Description
api_version Optional. Version of the endpoint to access. For example, v1 or v2. Only specify this value to use an endpoint version other than the latest.

Data type: String
Table 15. Request body parameters
Name Description
None

Headers

The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.

Table 16. Request headers
Header Description
Accept Data format of the response body. Only supports application/json.
Table 17. Response headers
Header Description
None

Status codes

The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.

Table 18. Status codes
Status code Description
200 Successful. The request was successfully processed.
400 Bad Request. A bad request type or malformed request was detected.
500 Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.

Response body parameters

NameDescription
changeset_id Details of the changeset record associated with the node.

Data type: Object

"changeset_id": {
  "link": "String",
  "value": "String"
}
changeset_id.link Call syntax for querying this changeset record using the Table REST API.

Data type: String
changeset_id.value Unique identifier of the changeset record.

Data type: String

Table: CDM Changeset [sn_cdm_changeset]
conflict Flag that indicates whether there was a conflict when processing the node.
Possible values:
  • true: Conflict detected.
  • false: No conflict was detected.

Data type: Boolean
conflict_type If the conflict parameter is true, the type of conflict detected. Null if no conflict is detected.
Possible values:
  • corrupted_node
  • deleted_node
  • duplicated_node
  • incomplete_deleted_parent
  • incomplete_deleted_ref
  • incomplete_renamed_ref
  • invalid_include
  • orphaned_descendant
  • related_conflict
  • unlinked_include
  • unrenamed_include
  • updated_node

Data type: String
description Short description of the purpose of the node.

Data type: String
effective_from Timestamp (converted to a long integer) when the node was committed as part of the changeset. If the node hasn't been committed, this value is "null".

Data type: Number (Integer)
effective_to Timestamp (converted to a long integer) of the node when it was either deleted or superseded by another node, otherwise "null".

Data type: Number (Integer)
error If an error occurred during processing, the details about the error.

Data type: Object

"error": {
  "detail": "String",
  "message": "String"
}
error.detail Additional information about the error.

Data type: String
error.message Error message that was generated while trying to process the request.

Data type: String
level Level of the node, starting from the root node, which is always 0. For example, the node /AppA/components/compA has two levels.

Data type: String
linked_to The main_id parameter of the referenced node to which this node is linked.

If this node isn't linked to a reference node, the value is "null".

Data type: String
main_id Primary identifier for the node. You can use this value in the CdmQuery() script include to retrieve a JSON tree. For example: CdmQuery().mainId(‘123’)/query().getTree();

Data type: String
main_id_encoded RADIX 57 string representation of the node's main_id parameter.

Data type: String
name Name of the node.

Data type: String
node_classifier Classifier hierarchy of the node. Use this information to locate a node within the folder hierarchy.

For example, a deployable would have a hierarchy of /application/deployables/env:Development

While a collection would have a hierarchy of /applications/collections

Data type: String
node_path Full node path name.

Data type: String
position Node position.
For example: If you upload the following array: 
arrayNode1: [
  "literal1", 
  {"cdi1": 1},
  "literal3"
]
The position values are set as follows:
  • arrayNode1.literal1 = 1000
  • arrayNode1.2000 = 2000
  • arrayNode1.literal3 = 3000
If a complex object is uploaded under an array, in this case {"cdi1": 1}, the endpoint creates a new virtual node with the name equal to its position. In the example above, this is 2000. For includes, the position is always empty.

Data type: String
previous_version Details of the previous version of the node record.
Note: If a new node was created, the endpoint returns "previous_version" = null for this parameter.

Data type: Object

"previous_version": {
  "link": "String",
  "value": "String"
}
previous_version.link Call syntax for querying this node record using the Table REST API.

Data type: String
previous_version.value Sys_id of the node record.

Data type: String

Table: CDM Node [sn_cdm_node]
reason_for_conflict Detailed explanation of the conflict.

Data type: String
restricted_to Details of the group that has access the associated the node.

Data type: Object

"restricted_to": {
  "link": "String",
  "value": "String"
}
restricted_to.link Call syntax for querying this group record using the Table REST API.

Data type: String
restricted_to.value Sys_id of the group record.

Data type: String

Table: CDM Group [sys_user_group]
secure_value If this value was flagged to be secured, the encrypted field (returned masked).

A user must have the sn_cdm.cdm_secrets role to decrypt this information. You can direct the endpoint not to return these fields by setting the returnFields query parameter field.

Data type: String
status Node status.
Possible values:
  • DELETED
  • NEW
  • SUPERSEDED
  • UPDATED
  • VALID

Data type: String
system_folder Flag that indicates whether the associated node is a system folder.
Possible values:
  • true: Node is a system folder.
  • false: Node isn't a system folder.

Data type: Boolean
sys_class_name Table in which the node resides.

Data type: String
sys_created_by Name of the user that created the node.

Data type: String
sys_created_on Date and time when the node was created.

Data type: String

Format: yyyy-mm-dd hh:mm:ss
sys_id Sys_id of the node.

Data type: String

Table: CDM Node [sn_cdm_node]
sys_updated_by Name of the user that updated the node.

Data type: String
sys_updated_on Date and time when the node was last updated.

Data type: String

Format: yyyy-mm-dd hh:mm:ss
type
Node type.
Possible values:
  • sn_cdm_node_cdi
  • sn_cdm_node_collection
  • sn_cdm_node_component
  • sn_cdm_node_folder
  • sn_cdm_node_variable

Data type: String

Default: All
value Node value.

Data type: String

Example: cURL request

This code example shows how to retrieve the child nodes of type sn_cdm_node_cdi under the /testApp/Fdeployables/Development_1 parent node.

curl "http://instance.servicenow.com/api/sn_cdm/editor/nodes?decryptPassword=true&name=cdi45&changesetNumber=Chset3&parentFullNamePath=%2FtestApp%2Fdeployables%2FDevelopment_1&type=sn_cdm_node_cdi" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

Return result:

{ 
  "result": [ 
    { 
      "changeset_id": { 
        "value": "d403648653b70110a1d3ddeeff7b12c5", 
        "link": "http://instance.servicenow.com/api/now/table/sn_cdm_changeset/d403648653b70110a1d3ddeeff7b12c5" 
      }, 
      "node_path": "!$!+!,![:", 
      "description": null, 
      "sys_updated_on": "2022-06-30 09:24:07", 
      "type": "sn_cdm_node_cdi", 
      "sys_class_name": "sn_cdm_node", 
      "sys_id": "c93c7c1753981110a1d3ddeeff7b12c7", 
      "sys_updated_by": "admin", 
      "previous_version": null, 
      "sys_created_on": "2022-06-30 08:53:13", 
      "value": "cdcdc", 
      "effective_from": null, 
      "linked_to": null, 
      "sys_created_by": "admin", 
      "restricted_to": null, 
      "level": "3", 
      "conflict_type": null, 
      "main_id": "2869", 
      "effective_to": null, 
      "secure_value": null, 
      "node_classifier": "/application/deployables/env:Development", 
      "main_id_encoded": "[:", 
      "name": "cdi45", 
      "position": null, 
      "reason_for_conflict": null, 
      "system_folder": false, 
      "status": "new", 
      "conflict": false 
    } 
  ] 
}

CdmEditorApi - POST /sn_cdm/editor/includes

Includes an existing node into another node, such as a component node into a collection node or a collection node into a deployable node. After including a node, the new node has its own unique sys_id and main_Id.

The caller of this endpoint must have the CDM Editor role.

URL format

Versioned URL: /api/sn_cdm/{api_version}/editor/includes

Default URL: /api/sn_cdm/editor/includes

Note: Available versions are specified in the REST API Explorer. For scripted REST APIs there is additional version information on the Scripted REST Service form.

Supported request parameters

Table 19. Path parameters
Name Description
api_version Optional. Version of the endpoint to access. For example, v1 or v2. Only specify this value to use an endpoint version other than the latest.

Data type: String
Table 21. Request body parameters
Name Description
None

Headers

The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.

Table 22. Request headers
Header Description
Accept Data format of the response body. Only supports application/json.
Content-Type Data format of the request body. Only supports application/json.
Table 23. Response headers
Header Description
None

Status codes

The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.

Table 24. Status codes
Status code Description
200 Successful. The request was successfully processed.
400 Bad Request. A bad request type or malformed request was detected.
500 Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.

Response body parameters

NameDescription
changeset_id
Unique identifier of the associated changeset, such as "Chset-10".

Data type: String

Table: CDM Changeset [sn_cdm_changeset]
conflict Flag that indicates whether there was a conflict when processing the node.
Possible values:
  • true: Conflict detected.
  • false: No conflict was detected.

Data type: Boolean
conflict_type If the conflict parameter is true, the type of conflict detected. Null if no conflict is detected.
Possible values:
  • corrupted_node
  • deleted_node
  • duplicated_node
  • incomplete_deleted_parent
  • incomplete_deleted_ref
  • incomplete_renamed_ref
  • invalid_include
  • orphaned_descendant
  • related_conflict
  • unlinked_include
  • unrenamed_include
  • updated_node

Data type: String
description Short description of the purpose of the node.

Data type: String
effective_from Timestamp (converted to a long integer) when the node was committed as part of the changeset. If the node hasn't been committed, this value is "null".

Data type: Number (Integer)
effective_to Timestamp (converted to a long integer) of the node when it was either deleted or superseded by another node, otherwise "null".

Data type: Number (Integer)
error If an error occurred during processing, the details about the error.

Data type: Object

"error": {
  "detail": "String",
  "message": "String"
}
error.detail Additional information about the error.

Data type: String
error.message Error message that was generated while trying to process the request.

Data type: String
level Level of the node, starting from the root node, which is always 0. For example, the node /AppA/components/compA has two levels.

Data type: String
linked_to The main_id parameter of the referenced node to which this node is linked.

If this node isn't linked to a reference node, the value is "null".

Data type: String
main_id Primary identifier for the node. You can use this value in the CdmQuery() script include to retrieve a JSON tree. For example: CdmQuery().mainId(‘123’)/query().getTree();

Data type: String
main_id_encoded RADIX 57 string representation of the node's main_id parameter.

Data type: String
name Name of the node that was included under the target path.

Data type: String
node_classifier Classifier hierarchy of the node. Use this information to locate a node within the folder hierarchy.

For example, a deployable would have a hierarchy of /application/deployables/env:Development

While a collection would have a hierarchy of /applications/collections

Data type: String
node_path Full path name of the node that was included in the target path, such as /Production/deployables/Development1/cdi1.

Data type: String
position Node position.
For example: If you upload the following array: 
arrayNode1: [
  "literal1", 
  {"cdi1": 1},
  "literal3"
]
The position values are set as follows:
  • arrayNode1.literal1 = 1000
  • arrayNode1.2000 = 2000
  • arrayNode1.literal3 = 3000
If a complex object is uploaded under an array, in this case {"cdi1": 1}, the endpoint creates a new virtual node with the name equal to its position. In the example above, this is 2000. For includes, the position is always empty.

Data type: String
previous_version Details of the previous version of the node record.
Note: If a new node was created, the endpoint returns "previous_version" = null for this parameter.

Data type: Object

"previous_version": {
  "link": "String",
  "value": "String"
}
restricted_to Details of the group that has access the associated the node.

Data type: Object

"restricted_to": {
  "link": "String",
  "value": "String"
}
secure_value If this value was flagged to be secured, the encrypted field (returned masked).

A user must have the sn_cdm.cdm_secrets role to decrypt this information. You can direct the endpoint not to return these fields by setting the returnFields query parameter field.

Data type: String
status Node status.
Possible values:
  • DELETED
  • NEW
  • SUPERSEDED
  • UPDATED
  • VALID

Data type: String
sys_id Sys_id of the node.

Data type: String

Table: CDM Node [sn_cdm_node]
system_folder Flag that indicates whether the associated node is a system folder.
Possible values:
  • true: Node is a system folder.
  • false: Node isn't a system folder.

Data type: Boolean
type
Node type.
Possible values:
  • sn_cdm_node_cdi
  • sn_cdm_node_collection
  • sn_cdm_node_component
  • sn_cdm_node_folder
  • sn_cdm_node_variable

Data type: String
value Node value.

Data type: String

Example: cURL request

The following code example shows how to include the node /testApp/collections/collA under /testApp/deployables/Development_1.

curl "http://instance.servicenow.com/api/sn_cdm/editor/includes?changesetNumber=Chset5&targetFullNamePath=%2FtestApp%2Fdeployables%2FDevelopment_1&sourceFullNamePath=%2FtestApp%2Fcollecti
ons%2FcollA" \
--request POST \
--header "Accept:application/json" \
--user 'username':'password'

Return result:

{ 
  "result": { 
    "changeset_id": { 
      "value": "d403648653b70110a1d3ddeeff7b12c5", 
      "link": "http://192.168.0.233:8080/api/now/table/sn_cdm_changeset/d403648653b70110a1d3ddeeff7b12c5" 
    }, 
    "node_path": "!$!+!,![?", 
    "description": null, 
    "sys_updated_on": "2022-06-30 09:19:47", 
    "type": "sn_cdm_node_linked", 
    "sys_class_name": "sn_cdm_node", 
    "sys_id": "1642015b53981110a1d3ddeeff7b1232", 
    "sys_updated_by": "admin", 
    "previous_version": null, 
    "sys_created_on": "2022-06-30 09:19:47", 
    "value": null, 
    "effective_from": null, 
    "linked_to": "2870", 
    "sys_created_by": "admin", 
    "restricted_to": null, 
    "level": "3", 
    "conflict_type": null, 
    "main_id": "2872", 
    "effective_to": null, 
    "secure_value": null, 
    "node_classifier": "/application/deployables/env:Development", 
    "main_id_encoded": "[?", 
    "name": "collA", 
    "position": null, 
    "reason_for_conflict": null, 
    "system_folder": false, 
    "status": "new", 
    "conflict": false 
  } 
}

CdmEditorApi - POST /sn_cdm/editor/nodes

Creates a specific type of node, such as component, collection, folder, configuration data item (CDI), or variable.

You can also specify whether to automatically generate any parent nodes that are not currently defined.

The caller of this endpoint must have either the CDM Editor or CDM Secret role.

URL format

Versioned URL: /api/sn_cdm/{api_version}/editor/nodes

Default URL: /api/sn_cdm/editor/nodes

Note: Available versions are specified in the REST API Explorer. For scripted REST APIs there is additional version information on the Scripted REST Service form.

Supported request parameters

Table 25. Path parameters
Name Description
api_version Optional. Version of the endpoint to access. For example, v1 or v2. Only specify this value to use an endpoint version other than the latest.

Data type: String
Table 27. Request body parameters
Name Description
None

Headers

The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.

Table 28. Request headers
Header Description
Accept Data format of the response body. Only supports application/json.
Content-Type Data format of the request body. Only supports application/json.
Table 29. Response headers
Header Description
None

Status codes

The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.

Table 30. Status codes
Status code Description
200 Successful. The request was successfully processed.
400 Bad Request. A bad request type or malformed request was detected.
500 Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.

Response body parameters

NameDescription
changeset_id Details of the changeset record associated with the node.

Data type: Object

"changeset_id": {
  "link": "String",
  "value": "String"
}
changeset_id.link Call syntax for querying this changeset record using the Table REST API.

Data type: String
changeset_id.value Unique identifier of the changeset record.

Data type: String

Table: CDM Changeset [sn_cdm_changeset]
conflict Flag that indicates whether there was a conflict when processing the node.
Possible values:
  • true: Conflict detected.
  • false: No conflict was detected.

Data type: Boolean
conflict_type If the conflict parameter is true, the type of conflict detected. Null if no conflict is detected.
Possible values:
  • corrupted_node
  • deleted_node
  • duplicated_node
  • incomplete_deleted_parent
  • incomplete_deleted_ref
  • incomplete_renamed_ref
  • invalid_include
  • orphaned_descendant
  • related_conflict
  • unlinked_include
  • unrenamed_include
  • updated_node

Data type: String
description Short description of the purpose of the node.

Data type: String
effective_from Timestamp (converted to a long integer) when the node was committed as part of the changeset. If the node hasn't been committed, this value is "null".

Data type: Number (Integer)
effective_to Timestamp (converted to a long integer) of the node when it was either deleted or superseded by another node, otherwise "null".

Data type: Number (Integer)
error If an error occurred during processing, the details about the error.

Data type: Object

"error": {
  "detail": "String",
  "message": "String"
}
error.detail Additional information about the error.

Data type: String
error.message Error message that was generated while trying to process the request.

Data type: String
level Level of the node, starting from the root node, which is always 0. For example, the node /AppA/components/compA has two levels.

Data type: String
linked_to The main_id parameter of the referenced node to which this node is linked.

If this node isn't linked to a reference node, the value is "null".

Data type: String
main_id Primary identifier for the node. You can use this value in the CdmQuery() script include to retrieve a JSON tree. For example: CdmQuery().mainId(‘123’)/query().getTree();

Data type: String
main_id_encoded RADIX 57 string representation of the node's main_id parameter.

Data type: String
name Name of the node.

Data type: String
node_classifier Classifier hierarchy of the node. Use this information to locate a node within the folder hierarchy.

For example, a deployable would have a hierarchy of /application/deployables/env:Development

While a collection would have a hierarchy of /applications/collections

Data type: String
node_path Full node path name.

Data type: String
position Node position.
For example: If you upload the following array: 
arrayNode1: [
  "literal1", 
  {"cdi1": 1},
  "literal3"
]
The position values are set as follows:
  • arrayNode1.literal1 = 1000
  • arrayNode1.2000 = 2000
  • arrayNode1.literal3 = 3000
If a complex object is uploaded under an array, in this case {"cdi1": 1}, the endpoint creates a new virtual node with the name equal to its position. In the example above, this is 2000. For includes, the position is always empty.

Data type: String
previous_version Details of the previous version of the node record.
Note: If a new node was created, the endpoint returns "previous_version" = null for this parameter.

Data type: Object

"previous_version": {
  "link": "String",
  "value": "String"
}
previous_version.link Call syntax for querying this node record using the Table REST API.

Data type: String
previous_version.value Sys_id of the node record.

Data type: String

Table: CDM Node [sn_cdm_node]
reason_for_conflict Detailed explanation of the conflict.

Data type: String
restricted_to Details of the group that has access the associated the node.

Data type: Object

"restricted_to": {
  "link": "String",
  "value": "String"
}
restricted_to.link Call syntax for querying this group record using the Table REST API.

Data type: String
restricted_to.value Sys_id of the group record.

Data type: String

Table: CDM Group [sys_user_group]
secure_value If this value was flagged to be secured, the encrypted field (returned masked).

A user must have the sn_cdm.cdm_secrets role to decrypt this information. You can direct the endpoint not to return these fields by setting the returnFields query parameter field.

Data type: String
status Node status.
Possible values:
  • DELETED
  • NEW
  • SUPERSEDED
  • UPDATED
  • VALID

Data type: String
system_folder Flag that indicates whether the associated node is a system folder.
Possible values:
  • true: Node is a system folder.
  • false: Node isn't a system folder.

Data type: Boolean
sys_class_name Table in which the node resides.

Data type: String
sys_created_by Name of the user that created the node.

Data type: String
sys_created_on Date and time when the node was created.

Data type: String

Format: yyyy-mm-dd hh:mm:ss
sys_id Sys_id of the node.

Data type: String

Table: CDM Node [sn_cdm_node]
sys_updated_by Name of the user that updated the node.

Data type: String
sys_updated_on Date and time when the node was last updated.

Data type: String

Format: yyyy-mm-dd hh:mm:ss
type
Node type.
Possible values:
  • sn_cdm_node_cdi
  • sn_cdm_node_collection
  • sn_cdm_node_component
  • sn_cdm_node_folder
  • sn_cdm_node_variable

Data type: String

Default: All
value Node value.

Data type: String

Example: cURL request

The following code example shows how to create a node using this endpoint.

curl "http://instance.servicenow.com/api/sn_cdm/editor/nodes?fullNamePath=%2FtestApp%2Fdeployables%2FDevelopment1%2Fcdi1&secure=true&value=someVal&type=cdi&changesetNumber=Chset-760" \
--request POST \
--header "Accept:application/json" \
--user 'username':'password'

Return result:

{ 
  "result": { 
    "changeset_id": { 
      "value": "d403648653b70110a1d3ddeeff7b12c5", 
      "link": "http://instance.servicenow.com/api/now/table/sn_cdm_changeset/d403648653b70110a1d3ddeeff7b12c5" 
    }, 
    "node_path": "!$!+!,![:", 
    "description": null, 
    "sys_updated_on": "2022-06-30 08:53:13", 
    "type": "sn_cdm_node_cdi", 
    "sys_class_name": "sn_cdm_node", 
    "sys_id": "c93c7c1753981110a1d3ddeeff7b12c7", 
    "sys_updated_by": "admin", 
    "previous_version": null, 
    "sys_created_on": "2022-06-30 08:53:13", 
    "value": null, 
    "effective_from": null, 
    "linked_to": null, 
    "sys_created_by": "admin", 
    "restricted_to": null, 
    "level": "3", 
    "conflict_type": null, 
    "main_id": "2869", 
    "effective_to": null, 
    "secure_value": "﷞﷟﷒113a0c6e53001110a1d3ddeeff7b121d﷬﷔1﷬﷭bAUA1wj-fxofbSrMyF-BAg==6qiho5f_9DhnuHT2Km5SLf0Ck4XNX_w=﷮﷯", 
    "node_classifier": "/application/deployables/env:Development", 
    "main_id_encoded": "[:", 
    "name": "cdi45", 
    "position": null, 
    "reason_for_conflict": null, 
    "system_folder": false, 
    "status": "new", 
    "conflict": false 
  } 
}

CdmEditorApi - PUT /sn_cdm/editor/nodes

Updates the name and/or value of a specified node.

The caller of this endpoint must have either the CDM Editor or CDM Secret role.

URL format

Versioned URL: /api/sn_cdm/{api_version}/editor/nodes

Default URL: /api/sn_cdm/editor/nodes

Note: Available versions are specified in the REST API Explorer. For scripted REST APIs there is additional version information on the Scripted REST Service form.

Supported request parameters

Table 31. Path parameters
Name Description
api_version Optional. Version of the endpoint to access. For example, v1 or v2. Only specify this value to use an endpoint version other than the latest.

Data type: String
Table 33. Request body parameters
Name Description
None

Headers

The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.

Table 34. Request headers
Header Description
Accept Data format of the response body. Only supports application/json.
Content-Type Data format of the request body. Only supports application/json.
Table 35. Response headers
Header Description
None

Status codes

The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.

Table 36. Status codes
Status code Description
200 Successful. The request was successfully processed.
400 Bad Request. A bad request type or malformed request was detected.
500 Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.

Response body parameters

NameDescription
changeset_id Details of the changeset record associated with the node.

Data type: Object

"changeset_id": {
  "link": "String",
  "value": "String"
}
changeset_id.link Call syntax for querying this changeset record using the Table REST API.

Data type: String
changeset_id.value Unique identifier of the changeset record.

Data type: String

Table: CDM Changeset [sn_cdm_changeset]
conflict Flag that indicates whether there was a conflict when processing the node.
Possible values:
  • true: Conflict detected.
  • false: No conflict was detected.

Data type: Boolean
conflict_type If the conflict parameter is true, the type of conflict detected. Null if no conflict is detected.
Possible values:
  • corrupted_node
  • deleted_node
  • duplicated_node
  • incomplete_deleted_parent
  • incomplete_deleted_ref
  • incomplete_renamed_ref
  • invalid_include
  • orphaned_descendant
  • related_conflict
  • unlinked_include
  • unrenamed_include
  • updated_node

Data type: String
description Short description of the purpose of the node.

Data type: String
effective_from Timestamp (converted to a long integer) when the node was committed as part of the changeset. If the node hasn't been committed, this value is "null".

Data type: Number (Integer)
effective_to Timestamp (converted to a long integer) of the node when it was either deleted or superseded by another node, otherwise "null".

Data type: Number (Integer)
error If an error occurred during processing, the details about the error.

Data type: Object

"error": {
  "detail": "String",
  "message": "String"
}
error.detail Additional information about the error.

Data type: String
error.message Error message that was generated while trying to process the request.

Data type: String
level Level of the node, starting from the root node, which is always 0. For example, the node /AppA/components/compA has two levels.

Data type: String
linked_to The main_id parameter of the referenced node to which this node is linked.

If this node isn't linked to a reference node, the value is "null".

Data type: String
main_id Primary identifier for the node. You can use this value in the CdmQuery() script include to retrieve a JSON tree. For example: CdmQuery().mainId(‘123’)/query().getTree();

Data type: String
main_id_encoded RADIX 57 string representation of the node's main_id parameter.

Data type: String
name Name of the node.

Data type: String
node_classifier Classifier hierarchy of the node. Use this information to locate a node within the folder hierarchy.

For example, a deployable would have a hierarchy of /application/deployables/env:Development

While a collection would have a hierarchy of /applications/collections

Data type: String
node_path Full node path name.

Data type: String
position Node position.
For example: If you upload the following array: 
arrayNode1: [
  "literal1", 
  {"cdi1": 1},
  "literal3"
]
The position values are set as follows:
  • arrayNode1.literal1 = 1000
  • arrayNode1.2000 = 2000
  • arrayNode1.literal3 = 3000
If a complex object is uploaded under an array, in this case {"cdi1": 1}, the endpoint creates a new virtual node with the name equal to its position. In the example above, this is 2000. For includes, the position is always empty.

Data type: String
previous_version Details of the previous version of the node record.
Note: If a new node was created, the endpoint returns "previous_version" = null for this parameter.

Data type: Object

"previous_version": {
  "link": "String",
  "value": "String"
}
previous_version.link Call syntax for querying this node record using the Table REST API.

Data type: String
previous_version.value Sys_id of the node record.

Data type: String

Table: CDM Node [sn_cdm_node]
reason_for_conflict Detailed explanation of the conflict.

Data type: String
restricted_to Details of the group that has access the associated the node.

Data type: Object

"restricted_to": {
  "link": "String",
  "value": "String"
}
restricted_to.link Call syntax for querying this group record using the Table REST API.

Data type: String
restricted_to.value Sys_id of the group record.

Data type: String

Table: CDM Group [sys_user_group]
secure_value If this value was flagged to be secured, the encrypted field (returned masked).

A user must have the sn_cdm.cdm_secrets role to decrypt this information. You can direct the endpoint not to return these fields by setting the returnFields query parameter field.

Data type: String
status Node status.
Possible values:
  • DELETED
  • NEW
  • SUPERSEDED
  • UPDATED
  • VALID

Data type: String
system_folder Flag that indicates whether the associated node is a system folder.
Possible values:
  • true: Node is a system folder.
  • false: Node isn't a system folder.

Data type: Boolean
sys_class_name Table in which the node resides.

Data type: String
sys_created_by Name of the user that created the node.

Data type: String
sys_created_on Date and time when the node was created.

Data type: String

Format: yyyy-mm-dd hh:mm:ss
sys_id Sys_id of the node.

Data type: String

Table: CDM Node [sn_cdm_node]
sys_updated_by Name of the user that updated the node.

Data type: String
sys_updated_on Date and time when the node was last updated.

Data type: String

Format: yyyy-mm-dd hh:mm:ss
type
Node type.
Possible values:
  • sn_cdm_node_cdi
  • sn_cdm_node_collection
  • sn_cdm_node_component
  • sn_cdm_node_folder
  • sn_cdm_node_variable

Data type: String

Default: All
value Node value.

Data type: String

Example: cURL request

The following code example shows how to update the value of a node.

curl "http://instance.servicenow.com/api/sn_cdm/editor/nodes?newValue=cdcdc&fullNamePath=%2FtestApp%2Fdeployables%2FDe
velopment-1%2Fcdi45&changesetNumber=Chset-5" \
--request PUT \
--header "Accept:application/json" \
--user 'username':'password'

Return result:

{ 
  "result": { 
    "changeset_id": { 
      "value": "d403648653b70110a1d3ddeeff7b12c5", 
      "link": "http://instance.servicenow.com/api/now/table/sn_cdm_changeset/d403648653b70110a1d3ddeeff7b12c5" 
    }, 
    "node_path": "!$!+!,![:", 
    "description": null, 
    "sys_updated_on": "2022-06-30 08:53:13", 
    "type": "sn_cdm_node_cdi", 
    "sys_class_name": "sn_cdm_node", 
    "sys_id": "c93c7c1753981110a1d3ddeeff7b12c7", 
    "sys_updated_by": "admin", 
    "previous_version": null, 
    "sys_created_on": "2022-06-30 08:53:13", 
    "value": null, 
    "effective_from": null, 
    "linked_to": null, 
    "sys_created_by": "admin", 
    "restricted_to": null, 
    "level": "3", 
    "conflict_type": null, 
    "main_id": "2869", 
    "effective_to": null, 
    "secure_value": "﷞﷟﷒113a0c6e53001110a1d3ddeeff7b121d﷬﷔1﷬﷭bAUA1wj-fxofbSrMyF-BAg==6qiho5f_9DhnuHT2Km5SLf0Ck4XNX_w=﷮﷯", 
    "node_classifier": "/application/deployables/env:Development", 
    "main_id_encoded": "[:", 
    "name": "cdi45", 
    "position": null, 
    "reason_for_conflict": null, 
    "system_folder": false, 
    "status": "new", 
    "conflict": false 
  } 
}