@itentialopensource/adapter-servicenow 2.9.5 → 2.9.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (9) hide show
  1. package/CALLS.md +114 -0
  2. package/adapter.js +2102 -0
  3. package/entities/ChangeManagement/action.json +389 -0
  4. package/entities/ChangeManagement/schema.json +100 -1
  5. package/package.json +2 -2
  6. package/pronghorn.json +1285 -69
  7. package/report/adapterInfo.json +7 -7
  8. package/test/integration/adapterTestIntegration.js +484 -0
  9. package/test/unit/adapterTestUnit.js +671 -1
package/pronghorn.json CHANGED
@@ -64,13 +64,13 @@
64
64
  }
65
65
  },
66
66
  {
67
- "name" : "replace",
67
+ "name": "replace",
68
68
  "type": "boolean",
69
69
  "info": "True to replace entire mock data, false to merge/append",
70
70
  "required": false,
71
71
  "schema": {
72
72
  "title": "replace",
73
- "type" : "boolean"
73
+ "type": "boolean"
74
74
  }
75
75
  }
76
76
  ],
@@ -921,73 +921,73 @@
921
921
  "task": true
922
922
  },
923
923
  {
924
- "name": "iapRunAdapterLint",
925
- "summary": "Run the adapter lint script to return the results",
926
- "description": "Run the adapter lint script to return the results",
927
- "input": [],
928
- "output": {
929
- "name": "result",
930
- "type": "string",
931
- "description": "A string containing the run results",
932
- "schema": {
933
- "title": "result",
934
- "type": "string"
935
- }
936
- },
937
- "roles": [
938
- "admin"
939
- ],
940
- "route": {
941
- "verb": "GET",
942
- "path": "/iapRunAdapterLint"
943
- },
944
- "task": true
945
- },
946
- {
947
- "name": "iapRunAdapterTests",
948
- "summary": "Run the adapter test scripts (baseunit and unit) to return the results",
949
- "description": "Run the adapter test scripts (baseunit and unit) to return the results",
950
- "input": [],
951
- "output": {
952
- "name": "result",
953
- "type": "object",
954
- "description": "A JSON Object containing status, code and the result",
955
- "schema": {
956
- "title": "result",
957
- "type": "object"
958
- }
959
- },
960
- "roles": [
961
- "admin"
962
- ],
963
- "route": {
964
- "verb": "GET",
965
- "path": "/iapRunAdapterTests"
966
- },
967
- "task": true
968
- },
969
- {
970
- "name": "iapGetAdapterInventory",
971
- "summary": "Provide inventory information abbout the adapter",
972
- "description": "Provide inventory information abbout the adapter",
973
- "input": [],
974
- "output": {
975
- "name": "result",
976
- "type": "object",
977
- "description": "A JSON Object containing status, code and the result",
978
- "schema": {
979
- "title": "result",
980
- "type": "object"
981
- }
982
- },
983
- "roles": [
984
- "admin"
985
- ],
986
- "route": {
987
- "verb": "GET",
988
- "path": "/iapGetAdapterInventory"
989
- },
990
- "task": true
924
+ "name": "iapRunAdapterLint",
925
+ "summary": "Run the adapter lint script to return the results",
926
+ "description": "Run the adapter lint script to return the results",
927
+ "input": [],
928
+ "output": {
929
+ "name": "result",
930
+ "type": "string",
931
+ "description": "A string containing the run results",
932
+ "schema": {
933
+ "title": "result",
934
+ "type": "string"
935
+ }
936
+ },
937
+ "roles": [
938
+ "admin"
939
+ ],
940
+ "route": {
941
+ "verb": "GET",
942
+ "path": "/iapRunAdapterLint"
943
+ },
944
+ "task": true
945
+ },
946
+ {
947
+ "name": "iapRunAdapterTests",
948
+ "summary": "Run the adapter test scripts (baseunit and unit) to return the results",
949
+ "description": "Run the adapter test scripts (baseunit and unit) to return the results",
950
+ "input": [],
951
+ "output": {
952
+ "name": "result",
953
+ "type": "object",
954
+ "description": "A JSON Object containing status, code and the result",
955
+ "schema": {
956
+ "title": "result",
957
+ "type": "object"
958
+ }
959
+ },
960
+ "roles": [
961
+ "admin"
962
+ ],
963
+ "route": {
964
+ "verb": "GET",
965
+ "path": "/iapRunAdapterTests"
966
+ },
967
+ "task": true
968
+ },
969
+ {
970
+ "name": "iapGetAdapterInventory",
971
+ "summary": "Provide inventory information abbout the adapter",
972
+ "description": "Provide inventory information abbout the adapter",
973
+ "input": [],
974
+ "output": {
975
+ "name": "result",
976
+ "type": "object",
977
+ "description": "A JSON Object containing status, code and the result",
978
+ "schema": {
979
+ "title": "result",
980
+ "type": "object"
981
+ }
982
+ },
983
+ "roles": [
984
+ "admin"
985
+ ],
986
+ "route": {
987
+ "verb": "GET",
988
+ "path": "/iapGetAdapterInventory"
989
+ },
990
+ "task": true
991
991
  },
992
992
  {
993
993
  "name": "queryTableByNameAndId",
@@ -6545,6 +6545,1222 @@
6545
6545
  "path": "/autoApproveChangeRequest"
6546
6546
  },
6547
6547
  "task": true
6548
+ },
6549
+ {
6550
+ "name": "getChangeRequest",
6551
+ "summary": "Retrieves one or more change requests based on the specified criteria.",
6552
+ "description": "Retrieves one or more change requests based on the specified criteria.",
6553
+ "input": [
6554
+ {
6555
+ "name": "sysparmQueryKeyValuePairs",
6556
+ "type": "object",
6557
+ "info": "e.g. { number: 'CHG12345' }: object",
6558
+ "required": false,
6559
+ "schema": {
6560
+ "title": "sysparmQuery",
6561
+ "type": "object"
6562
+ }
6563
+ },
6564
+ {
6565
+ "name": "sysparmQueryString",
6566
+ "type": "string",
6567
+ "info": "e.g. number=CHG12345: string",
6568
+ "required": false,
6569
+ "schema": {
6570
+ "title": "sysparmQuery",
6571
+ "type": "string"
6572
+ }
6573
+ },
6574
+ {
6575
+ "name": "order",
6576
+ "type": "string",
6577
+ "info": "Field by which to sort the returned change requests.: string",
6578
+ "required": false,
6579
+ "schema": {
6580
+ "title": "order",
6581
+ "type": "string"
6582
+ }
6583
+ },
6584
+ {
6585
+ "name": "sysparmOffset",
6586
+ "type": "number",
6587
+ "info": "Starting record index for which to begin retrieving records. Use this value to paginate record retrieval. This functionality enables the retrieval of all records, regardl...(description truncated): 123",
6588
+ "required": false,
6589
+ "schema": {
6590
+ "title": "sysparmOffset",
6591
+ "type": "number"
6592
+ }
6593
+ },
6594
+ {
6595
+ "name": "textSearch",
6596
+ "type": "string",
6597
+ "info": "String to use to search all normal change request record fields. This search uses ServiceNow full text search platform functionality.: string",
6598
+ "required": false,
6599
+ "schema": {
6600
+ "title": "textSearch",
6601
+ "type": "string"
6602
+ }
6603
+ },
6604
+ {
6605
+ "name": "iapMetadata",
6606
+ "type": "object",
6607
+ "info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
6608
+ "required": false,
6609
+ "schema": {
6610
+ "title": "iapMetadata",
6611
+ "type": "object"
6612
+ }
6613
+ }
6614
+ ],
6615
+ "output": {
6616
+ "name": "result",
6617
+ "type": "object",
6618
+ "description": "A JSON Object containing status, code and the result",
6619
+ "schema": {
6620
+ "title": "result",
6621
+ "type": "object"
6622
+ }
6623
+ },
6624
+ "roles": [
6625
+ "admin"
6626
+ ],
6627
+ "route": {
6628
+ "verb": "POST",
6629
+ "path": "/getChangeRequest"
6630
+ },
6631
+ "task": true
6632
+ },
6633
+ {
6634
+ "name": "createChangeRequestRecord",
6635
+ "summary": "Creates a change request record based on the change request. Creating multiple change requests with",
6636
+ "description": "Creates a change request record based on the change request. Creating multiple change requests within a single call isn’t supported.",
6637
+ "input": [
6638
+ {
6639
+ "name": "sysparmQueryKeyValuePairs",
6640
+ "type": "object",
6641
+ "info": "e.g. { number: 'CHG12345' }: object",
6642
+ "required": false,
6643
+ "schema": {
6644
+ "title": "sysparmQuery",
6645
+ "type": "object"
6646
+ }
6647
+ },
6648
+ {
6649
+ "name": "sysparmQueryString",
6650
+ "type": "string",
6651
+ "info": "e.g. number=CHG12345: string",
6652
+ "required": false,
6653
+ "schema": {
6654
+ "title": "sysparmQuery",
6655
+ "type": "string"
6656
+ }
6657
+ },
6658
+ {
6659
+ "name": "changeModel",
6660
+ "type": "string",
6661
+ "info": "Name of a change model listed in the Change Model [chg_model] table. Provided in the following format: chg_model=Normal.: string",
6662
+ "required": false,
6663
+ "schema": {
6664
+ "title": "changeModel",
6665
+ "type": "string"
6666
+ }
6667
+ },
6668
+ {
6669
+ "name": "encryptedFields",
6670
+ "type": "string",
6671
+ "info": "List of comma-separated fields to encrypt. These fields are encrypted before they are stored in the associated record. When specified, the endpoint calls the GlideRecord ...(description truncated): string",
6672
+ "required": false,
6673
+ "schema": {
6674
+ "title": "encryptedFields",
6675
+ "type": "string"
6676
+ }
6677
+ },
6678
+ {
6679
+ "name": "queryType",
6680
+ "type": "string",
6681
+ "info": "Name of the change request type listed in the Choices [sys_choice] table. If the chg_model is also populated, this field is only used as a change categorization. Provided...(description truncated): string",
6682
+ "required": false,
6683
+ "schema": {
6684
+ "title": "queryType",
6685
+ "type": "string"
6686
+ }
6687
+ },
6688
+ {
6689
+ "name": "body",
6690
+ "type": "object",
6691
+ "info": ": object",
6692
+ "required": true,
6693
+ "schema": {
6694
+ "title": "body",
6695
+ "type": "object"
6696
+ }
6697
+ },
6698
+ {
6699
+ "name": "iapMetadata",
6700
+ "type": "object",
6701
+ "info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
6702
+ "required": false,
6703
+ "schema": {
6704
+ "title": "iapMetadata",
6705
+ "type": "object"
6706
+ }
6707
+ }
6708
+ ],
6709
+ "output": {
6710
+ "name": "result",
6711
+ "type": "object",
6712
+ "description": "A JSON Object containing status, code and the result",
6713
+ "schema": {
6714
+ "title": "result",
6715
+ "type": "object"
6716
+ }
6717
+ },
6718
+ "roles": [
6719
+ "admin"
6720
+ ],
6721
+ "route": {
6722
+ "verb": "POST",
6723
+ "path": "/createChangeRequestRecord"
6724
+ },
6725
+ "task": true
6726
+ },
6727
+ {
6728
+ "name": "getConfigurationItemSchedule",
6729
+ "summary": "Enables retrieving available time slots by configuration item ID and duration, with an option to in",
6730
+ "description": "Enables retrieving available time slots by configuration item ID and duration, with an option to include planned start time.",
6731
+ "input": [
6732
+ {
6733
+ "name": "cmdbCiSysId",
6734
+ "type": "string",
6735
+ "info": "Sys_id of a record in the Configuration Items [cmdb_ci] table. This endpoint does not require a change request.: string",
6736
+ "required": true,
6737
+ "schema": {
6738
+ "title": "cmdbCiSysId",
6739
+ "type": "string"
6740
+ }
6741
+ },
6742
+ {
6743
+ "name": "durationInSeconds",
6744
+ "type": "number",
6745
+ "info": "Duration of change in seconds, that is, how much time is required to complete the change request task.: 123",
6746
+ "required": false,
6747
+ "schema": {
6748
+ "title": "durationInSeconds",
6749
+ "type": "number"
6750
+ }
6751
+ },
6752
+ {
6753
+ "name": "plannedStartTime",
6754
+ "type": "string",
6755
+ "info": "Retrieve the available time slot start at or later than this time. If not provided, the system uses the current time as the start time. Time format: yyyy-mm-dd hh:mm:ss: string",
6756
+ "required": false,
6757
+ "schema": {
6758
+ "title": "plannedStartTime",
6759
+ "type": "string"
6760
+ }
6761
+ },
6762
+ {
6763
+ "name": "iapMetadata",
6764
+ "type": "object",
6765
+ "info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
6766
+ "required": false,
6767
+ "schema": {
6768
+ "title": "iapMetadata",
6769
+ "type": "object"
6770
+ }
6771
+ }
6772
+ ],
6773
+ "output": {
6774
+ "name": "result",
6775
+ "type": "object",
6776
+ "description": "A JSON Object containing status, code and the result",
6777
+ "schema": {
6778
+ "title": "result",
6779
+ "type": "object"
6780
+ }
6781
+ },
6782
+ "roles": [
6783
+ "admin"
6784
+ ],
6785
+ "route": {
6786
+ "verb": "POST",
6787
+ "path": "/getConfigurationItemSchedule"
6788
+ },
6789
+ "task": true
6790
+ },
6791
+ {
6792
+ "name": "updateEmergencyChangeRequestById",
6793
+ "summary": "Updates the emergency change request identified by the specified sys_id with the key-value pairs in",
6794
+ "description": "Updates the emergency change request identified by the specified sys_id with the key-value pairs in the request body or the URL.",
6795
+ "input": [
6796
+ {
6797
+ "name": "sysId",
6798
+ "type": "string",
6799
+ "info": "Sys_id of the change request to modify. Located in the [change_request] table.: string",
6800
+ "required": true,
6801
+ "schema": {
6802
+ "title": "sysId",
6803
+ "type": "string"
6804
+ }
6805
+ },
6806
+ {
6807
+ "name": "sysparmQueryKeyValuePairs",
6808
+ "type": "object",
6809
+ "info": "e.g. { number: 'CHG12345' }: object",
6810
+ "required": false,
6811
+ "schema": {
6812
+ "title": "sysparmQuery",
6813
+ "type": "object"
6814
+ }
6815
+ },
6816
+ {
6817
+ "name": "sysparmQueryString",
6818
+ "type": "string",
6819
+ "info": "e.g. number=CHG12345: string",
6820
+ "required": false,
6821
+ "schema": {
6822
+ "title": "sysparmQuery",
6823
+ "type": "string"
6824
+ }
6825
+ },
6826
+ {
6827
+ "name": "body",
6828
+ "type": "object",
6829
+ "info": ": object",
6830
+ "required": true,
6831
+ "schema": {
6832
+ "title": "body",
6833
+ "type": "object"
6834
+ }
6835
+ },
6836
+ {
6837
+ "name": "iapMetadata",
6838
+ "type": "object",
6839
+ "info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
6840
+ "required": false,
6841
+ "schema": {
6842
+ "title": "iapMetadata",
6843
+ "type": "object"
6844
+ }
6845
+ }
6846
+ ],
6847
+ "output": {
6848
+ "name": "result",
6849
+ "type": "object",
6850
+ "description": "A JSON Object containing status, code and the result",
6851
+ "schema": {
6852
+ "title": "result",
6853
+ "type": "object"
6854
+ }
6855
+ },
6856
+ "roles": [
6857
+ "admin"
6858
+ ],
6859
+ "route": {
6860
+ "verb": "POST",
6861
+ "path": "/updateEmergencyChangeRequestById"
6862
+ },
6863
+ "task": true
6864
+ },
6865
+ {
6866
+ "name": "getChangeModel",
6867
+ "summary": "Retrieves one or more change models based on the specified criteria.",
6868
+ "description": "Retrieves one or more change models based on the specified criteria.",
6869
+ "input": [
6870
+ {
6871
+ "name": "sysparmQueryKeyValuePairs",
6872
+ "type": "object",
6873
+ "info": "e.g. { number: 'CHG12345' }: object",
6874
+ "required": false,
6875
+ "schema": {
6876
+ "title": "sysparmQuery",
6877
+ "type": "object"
6878
+ }
6879
+ },
6880
+ {
6881
+ "name": "sysparmQueryString",
6882
+ "type": "string",
6883
+ "info": "e.g. number=CHG12345: string",
6884
+ "required": false,
6885
+ "schema": {
6886
+ "title": "sysparmQuery",
6887
+ "type": "string"
6888
+ }
6889
+ },
6890
+ {
6891
+ "name": "order",
6892
+ "type": "string",
6893
+ "info": "Field by which to sort the returned change models.: string",
6894
+ "required": false,
6895
+ "schema": {
6896
+ "title": "order",
6897
+ "type": "string"
6898
+ }
6899
+ },
6900
+ {
6901
+ "name": "sysparmOffset",
6902
+ "type": "number",
6903
+ "info": "Starting record index for which to begin retrieving records. Use this value to paginate record retrieval. This functionality enables the retrieval of all records, regardl...(description truncated): 123",
6904
+ "required": false,
6905
+ "schema": {
6906
+ "title": "sysparmOffset",
6907
+ "type": "number"
6908
+ }
6909
+ },
6910
+ {
6911
+ "name": "textSearch",
6912
+ "type": "string",
6913
+ "info": "String to use to search all change model record fields. This search uses ServiceNow full text search platform functionality.: string",
6914
+ "required": false,
6915
+ "schema": {
6916
+ "title": "textSearch",
6917
+ "type": "string"
6918
+ }
6919
+ },
6920
+ {
6921
+ "name": "iapMetadata",
6922
+ "type": "object",
6923
+ "info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
6924
+ "required": false,
6925
+ "schema": {
6926
+ "title": "iapMetadata",
6927
+ "type": "object"
6928
+ }
6929
+ }
6930
+ ],
6931
+ "output": {
6932
+ "name": "result",
6933
+ "type": "object",
6934
+ "description": "A JSON Object containing status, code and the result",
6935
+ "schema": {
6936
+ "title": "result",
6937
+ "type": "object"
6938
+ }
6939
+ },
6940
+ "roles": [
6941
+ "admin"
6942
+ ],
6943
+ "route": {
6944
+ "verb": "POST",
6945
+ "path": "/getChangeModel"
6946
+ },
6947
+ "task": true
6948
+ },
6949
+ {
6950
+ "name": "getChangeModelById",
6951
+ "summary": "Retrieves the change model identified by the specified sys_id.",
6952
+ "description": "Retrieves the change model identified by the specified sys_id.",
6953
+ "input": [
6954
+ {
6955
+ "name": "sysId",
6956
+ "type": "string",
6957
+ "info": "Sys_id of the change model record to retrieve from the Change Model [chg_model] table.: string",
6958
+ "required": true,
6959
+ "schema": {
6960
+ "title": "sysId",
6961
+ "type": "string"
6962
+ }
6963
+ },
6964
+ {
6965
+ "name": "iapMetadata",
6966
+ "type": "object",
6967
+ "info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
6968
+ "required": false,
6969
+ "schema": {
6970
+ "title": "iapMetadata",
6971
+ "type": "object"
6972
+ }
6973
+ }
6974
+ ],
6975
+ "output": {
6976
+ "name": "result",
6977
+ "type": "object",
6978
+ "description": "A JSON Object containing status, code and the result",
6979
+ "schema": {
6980
+ "title": "result",
6981
+ "type": "object"
6982
+ }
6983
+ },
6984
+ "roles": [
6985
+ "admin"
6986
+ ],
6987
+ "route": {
6988
+ "verb": "POST",
6989
+ "path": "/getChangeModelById"
6990
+ },
6991
+ "task": true
6992
+ },
6993
+ {
6994
+ "name": "getChangeWorkerById",
6995
+ "summary": "Retrieves the current status, information, and errors for the specified asynchronous worker.",
6996
+ "description": "Retrieves the current status, information, and errors for the specified asynchronous worker.",
6997
+ "input": [
6998
+ {
6999
+ "name": "sysId",
7000
+ "type": "string",
7001
+ "info": "Sys_id of the change management asynchronous worker. Located in the Change Management Worker [chg_mgt_worker] table.: string",
7002
+ "required": true,
7003
+ "schema": {
7004
+ "title": "sysId",
7005
+ "type": "string"
7006
+ }
7007
+ },
7008
+ {
7009
+ "name": "iapMetadata",
7010
+ "type": "object",
7011
+ "info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
7012
+ "required": false,
7013
+ "schema": {
7014
+ "title": "iapMetadata",
7015
+ "type": "object"
7016
+ }
7017
+ }
7018
+ ],
7019
+ "output": {
7020
+ "name": "result",
7021
+ "type": "object",
7022
+ "description": "A JSON Object containing status, code and the result",
7023
+ "schema": {
7024
+ "title": "result",
7025
+ "type": "object"
7026
+ }
7027
+ },
7028
+ "roles": [
7029
+ "admin"
7030
+ ],
7031
+ "route": {
7032
+ "verb": "POST",
7033
+ "path": "/getChangeWorkerById"
7034
+ },
7035
+ "task": true
7036
+ },
7037
+ {
7038
+ "name": "updateChangeRequestById",
7039
+ "summary": "Updates the change request identified by the specified sys_id with the key-value pairs in the reque",
7040
+ "description": "Updates the change request identified by the specified sys_id with the key-value pairs in the request body or URL.",
7041
+ "input": [
7042
+ {
7043
+ "name": "sysId",
7044
+ "type": "string",
7045
+ "info": "Sys_id of the change request to modify. Located in the Change Request [change_request] table.: string",
7046
+ "required": true,
7047
+ "schema": {
7048
+ "title": "sysId",
7049
+ "type": "string"
7050
+ }
7051
+ },
7052
+ {
7053
+ "name": "sysparmQueryKeyValuePairs",
7054
+ "type": "object",
7055
+ "info": "e.g. { number: 'CHG12345' }: object",
7056
+ "required": false,
7057
+ "schema": {
7058
+ "title": "sysparmQuery",
7059
+ "type": "object"
7060
+ }
7061
+ },
7062
+ {
7063
+ "name": "sysparmQueryString",
7064
+ "type": "string",
7065
+ "info": "e.g. number=CHG12345: string",
7066
+ "required": false,
7067
+ "schema": {
7068
+ "title": "sysparmQuery",
7069
+ "type": "string"
7070
+ }
7071
+ },
7072
+ {
7073
+ "name": "encryptedFields",
7074
+ "type": "string",
7075
+ "info": "List of comma-separated fields to encrypt. These fields are encrypted before they are stored in the associated record. When specified, the endpoint calls the GlideRecord ...(description truncated): string",
7076
+ "required": false,
7077
+ "schema": {
7078
+ "title": "encryptedFields",
7079
+ "type": "string"
7080
+ }
7081
+ },
7082
+ {
7083
+ "name": "body",
7084
+ "type": "object",
7085
+ "info": ": object",
7086
+ "required": true,
7087
+ "schema": {
7088
+ "title": "body",
7089
+ "type": "object"
7090
+ }
7091
+ },
7092
+ {
7093
+ "name": "iapMetadata",
7094
+ "type": "object",
7095
+ "info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
7096
+ "required": false,
7097
+ "schema": {
7098
+ "title": "iapMetadata",
7099
+ "type": "object"
7100
+ }
7101
+ }
7102
+ ],
7103
+ "output": {
7104
+ "name": "result",
7105
+ "type": "object",
7106
+ "description": "A JSON Object containing status, code and the result",
7107
+ "schema": {
7108
+ "title": "result",
7109
+ "type": "object"
7110
+ }
7111
+ },
7112
+ "roles": [
7113
+ "admin"
7114
+ ],
7115
+ "route": {
7116
+ "verb": "POST",
7117
+ "path": "/updateChangeRequestById"
7118
+ },
7119
+ "task": true
7120
+ },
7121
+ {
7122
+ "name": "deleteChangeRequestById",
7123
+ "summary": "Deletes the change request associated with the specified sys_id.",
7124
+ "description": "Deletes the change request associated with the specified sys_id.",
7125
+ "input": [
7126
+ {
7127
+ "name": "sysId",
7128
+ "type": "string",
7129
+ "info": "Sys_id of the change request record to delete. Located in the Change Request [change_request] table.: string",
7130
+ "required": true,
7131
+ "schema": {
7132
+ "title": "sysId",
7133
+ "type": "string"
7134
+ }
7135
+ },
7136
+ {
7137
+ "name": "iapMetadata",
7138
+ "type": "object",
7139
+ "info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
7140
+ "required": false,
7141
+ "schema": {
7142
+ "title": "iapMetadata",
7143
+ "type": "object"
7144
+ }
7145
+ }
7146
+ ],
7147
+ "output": {
7148
+ "name": "result",
7149
+ "type": "object",
7150
+ "description": "A JSON Object containing status, code and the result",
7151
+ "schema": {
7152
+ "title": "result",
7153
+ "type": "object"
7154
+ }
7155
+ },
7156
+ "roles": [
7157
+ "admin"
7158
+ ],
7159
+ "route": {
7160
+ "verb": "POST",
7161
+ "path": "/deleteChangeRequestById"
7162
+ },
7163
+ "task": true
7164
+ },
7165
+ {
7166
+ "name": "getChangeRequestRecordById",
7167
+ "summary": "Retrieves the change request identified by the specified sys_id.",
7168
+ "description": "Retrieves the change request identified by the specified sys_id.",
7169
+ "input": [
7170
+ {
7171
+ "name": "sysId",
7172
+ "type": "string",
7173
+ "info": "Sys_id of the change request record to retrieve from Change Request [change_request] table.: string",
7174
+ "required": true,
7175
+ "schema": {
7176
+ "title": "sysId",
7177
+ "type": "string"
7178
+ }
7179
+ },
7180
+ {
7181
+ "name": "iapMetadata",
7182
+ "type": "object",
7183
+ "info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
7184
+ "required": false,
7185
+ "schema": {
7186
+ "title": "iapMetadata",
7187
+ "type": "object"
7188
+ }
7189
+ }
7190
+ ],
7191
+ "output": {
7192
+ "name": "result",
7193
+ "type": "object",
7194
+ "description": "A JSON Object containing status, code and the result",
7195
+ "schema": {
7196
+ "title": "result",
7197
+ "type": "object"
7198
+ }
7199
+ },
7200
+ "roles": [
7201
+ "admin"
7202
+ ],
7203
+ "route": {
7204
+ "verb": "POST",
7205
+ "path": "/getChangeRequestRecordById"
7206
+ },
7207
+ "task": true
7208
+ },
7209
+ {
7210
+ "name": "addChangeRequestConfigurationItem",
7211
+ "summary": "Creates the association between a change request and Configuration Management Database (CMDB) confi",
7212
+ "description": "Creates the association between a change request and Configuration Management Database (CMDB) configuration items (CI).",
7213
+ "input": [
7214
+ {
7215
+ "name": "changeSysId",
7216
+ "type": "string",
7217
+ "info": "Change_Sys_id of the change request to associate with the CMDB CI.: string",
7218
+ "required": true,
7219
+ "schema": {
7220
+ "title": "changeSysId",
7221
+ "type": "string"
7222
+ }
7223
+ },
7224
+ {
7225
+ "name": "body",
7226
+ "type": "object",
7227
+ "info": ": object",
7228
+ "required": true,
7229
+ "schema": {
7230
+ "title": "body",
7231
+ "type": "object"
7232
+ }
7233
+ },
7234
+ {
7235
+ "name": "iapMetadata",
7236
+ "type": "object",
7237
+ "info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
7238
+ "required": false,
7239
+ "schema": {
7240
+ "title": "iapMetadata",
7241
+ "type": "object"
7242
+ }
7243
+ }
7244
+ ],
7245
+ "output": {
7246
+ "name": "result",
7247
+ "type": "object",
7248
+ "description": "A JSON Object containing status, code and the result",
7249
+ "schema": {
7250
+ "title": "result",
7251
+ "type": "object"
7252
+ }
7253
+ },
7254
+ "roles": [
7255
+ "admin"
7256
+ ],
7257
+ "route": {
7258
+ "verb": "POST",
7259
+ "path": "/addChangeRequestConfigurationItem"
7260
+ },
7261
+ "task": true
7262
+ },
7263
+ {
7264
+ "name": "getChangeRequestConfigurationItems",
7265
+ "summary": "Retrieves multiple configuration items (CIs) associated to a specified change request based on the",
7266
+ "description": "Retrieves multiple configuration items (CIs) associated to a specified change request based on the specified association type.",
7267
+ "input": [
7268
+ {
7269
+ "name": "changeSysId",
7270
+ "type": "string",
7271
+ "info": "Sys_id of the change request for which to return the associated CMDB CIs.: string",
7272
+ "required": true,
7273
+ "schema": {
7274
+ "title": "changeSysId",
7275
+ "type": "string"
7276
+ }
7277
+ },
7278
+ {
7279
+ "name": "associationType",
7280
+ "type": "string",
7281
+ "info": "Type of association between the CMDB CI and the change request.: string",
7282
+ "required": false,
7283
+ "schema": {
7284
+ "title": "associationType",
7285
+ "type": "string"
7286
+ }
7287
+ },
7288
+ {
7289
+ "name": "sysparmQueryKeyValuePairs",
7290
+ "type": "object",
7291
+ "info": "e.g. { number: 'CHG12345' }: object",
7292
+ "required": false,
7293
+ "schema": {
7294
+ "title": "sysparmQuery",
7295
+ "type": "object"
7296
+ }
7297
+ },
7298
+ {
7299
+ "name": "sysparmQueryString",
7300
+ "type": "string",
7301
+ "info": "e.g. number=CHG12345: string",
7302
+ "required": false,
7303
+ "schema": {
7304
+ "title": "sysparmQuery",
7305
+ "type": "string"
7306
+ }
7307
+ },
7308
+ {
7309
+ "name": "sysparmLimit",
7310
+ "type": "number",
7311
+ "info": "Maximum number of records to return. For requests that exceed this number of records, use the sysparm_offset parameter to paginate record retrieval.: 123",
7312
+ "required": false,
7313
+ "schema": {
7314
+ "title": "sysparmLimit",
7315
+ "type": "number"
7316
+ }
7317
+ },
7318
+ {
7319
+ "name": "sysparmOffset",
7320
+ "type": "number",
7321
+ "info": "Starting record index for which to begin retrieving records. Use this value to paginate record retrieval. This functionality enables the retrieval of all records, regardl...(description truncated): 123",
7322
+ "required": false,
7323
+ "schema": {
7324
+ "title": "sysparmOffset",
7325
+ "type": "number"
7326
+ }
7327
+ },
7328
+ {
7329
+ "name": "iapMetadata",
7330
+ "type": "object",
7331
+ "info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
7332
+ "required": false,
7333
+ "schema": {
7334
+ "title": "iapMetadata",
7335
+ "type": "object"
7336
+ }
7337
+ }
7338
+ ],
7339
+ "output": {
7340
+ "name": "result",
7341
+ "type": "object",
7342
+ "description": "A JSON Object containing status, code and the result",
7343
+ "schema": {
7344
+ "title": "result",
7345
+ "type": "object"
7346
+ }
7347
+ },
7348
+ "roles": [
7349
+ "admin"
7350
+ ],
7351
+ "route": {
7352
+ "verb": "POST",
7353
+ "path": "/getChangeRequestConfigurationItems"
7354
+ },
7355
+ "task": true
7356
+ },
7357
+ {
7358
+ "name": "getChangeRequestNextStates",
7359
+ "summary": "Retrieves a list of available states for the specified change request, including the current state.",
7360
+ "description": "Retrieves a list of available states for the specified change request, including the current state.",
7361
+ "input": [
7362
+ {
7363
+ "name": "changeSysId",
7364
+ "type": "string",
7365
+ "info": "Sys_id of the change request. Located in the Change Request [change_request] table.: string",
7366
+ "required": true,
7367
+ "schema": {
7368
+ "title": "changeSysId",
7369
+ "type": "string"
7370
+ }
7371
+ },
7372
+ {
7373
+ "name": "iapMetadata",
7374
+ "type": "object",
7375
+ "info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
7376
+ "required": false,
7377
+ "schema": {
7378
+ "title": "iapMetadata",
7379
+ "type": "object"
7380
+ }
7381
+ }
7382
+ ],
7383
+ "output": {
7384
+ "name": "result",
7385
+ "type": "object",
7386
+ "description": "A JSON Object containing status, code and the result",
7387
+ "schema": {
7388
+ "title": "result",
7389
+ "type": "object"
7390
+ }
7391
+ },
7392
+ "roles": [
7393
+ "admin"
7394
+ ],
7395
+ "route": {
7396
+ "verb": "POST",
7397
+ "path": "/getChangeRequestNextStates"
7398
+ },
7399
+ "task": true
7400
+ },
7401
+ {
7402
+ "name": "refreshChangeRequestImpactedServices",
7403
+ "summary": "Populates the impacted services/configuration items (CIs) related list based on the primary CI.",
7404
+ "description": "Populates the impacted services/configuration items (CIs) related list based on the primary CI.",
7405
+ "input": [
7406
+ {
7407
+ "name": "changeSysId",
7408
+ "type": "string",
7409
+ "info": "Change_Sys_id of the change request to use to refresh the impacted services.: string",
7410
+ "required": true,
7411
+ "schema": {
7412
+ "title": "changeSysId",
7413
+ "type": "string"
7414
+ }
7415
+ },
7416
+ {
7417
+ "name": "body",
7418
+ "type": "object",
7419
+ "info": ": object",
7420
+ "required": true,
7421
+ "schema": {
7422
+ "title": "body",
7423
+ "type": "object"
7424
+ }
7425
+ },
7426
+ {
7427
+ "name": "iapMetadata",
7428
+ "type": "object",
7429
+ "info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
7430
+ "required": false,
7431
+ "schema": {
7432
+ "title": "iapMetadata",
7433
+ "type": "object"
7434
+ }
7435
+ }
7436
+ ],
7437
+ "output": {
7438
+ "name": "result",
7439
+ "type": "object",
7440
+ "description": "A JSON Object containing status, code and the result",
7441
+ "schema": {
7442
+ "title": "result",
7443
+ "type": "object"
7444
+ }
7445
+ },
7446
+ "roles": [
7447
+ "admin"
7448
+ ],
7449
+ "route": {
7450
+ "verb": "POST",
7451
+ "path": "/refreshChangeRequestImpactedServices"
7452
+ },
7453
+ "task": true
7454
+ },
7455
+ {
7456
+ "name": "getChangeRequestSchedule",
7457
+ "summary": "Enables retrieving the available time slots for a change request.",
7458
+ "description": "Enables retrieving the available time slots for a change request.",
7459
+ "input": [
7460
+ {
7461
+ "name": "changeSysId",
7462
+ "type": "string",
7463
+ "info": "Sys_id of the change request on which to find the next available time slot. Located in the [change_request] table. The selected change request must have a configuration i...(description truncated): string",
7464
+ "required": true,
7465
+ "schema": {
7466
+ "title": "changeSysId",
7467
+ "type": "string"
7468
+ }
7469
+ },
7470
+ {
7471
+ "name": "iapMetadata",
7472
+ "type": "object",
7473
+ "info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
7474
+ "required": false,
7475
+ "schema": {
7476
+ "title": "iapMetadata",
7477
+ "type": "object"
7478
+ }
7479
+ }
7480
+ ],
7481
+ "output": {
7482
+ "name": "result",
7483
+ "type": "object",
7484
+ "description": "A JSON Object containing status, code and the result",
7485
+ "schema": {
7486
+ "title": "result",
7487
+ "type": "object"
7488
+ }
7489
+ },
7490
+ "roles": [
7491
+ "admin"
7492
+ ],
7493
+ "route": {
7494
+ "verb": "POST",
7495
+ "path": "/getChangeRequestSchedule"
7496
+ },
7497
+ "task": true
7498
+ },
7499
+ {
7500
+ "name": "updateChangeRequestFirstAvailableSchedule",
7501
+ "summary": "Updates the planned start and end times of a change request using the first available time slot fou",
7502
+ "description": "Updates the planned start and end times of a change request using the first available time slot found.",
7503
+ "input": [
7504
+ {
7505
+ "name": "changeSysId",
7506
+ "type": "string",
7507
+ "info": "Sys_id of the change request on which to update with the next available time slot. Located in the Change Requests [change_request] table. The selected change request must...(description truncated): string",
7508
+ "required": true,
7509
+ "schema": {
7510
+ "title": "changeSysId",
7511
+ "type": "string"
7512
+ }
7513
+ },
7514
+ {
7515
+ "name": "body",
7516
+ "type": "object",
7517
+ "info": ": object",
7518
+ "required": true,
7519
+ "schema": {
7520
+ "title": "body",
7521
+ "type": "object"
7522
+ }
7523
+ },
7524
+ {
7525
+ "name": "iapMetadata",
7526
+ "type": "object",
7527
+ "info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
7528
+ "required": false,
7529
+ "schema": {
7530
+ "title": "iapMetadata",
7531
+ "type": "object"
7532
+ }
7533
+ }
7534
+ ],
7535
+ "output": {
7536
+ "name": "result",
7537
+ "type": "object",
7538
+ "description": "A JSON Object containing status, code and the result",
7539
+ "schema": {
7540
+ "title": "result",
7541
+ "type": "object"
7542
+ }
7543
+ },
7544
+ "roles": [
7545
+ "admin"
7546
+ ],
7547
+ "route": {
7548
+ "verb": "POST",
7549
+ "path": "/updateChangeRequestFirstAvailableSchedule"
7550
+ },
7551
+ "task": true
7552
+ },
7553
+ {
7554
+ "name": "updateChangeTaskByTaskId",
7555
+ "summary": "Updates the change request task identified by the specified sys_ids with the key-value pairs in the",
7556
+ "description": "Updates the change request task identified by the specified sys_ids with the key-value pairs in the request body or the URL.",
7557
+ "input": [
7558
+ {
7559
+ "name": "changeSysId",
7560
+ "type": "string",
7561
+ "info": "Sys_id of the change request to which the task is associated. Verifies whether the specified task is associated with the specified change request. Located in the Change R...(description truncated): string",
7562
+ "required": true,
7563
+ "schema": {
7564
+ "title": "changeSysId",
7565
+ "type": "string"
7566
+ }
7567
+ },
7568
+ {
7569
+ "name": "taskSysId",
7570
+ "type": "string",
7571
+ "info": "Sys_id of the task to modify. Located in the Change Task [change_task] table.: string",
7572
+ "required": true,
7573
+ "schema": {
7574
+ "title": "taskSysId",
7575
+ "type": "string"
7576
+ }
7577
+ },
7578
+ {
7579
+ "name": "sysparmQueryKeyValuePairs",
7580
+ "type": "object",
7581
+ "info": "e.g. { number: 'CHG12345' }: object",
7582
+ "required": false,
7583
+ "schema": {
7584
+ "title": "sysparmQuery",
7585
+ "type": "object"
7586
+ }
7587
+ },
7588
+ {
7589
+ "name": "sysparmQueryString",
7590
+ "type": "string",
7591
+ "info": "e.g. number=CHG12345: string",
7592
+ "required": false,
7593
+ "schema": {
7594
+ "title": "sysparmQuery",
7595
+ "type": "string"
7596
+ }
7597
+ },
7598
+ {
7599
+ "name": "body",
7600
+ "type": "object",
7601
+ "info": ": object",
7602
+ "required": true,
7603
+ "schema": {
7604
+ "title": "body",
7605
+ "type": "object"
7606
+ }
7607
+ },
7608
+ {
7609
+ "name": "iapMetadata",
7610
+ "type": "object",
7611
+ "info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
7612
+ "required": false,
7613
+ "schema": {
7614
+ "title": "iapMetadata",
7615
+ "type": "object"
7616
+ }
7617
+ }
7618
+ ],
7619
+ "output": {
7620
+ "name": "result",
7621
+ "type": "object",
7622
+ "description": "A JSON Object containing status, code and the result",
7623
+ "schema": {
7624
+ "title": "result",
7625
+ "type": "object"
7626
+ }
7627
+ },
7628
+ "roles": [
7629
+ "admin"
7630
+ ],
7631
+ "route": {
7632
+ "verb": "POST",
7633
+ "path": "/updateChangeTaskByTaskId"
7634
+ },
7635
+ "task": true
7636
+ },
7637
+ {
7638
+ "name": "updateChangeRequestRisk",
7639
+ "summary": "Calculates the risk and impact of the specified standard change based on an evaluation of the risk",
7640
+ "description": "Calculates the risk and impact of the specified standard change based on an evaluation of the risk conditions.",
7641
+ "input": [
7642
+ {
7643
+ "name": "sysId",
7644
+ "type": "string",
7645
+ "info": "Sys_id of the standard change to evaluate. Located in the Change Request [change_request] table.: string",
7646
+ "required": true,
7647
+ "schema": {
7648
+ "title": "sysId",
7649
+ "type": "string"
7650
+ }
7651
+ },
7652
+ {
7653
+ "name": "body",
7654
+ "type": "object",
7655
+ "info": ": object",
7656
+ "required": true,
7657
+ "schema": {
7658
+ "title": "body",
7659
+ "type": "object"
7660
+ }
7661
+ },
7662
+ {
7663
+ "name": "iapMetadata",
7664
+ "type": "object",
7665
+ "info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
7666
+ "required": false,
7667
+ "schema": {
7668
+ "title": "iapMetadata",
7669
+ "type": "object"
7670
+ }
7671
+ }
7672
+ ],
7673
+ "output": {
7674
+ "name": "result",
7675
+ "type": "object",
7676
+ "description": "A JSON Object containing status, code and the result",
7677
+ "schema": {
7678
+ "title": "result",
7679
+ "type": "object"
7680
+ }
7681
+ },
7682
+ "roles": [
7683
+ "admin"
7684
+ ],
7685
+ "route": {
7686
+ "verb": "POST",
7687
+ "path": "/updateChangeRequestRisk"
7688
+ },
7689
+ "task": true
7690
+ },
7691
+ {
7692
+ "name": "updateStandardChangeRequestById",
7693
+ "summary": "Updates the standard change request identified by the specified sys_id with the parameters in the r",
7694
+ "description": "Updates the standard change request identified by the specified sys_id with the parameters in the request body or in the URL.",
7695
+ "input": [
7696
+ {
7697
+ "name": "sysId",
7698
+ "type": "string",
7699
+ "info": "Sys_id of the change request to modify. Located in the [change_request] table.: string",
7700
+ "required": true,
7701
+ "schema": {
7702
+ "title": "sysId",
7703
+ "type": "string"
7704
+ }
7705
+ },
7706
+ {
7707
+ "name": "sysparmQueryKeyValuePairs",
7708
+ "type": "object",
7709
+ "info": "e.g. { number: 'CHG12345' }: object",
7710
+ "required": false,
7711
+ "schema": {
7712
+ "title": "sysparmQuery",
7713
+ "type": "object"
7714
+ }
7715
+ },
7716
+ {
7717
+ "name": "sysparmQueryString",
7718
+ "type": "string",
7719
+ "info": "e.g. number=CHG12345: string",
7720
+ "required": false,
7721
+ "schema": {
7722
+ "title": "sysparmQuery",
7723
+ "type": "string"
7724
+ }
7725
+ },
7726
+ {
7727
+ "name": "body",
7728
+ "type": "object",
7729
+ "info": ": object",
7730
+ "required": true,
7731
+ "schema": {
7732
+ "title": "body",
7733
+ "type": "object"
7734
+ }
7735
+ },
7736
+ {
7737
+ "name": "iapMetadata",
7738
+ "type": "object",
7739
+ "info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
7740
+ "required": false,
7741
+ "schema": {
7742
+ "title": "iapMetadata",
7743
+ "type": "object"
7744
+ }
7745
+ }
7746
+ ],
7747
+ "output": {
7748
+ "name": "result",
7749
+ "type": "object",
7750
+ "description": "A JSON Object containing status, code and the result",
7751
+ "schema": {
7752
+ "title": "result",
7753
+ "type": "object"
7754
+ }
7755
+ },
7756
+ "roles": [
7757
+ "admin"
7758
+ ],
7759
+ "route": {
7760
+ "verb": "POST",
7761
+ "path": "/updateStandardChangeRequestById"
7762
+ },
7763
+ "task": true
6548
7764
  }
6549
7765
  ]
6550
7766
  }