node-autotask 0.76.0 → 0.78.0
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.
- package/CHANGELOG.md +12 -0
- package/MCP_TOOL_CATALOG.json +265 -9
- package/README.md +1 -1
- package/capabilities.json +1224 -272
- package/dist/capabilities-data.js +1223 -271
- package/dist/capabilities.cjs +4 -4
- package/dist/capabilities.js +1 -1
- package/dist/{chunk-S7QPD6TR.js → chunk-3SYNF5QD.js} +2 -2
- package/dist/{chunk-C4S3EKIK.cjs → chunk-MVKI2AZX.cjs} +3 -3
- package/dist/{chunk-UFK7JYYC.js → chunk-S7BJNQ2X.js} +4 -2
- package/dist/{chunk-Y4BH5N6R.cjs → chunk-S7JH6K2Z.cjs} +331 -28
- package/dist/{chunk-YRTOAPWD.cjs → chunk-U7LVWEO4.cjs} +199 -199
- package/dist/{chunk-3SFIKG2R.js → chunk-XBT332X7.js} +326 -23
- package/dist/{chunk-ECSE6B3U.js → chunk-YH5UCY2X.js} +3 -3
- package/dist/{chunk-55BQEFBO.cjs → chunk-YONRIG6F.cjs} +32 -30
- package/dist/{index-BbAzrm2i.d.cts → index-BHqdOo_5.d.cts} +91 -1
- package/dist/{index-BbAzrm2i.d.ts → index-BHqdOo_5.d.ts} +91 -1
- package/dist/{index-MY7qYY5d.d.cts → index-DfcdtQO0.d.cts} +4 -2
- package/dist/{index-CY7exGOe.d.ts → index-ci3TSJrT.d.ts} +4 -2
- package/dist/index.cjs +84 -84
- package/dist/index.d.cts +3 -3
- package/dist/index.d.ts +3 -3
- package/dist/index.js +5 -5
- package/dist/operations/index.cjs +51 -51
- package/dist/operations/index.d.cts +4 -4
- package/dist/operations/index.d.ts +4 -4
- package/dist/operations/index.js +2 -2
- package/dist/pool.cjs +12 -12
- package/dist/pool.d.cts +1 -1
- package/dist/pool.d.ts +1 -1
- package/dist/pool.js +4 -4
- package/dist/resources/index.cjs +27 -27
- package/dist/resources/index.d.cts +2 -2
- package/dist/resources/index.d.ts +2 -2
- package/dist/resources/index.js +3 -3
- package/dist/types/index.d.cts +1 -1
- package/dist/types/index.d.ts +1 -1
- package/docs/API.md +4 -2
- package/package.json +1 -1
package/capabilities.json
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
{
|
|
2
|
-
"generatedAt": "2026-11-
|
|
2
|
+
"generatedAt": "2026-11-19T06:42:18.413Z",
|
|
3
3
|
"groups": {
|
|
4
4
|
"B": {
|
|
5
|
-
"planHash": "
|
|
6
|
-
"builtAt": "2026-11-
|
|
5
|
+
"planHash": "a84c111cf8c415f470fc48dff7ad406f0f67ee9c2a8d75f963e4812e5a2577b2",
|
|
6
|
+
"builtAt": "2026-11-19T06:42:18.402Z",
|
|
7
7
|
"records": [
|
|
8
8
|
{
|
|
9
9
|
"id": "appointments.count",
|
|
@@ -42918,8 +42918,8 @@
|
|
|
42918
42918
|
]
|
|
42919
42919
|
},
|
|
42920
42920
|
"A": {
|
|
42921
|
-
"planHash": "
|
|
42922
|
-
"builtAt": "2026-11-
|
|
42921
|
+
"planHash": "a84c111cf8c415f470fc48dff7ad406f0f67ee9c2a8d75f963e4812e5a2577b2",
|
|
42922
|
+
"builtAt": "2026-11-19T06:42:18.403Z",
|
|
42923
42923
|
"records": [
|
|
42924
42924
|
{
|
|
42925
42925
|
"id": "attachment_info.count",
|
|
@@ -49225,12 +49225,12 @@
|
|
|
49225
49225
|
"status": "tested"
|
|
49226
49226
|
},
|
|
49227
49227
|
{
|
|
49228
|
-
"id": "
|
|
49229
|
-
"resource": "
|
|
49228
|
+
"id": "configuration_item_attachments.count",
|
|
49229
|
+
"resource": "configuration_item_attachments",
|
|
49230
49230
|
"udfCapable": false,
|
|
49231
49231
|
"operation": "count",
|
|
49232
49232
|
"kind": "primitive",
|
|
49233
|
-
"endpoint": "GET|POST /V1.0/
|
|
49233
|
+
"endpoint": "GET|POST /V1.0/ConfigurationItemAttachments/query/count",
|
|
49234
49234
|
"effect": "read",
|
|
49235
49235
|
"flags": [],
|
|
49236
49236
|
"dryRun": false,
|
|
@@ -49260,7 +49260,7 @@
|
|
|
49260
49260
|
"drops": []
|
|
49261
49261
|
},
|
|
49262
49262
|
"examples": [
|
|
49263
|
-
"await client.
|
|
49263
|
+
"await invoke(client, 'configuration_item_attachments.count', [{ filter: [{ field: 'configurationItemID', op: 'eq', value: 7 }] }])"
|
|
49264
49264
|
],
|
|
49265
49265
|
"permissions": "unknown",
|
|
49266
49266
|
"pagination": {
|
|
@@ -49274,24 +49274,27 @@
|
|
|
49274
49274
|
"set": 0
|
|
49275
49275
|
},
|
|
49276
49276
|
"metadata": {
|
|
49277
|
-
"purpose": "Count
|
|
49278
|
-
"usage": "Unwraps queryCount; returns a plain number.",
|
|
49277
|
+
"purpose": "Count configuration item attachment records matching a JSON filter. Use configurationItemID for item scope.",
|
|
49278
|
+
"usage": "Unwraps queryCount; returns a plain number. Include an object-specific configurationItemID filter. configurationItemNoteID is a separate read-only association; do not substitute it for the path parent. creatorType, data and fileSize are not queryable. Object-specific filters do not establish exact direct-parent attachment membership; an empty result is conditional on API-user permissions and visibility.",
|
|
49279
49279
|
"preferredWhen": null,
|
|
49280
49280
|
"related": [
|
|
49281
|
-
"
|
|
49281
|
+
"configuration_item_attachments.query"
|
|
49282
49282
|
],
|
|
49283
|
-
"args": "args[0] is a params object (CLOSED — unknown keys are refused pre-request): { filter?: FilterCondition[], fieldCheck?: boolean } — filter is the only parameter sent to the vendor (the count endpoint takes no MaxRecords/IncludeFields; fieldCheck is consumed by the invoke router — never sent to the vendor). Filter condition field names are name-checked pre-request the same way as the query bag: a refusal costs zero /query/count wire (the cold fieldCache may cost the one authority metadata GET first). fieldCheck: false disables the name check (a non-boolean is refused pre-request; the shape/grammar checks always run) — the opt-out works on the count verb too. Filter grammar: 13 operators: eq, noteq, gt, gte, lt, lte, beginsWith, endsWith, contains, exist, notExist, in, notIn (in/notIn: array or '1,2,3') + and/or grouping (no not-group). Field names in vendor API casing — get them via operations.fieldCatalog. Caps: 500 OR-conditions / 1 UDF / 8000 chars."
|
|
49283
|
+
"args": "args[0] is a params object (CLOSED — unknown keys are refused pre-request): { filter?: FilterCondition[], fieldCheck?: boolean } — filter is the only parameter sent to the vendor (the count endpoint takes no MaxRecords/IncludeFields; fieldCheck is consumed by the invoke router — never sent to the vendor). Filter condition field names are name-checked pre-request the same way as the query bag: a refusal costs zero /query/count wire (the cold fieldCache may cost the one authority metadata GET first). fieldCheck: false disables the name check (a non-boolean is refused pre-request; the shape/grammar checks always run) — the opt-out works on the count verb too. Filter grammar: 13 operators: eq, noteq, gt, gte, lt, lte, beginsWith, endsWith, contains, exist, notExist, in, notIn (in/notIn: array or '1,2,3') + and/or grouping (no not-group). Field names in vendor API casing — get them via operations.fieldCatalog. Caps: 500 OR-conditions / 1 UDF / 8000 chars.",
|
|
49284
|
+
"untrustedFields": [
|
|
49285
|
+
"title"
|
|
49286
|
+
]
|
|
49284
49287
|
},
|
|
49285
49288
|
"compact": null,
|
|
49286
49289
|
"status": "tested"
|
|
49287
49290
|
},
|
|
49288
49291
|
{
|
|
49289
|
-
"id": "
|
|
49290
|
-
"resource": "
|
|
49292
|
+
"id": "configuration_item_attachments.create",
|
|
49293
|
+
"resource": "configuration_item_attachments",
|
|
49291
49294
|
"udfCapable": false,
|
|
49292
49295
|
"operation": "create",
|
|
49293
49296
|
"kind": "primitive",
|
|
49294
|
-
"endpoint": "POST /V1.0/ConfigurationItems/{parentId}/
|
|
49297
|
+
"endpoint": "POST /V1.0/ConfigurationItems/{parentId}/Attachments",
|
|
49295
49298
|
"effect": "write",
|
|
49296
49299
|
"flags": [],
|
|
49297
49300
|
"dryRun": true,
|
|
@@ -49314,7 +49317,7 @@
|
|
|
49314
49317
|
"drops": []
|
|
49315
49318
|
},
|
|
49316
49319
|
"examples": [
|
|
49317
|
-
"await client.
|
|
49320
|
+
"const fields = await client.configurationItemAttachments.getFieldInfo();\nconst values = fields.find(field => field.name === 'publish')?.picklistValues?.filter(value => value.isActive === true && /^-?\\d+$/.test(value.value) && Number.isSafeInteger(Number(value.value)));\nif (!values?.length) throw new Error('No active numeric publish value is exposed');\nawait client.configurationItemAttachments.create(7, { attachmentType: 'FILE_ATTACHMENT', fullPath: 'note.txt', title: 'Supporting note', publish: Number(values[0].value), data: 'bm90ZQ==' }, { dryRun: true });"
|
|
49318
49321
|
],
|
|
49319
49322
|
"permissions": "unknown",
|
|
49320
49323
|
"pagination": {
|
|
@@ -49328,30 +49331,58 @@
|
|
|
49328
49331
|
"set": 1
|
|
49329
49332
|
},
|
|
49330
49333
|
"metadata": {
|
|
49331
|
-
"purpose": "Create a
|
|
49332
|
-
"usage": "
|
|
49333
|
-
"preferredWhen": "
|
|
49334
|
+
"purpose": "Create a file attachment under a configuration item.",
|
|
49335
|
+
"usage": "Create a file attachment under ConfigurationItems/{parentId}/Attachments. Required: attachmentType FILE_ATTACHMENT, title and fullPath (at most 255 characters), numeric publish from current metadata, and base64 data. Existing attachments cannot be updated. Read-only configurationItemNoteID is distinct from the configurationItemID path parent. Optional parentAttachmentID requests documented nesting; the vendor validates membership, permissions, impersonation and file limits. The API file limit is 6–7 MB and 10,000,000 bytes per five minutes, with a five-minute creation pause when exceeded. Exact-parent deduplication is unproven; createIfNotExists is unsupported. No live create is claimed.",
|
|
49336
|
+
"preferredWhen": "Add a new attachment; existing attachments cannot be updated. Replace through separately governed delete and create actions.",
|
|
49334
49337
|
"related": [
|
|
49335
|
-
"
|
|
49336
|
-
]
|
|
49338
|
+
"configuration_item_attachments.get"
|
|
49339
|
+
],
|
|
49340
|
+
"argNotes": {
|
|
49341
|
+
"data": "File uploads only. Read-only audit, parent/note associations, contentType, creatorType and fileSize are not accepted create inputs. Contact impersonation is not documented for assets; resource impersonation uses configured ImpersonationResourceID header, not attachedByResourceID in this body. Optional parentAttachmentID requests documented nesting; the vendor validates membership. Other attachment types and UDF writes are unsupported."
|
|
49342
|
+
},
|
|
49343
|
+
"untrustedFields": [
|
|
49344
|
+
"title"
|
|
49345
|
+
],
|
|
49346
|
+
"createRequirements": {
|
|
49347
|
+
"requires": {
|
|
49348
|
+
"allOf": [
|
|
49349
|
+
"attachmentType",
|
|
49350
|
+
"fullPath",
|
|
49351
|
+
"title",
|
|
49352
|
+
"publish",
|
|
49353
|
+
"data"
|
|
49354
|
+
]
|
|
49355
|
+
},
|
|
49356
|
+
"requiresByValue": [
|
|
49357
|
+
{
|
|
49358
|
+
"field": "attachmentType",
|
|
49359
|
+
"value": "FILE_ATTACHMENT",
|
|
49360
|
+
"requires": {
|
|
49361
|
+
"allOf": [
|
|
49362
|
+
"data"
|
|
49363
|
+
]
|
|
49364
|
+
}
|
|
49365
|
+
}
|
|
49366
|
+
]
|
|
49367
|
+
}
|
|
49337
49368
|
},
|
|
49338
49369
|
"compact": null,
|
|
49339
49370
|
"status": "tested"
|
|
49340
49371
|
},
|
|
49341
49372
|
{
|
|
49342
|
-
"id": "
|
|
49343
|
-
"resource": "
|
|
49373
|
+
"id": "configuration_item_attachments.delete",
|
|
49374
|
+
"resource": "configuration_item_attachments",
|
|
49344
49375
|
"udfCapable": false,
|
|
49345
49376
|
"operation": "delete",
|
|
49346
49377
|
"kind": "primitive",
|
|
49347
|
-
"endpoint": "DELETE /V1.0/ConfigurationItems/{parentId}/
|
|
49378
|
+
"endpoint": "DELETE /V1.0/ConfigurationItems/{parentId}/Attachments/{id}",
|
|
49348
49379
|
"effect": "destructive",
|
|
49349
49380
|
"flags": [
|
|
49350
49381
|
"idempotent",
|
|
49351
49382
|
"requiresApproval"
|
|
49352
49383
|
],
|
|
49353
49384
|
"dryRun": true,
|
|
49354
|
-
"envelope": "OperationResultModel",
|
|
49385
|
+
"envelope": "OperationResultModel (attachment entities: the deleted attachment model is returned, not OperationResultModel)",
|
|
49355
49386
|
"inputSchema": {
|
|
49356
49387
|
"parentId": {
|
|
49357
49388
|
"type": "string | number",
|
|
@@ -49366,11 +49397,11 @@
|
|
|
49366
49397
|
},
|
|
49367
49398
|
"inputSchemaStrict": true,
|
|
49368
49399
|
"outputSchema": {
|
|
49369
|
-
"type": "OperationResultModel",
|
|
49400
|
+
"type": "OperationResultModel (attachment entities: the deleted attachment model is returned, not OperationResultModel)",
|
|
49370
49401
|
"drops": []
|
|
49371
49402
|
},
|
|
49372
49403
|
"examples": [
|
|
49373
|
-
"await invoke(client, '
|
|
49404
|
+
"await invoke(client, 'configuration_item_attachments.delete', [7, 3], { confirm: 'configuration_item_attachments.delete' })"
|
|
49374
49405
|
],
|
|
49375
49406
|
"permissions": "unknown",
|
|
49376
49407
|
"pagination": {
|
|
@@ -49384,27 +49415,30 @@
|
|
|
49384
49415
|
"set": 2
|
|
49385
49416
|
},
|
|
49386
49417
|
"metadata": {
|
|
49387
|
-
"purpose": "Delete
|
|
49418
|
+
"purpose": "Delete an attachment under a configuration item.",
|
|
49388
49419
|
"usage": "Irreversible; dry-run validates the target id first. Parent-scoped: parentId + id.",
|
|
49389
49420
|
"preferredWhen": null,
|
|
49390
49421
|
"related": [
|
|
49391
|
-
"
|
|
49422
|
+
"configuration_item_attachments.get"
|
|
49423
|
+
],
|
|
49424
|
+
"untrustedFields": [
|
|
49425
|
+
"title"
|
|
49392
49426
|
]
|
|
49393
49427
|
},
|
|
49394
49428
|
"compact": null,
|
|
49395
49429
|
"status": "tested"
|
|
49396
49430
|
},
|
|
49397
49431
|
{
|
|
49398
|
-
"id": "
|
|
49399
|
-
"resource": "
|
|
49432
|
+
"id": "configuration_item_attachments.get",
|
|
49433
|
+
"resource": "configuration_item_attachments",
|
|
49400
49434
|
"udfCapable": false,
|
|
49401
49435
|
"operation": "get",
|
|
49402
49436
|
"kind": "primitive",
|
|
49403
|
-
"endpoint": "GET /V1.0/ConfigurationItems/{parentId}/
|
|
49437
|
+
"endpoint": "GET /V1.0/ConfigurationItems/{parentId}/Attachments/{id}",
|
|
49404
49438
|
"effect": "read",
|
|
49405
49439
|
"flags": [],
|
|
49406
49440
|
"dryRun": false,
|
|
49407
|
-
"envelope": "
|
|
49441
|
+
"envelope": "ConfigurationItemAttachmentModel",
|
|
49408
49442
|
"inputSchema": {
|
|
49409
49443
|
"parentId": {
|
|
49410
49444
|
"type": "string | number",
|
|
@@ -49431,11 +49465,11 @@
|
|
|
49431
49465
|
},
|
|
49432
49466
|
"inputSchemaStrict": true,
|
|
49433
49467
|
"outputSchema": {
|
|
49434
|
-
"type": "
|
|
49468
|
+
"type": "ConfigurationItemAttachmentModel",
|
|
49435
49469
|
"drops": []
|
|
49436
49470
|
},
|
|
49437
49471
|
"examples": [
|
|
49438
|
-
"await client.
|
|
49472
|
+
"await client.configurationItemAttachments.get(7, 3)"
|
|
49439
49473
|
],
|
|
49440
49474
|
"permissions": "unknown",
|
|
49441
49475
|
"pagination": {
|
|
@@ -49449,24 +49483,27 @@
|
|
|
49449
49483
|
"set": 3
|
|
49450
49484
|
},
|
|
49451
49485
|
"metadata": {
|
|
49452
|
-
"purpose": "Get one
|
|
49453
|
-
"usage": "item: null
|
|
49454
|
-
"preferredWhen": "
|
|
49486
|
+
"purpose": "Get one ConfigurationItemAttachment by id.",
|
|
49487
|
+
"usage": "Returns the attachment model directly; item: null or an empty model is a typed not-found. Parent-scoped: parentId is the configuration-item id, followed by the attachment id.",
|
|
49488
|
+
"preferredWhen": "Use a known attachment id; query the scoped collection to discover ids.",
|
|
49455
49489
|
"related": [
|
|
49456
|
-
"
|
|
49490
|
+
"configuration_item_attachments.query"
|
|
49457
49491
|
],
|
|
49458
|
-
"args": "args are (parentId: number, id: number) Item GET returns the FULL vendor model — the vendor documents no field selection on single-record reads. For a slim record use a
|
|
49492
|
+
"args": "args are (parentId: number, id: number) Item GET returns the FULL vendor model — the vendor documents no field selection on single-record reads. For a slim record use a configuration_item_attachments.query with includeFields.",
|
|
49493
|
+
"untrustedFields": [
|
|
49494
|
+
"title"
|
|
49495
|
+
]
|
|
49459
49496
|
},
|
|
49460
49497
|
"compact": null,
|
|
49461
49498
|
"status": "tested"
|
|
49462
49499
|
},
|
|
49463
49500
|
{
|
|
49464
|
-
"id": "
|
|
49465
|
-
"resource": "
|
|
49501
|
+
"id": "configuration_item_attachments.getEntityInfo",
|
|
49502
|
+
"resource": "configuration_item_attachments",
|
|
49466
49503
|
"udfCapable": false,
|
|
49467
49504
|
"operation": "getEntityInfo",
|
|
49468
49505
|
"kind": "primitive",
|
|
49469
|
-
"endpoint": "GET /V1.0/
|
|
49506
|
+
"endpoint": "GET /V1.0/ConfigurationItemAttachments/entityInformation",
|
|
49470
49507
|
"effect": "read",
|
|
49471
49508
|
"flags": [],
|
|
49472
49509
|
"dryRun": false,
|
|
@@ -49478,7 +49515,7 @@
|
|
|
49478
49515
|
"drops": []
|
|
49479
49516
|
},
|
|
49480
49517
|
"examples": [
|
|
49481
|
-
"await client.
|
|
49518
|
+
"await client.configurationItemAttachments.getEntityInfo()"
|
|
49482
49519
|
],
|
|
49483
49520
|
"permissions": "unknown",
|
|
49484
49521
|
"pagination": {
|
|
@@ -49492,23 +49529,26 @@
|
|
|
49492
49529
|
"set": 0
|
|
49493
49530
|
},
|
|
49494
49531
|
"metadata": {
|
|
49495
|
-
"purpose": "Get the
|
|
49532
|
+
"purpose": "Get the ConfigurationItemAttachment capability metadata (canCreate/canUpdate/hasUserDefinedFields/...).",
|
|
49496
49533
|
"usage": "Unwraps info{}; drives client-side capability checks.",
|
|
49497
49534
|
"preferredWhen": null,
|
|
49498
49535
|
"related": [
|
|
49499
|
-
"
|
|
49536
|
+
"configuration_item_attachments.getFieldInfo"
|
|
49537
|
+
],
|
|
49538
|
+
"untrustedFields": [
|
|
49539
|
+
"title"
|
|
49500
49540
|
]
|
|
49501
49541
|
},
|
|
49502
49542
|
"compact": null,
|
|
49503
49543
|
"status": "tested"
|
|
49504
49544
|
},
|
|
49505
49545
|
{
|
|
49506
|
-
"id": "
|
|
49507
|
-
"resource": "
|
|
49546
|
+
"id": "configuration_item_attachments.getFieldInfo",
|
|
49547
|
+
"resource": "configuration_item_attachments",
|
|
49508
49548
|
"udfCapable": false,
|
|
49509
49549
|
"operation": "getFieldInfo",
|
|
49510
49550
|
"kind": "primitive",
|
|
49511
|
-
"endpoint": "GET /V1.0/
|
|
49551
|
+
"endpoint": "GET /V1.0/ConfigurationItemAttachments/entityInformation/fields",
|
|
49512
49552
|
"effect": "read",
|
|
49513
49553
|
"flags": [],
|
|
49514
49554
|
"dryRun": false,
|
|
@@ -49520,7 +49560,7 @@
|
|
|
49520
49560
|
"drops": []
|
|
49521
49561
|
},
|
|
49522
49562
|
"examples": [
|
|
49523
|
-
"await client.
|
|
49563
|
+
"await client.configurationItemAttachments.getFieldInfo()"
|
|
49524
49564
|
],
|
|
49525
49565
|
"permissions": "unknown",
|
|
49526
49566
|
"pagination": {
|
|
@@ -49534,66 +49574,26 @@
|
|
|
49534
49574
|
"set": 0
|
|
49535
49575
|
},
|
|
49536
49576
|
"metadata": {
|
|
49537
|
-
"purpose": "Get the
|
|
49577
|
+
"purpose": "Get the ConfigurationItemAttachment field catalog (types, picklists, required, maxLength) — the full raw field dump (the largest read of the info trio; compact discovery: operations.fieldCatalog).",
|
|
49538
49578
|
"usage": "Unwraps fields[]; full raw field dump — the largest read of the info trio (compact discovery: operations.fieldCatalog); the raw dump is also the basis for UDF handling.",
|
|
49539
49579
|
"preferredWhen": null,
|
|
49540
49580
|
"related": [
|
|
49541
|
-
"
|
|
49542
|
-
|
|
49543
|
-
|
|
49544
|
-
|
|
49545
|
-
"compact": null,
|
|
49546
|
-
"status": "tested"
|
|
49547
|
-
},
|
|
49548
|
-
{
|
|
49549
|
-
"id": "configuration_item_billing_product_associations.getUdfInfo",
|
|
49550
|
-
"resource": "configuration_item_billing_product_associations",
|
|
49551
|
-
"udfCapable": false,
|
|
49552
|
-
"operation": "getUdfInfo",
|
|
49553
|
-
"kind": "primitive",
|
|
49554
|
-
"endpoint": "GET /V1.0/ConfigurationItemBillingProductAssociations/entityInformation/userDefinedFields",
|
|
49555
|
-
"effect": "read",
|
|
49556
|
-
"flags": [],
|
|
49557
|
-
"dryRun": false,
|
|
49558
|
-
"envelope": "UserDefinedFieldInformationResultModel",
|
|
49559
|
-
"inputSchema": {},
|
|
49560
|
-
"inputSchemaStrict": true,
|
|
49561
|
-
"outputSchema": {
|
|
49562
|
-
"type": "UserDefinedFieldInformationResultModel",
|
|
49563
|
-
"drops": []
|
|
49564
|
-
},
|
|
49565
|
-
"examples": [
|
|
49566
|
-
"await client.configurationItemBillingProductAssociations.getUdfInfo()"
|
|
49567
|
-
],
|
|
49568
|
-
"permissions": "unknown",
|
|
49569
|
-
"pagination": {
|
|
49570
|
-
"mode": "none"
|
|
49571
|
-
},
|
|
49572
|
-
"resolution": null,
|
|
49573
|
-
"retry": {
|
|
49574
|
-
"preset": "retry-ffb3a9cb"
|
|
49575
|
-
},
|
|
49576
|
-
"errors": {
|
|
49577
|
-
"set": 0
|
|
49578
|
-
},
|
|
49579
|
-
"metadata": {
|
|
49580
|
-
"purpose": "Get the ConfigurationItemBillingProductAssociations user-defined-field catalog.",
|
|
49581
|
-
"usage": "Unwraps fields[]; only meaningful where the entity is UDF-capable. (entity is not UDF-capable; catalog is expected empty).",
|
|
49582
|
-
"preferredWhen": null,
|
|
49583
|
-
"related": [
|
|
49584
|
-
"configuration_item_billing_product_associations.getFieldInfo"
|
|
49581
|
+
"configuration_item_attachments.getEntityInfo"
|
|
49582
|
+
],
|
|
49583
|
+
"untrustedFields": [
|
|
49584
|
+
"title"
|
|
49585
49585
|
]
|
|
49586
49586
|
},
|
|
49587
49587
|
"compact": null,
|
|
49588
49588
|
"status": "tested"
|
|
49589
49589
|
},
|
|
49590
49590
|
{
|
|
49591
|
-
"id": "
|
|
49592
|
-
"resource": "
|
|
49591
|
+
"id": "configuration_item_attachments.query",
|
|
49592
|
+
"resource": "configuration_item_attachments",
|
|
49593
49593
|
"udfCapable": false,
|
|
49594
49594
|
"operation": "query",
|
|
49595
49595
|
"kind": "primitive",
|
|
49596
|
-
"endpoint": "GET|POST /V1.0/
|
|
49596
|
+
"endpoint": "GET|POST /V1.0/ConfigurationItemAttachments/query",
|
|
49597
49597
|
"effect": "read",
|
|
49598
49598
|
"flags": [],
|
|
49599
49599
|
"dryRun": false,
|
|
@@ -49665,7 +49665,7 @@
|
|
|
49665
49665
|
"drops": []
|
|
49666
49666
|
},
|
|
49667
49667
|
"examples": [
|
|
49668
|
-
"await client.
|
|
49668
|
+
"await invoke(client, 'configuration_item_attachments.query', [{ filter: [{ field: 'configurationItemID', op: 'eq', value: 7 }], limit: 25 }])"
|
|
49669
49669
|
],
|
|
49670
49670
|
"permissions": "unknown",
|
|
49671
49671
|
"pagination": {
|
|
@@ -49686,41 +49686,44 @@
|
|
|
49686
49686
|
"set": 4
|
|
49687
49687
|
},
|
|
49688
49688
|
"metadata": {
|
|
49689
|
-
"purpose": "Query
|
|
49690
|
-
"usage": "Server-side pagination: one call walks the vendor cursor internally (page 1 POSTs the QueryModel body with MaxRecords = the walk's internal page size (at most 500; the default POST path — `via: 'get'` issues a GET on page 1); later pages POST the SAME body — IncludeFields, MaxRecords and the preserved filter — to the absolute vendor cursor, rebased to the client base URL; the vendor honours IncludeFields on a continuation and ignores MaxRecords there, so a later page carries the vendor's own page size) until the limit is met or the cursor is null; 1000-page guard (hasMore stays true at the guard). queryAll is the unbounded raw walk — only when you need the ENTIRE set and accept a large payload; default to the bounded query op. noteChars: N (integer >= 1) is an opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose — the same set the server wraps): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result (zero wire — response-side only). latest: N returns the N highest-id rows (id-descending): the vendor has no sort parameter — this is the only ordering channel, and a date window in `filter` narrows the cost; count-anchored — C ≤ 2500 → one count + a ≤6-page walk of the matching set, C > 2500 → count probes + an id-threshold window (≤64 probes; LATEST_THRESHOLD_UNRESOLVED on budget exhaustion), a blind count → a bounded walk with the blind-surface stamp (LATEST_WINDOW_INCOMPLETE on a truncated walk). Parent-scoped entity: the query stays global (filter with configurationItemID eq <parentId> where the parent is known). Explicit walk.maxRows independently sets the TOTAL returned-row cap (including export-sized walks); the ordinary limit is still validated in 1..2500 and only bounds the internal page size for this form. hasMore and truncated remain true at the page guard or while a cursor or unserved fetched rows remain. Self-resource prefixes are accepted in filter fields and includeFields; dotted UDF names are always refused before metadata or vendor requests, never rewritten to another tenant UDF.",
|
|
49689
|
+
"purpose": "Query ConfigurationItemAttachment records with a JSON filter.",
|
|
49690
|
+
"usage": "Server-side pagination: one call walks the vendor cursor internally (page 1 POSTs the QueryModel body with MaxRecords = the walk's internal page size (at most 500; the default POST path — `via: 'get'` issues a GET on page 1); later pages POST the SAME body — IncludeFields, MaxRecords and the preserved filter — to the absolute vendor cursor, rebased to the client base URL; the vendor honours IncludeFields on a continuation and ignores MaxRecords there, so a later page carries the vendor's own page size) until the limit is met or the cursor is null; 1000-page guard (hasMore stays true at the guard). queryAll is the unbounded raw walk — only when you need the ENTIRE set and accept a large payload; default to the bounded query op. noteChars: N (integer >= 1) is an opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose — the same set the server wraps): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result (zero wire — response-side only). latest: N returns the N highest-id rows (id-descending): the vendor has no sort parameter — this is the only ordering channel, and a date window in `filter` narrows the cost; count-anchored — C ≤ 2500 → one count + a ≤6-page walk of the matching set, C > 2500 → count probes + an id-threshold window (≤64 probes; LATEST_THRESHOLD_UNRESOLVED on budget exhaustion), a blind count → a bounded walk with the blind-surface stamp (LATEST_WINDOW_INCOMPLETE on a truncated walk). Parent-scoped entity: the query stays global (filter with configurationItemID eq <parentId> where the parent is known). Explicit walk.maxRows independently sets the TOTAL returned-row cap (including export-sized walks); the ordinary limit is still validated in 1..2500 and only bounds the internal page size for this form. hasMore and truncated remain true at the page guard or while a cursor or unserved fetched rows remain. Self-resource prefixes are accepted in filter fields and includeFields; dotted UDF names are always refused before metadata or vendor requests, never rewritten to another tenant UDF. Include an object-specific configurationItemID filter. configurationItemNoteID is a separate read-only association; do not substitute it for the path parent. creatorType, data and fileSize are not queryable. Object-specific filters do not establish exact direct-parent attachment membership; an empty result is conditional on API-user permissions and visibility. The Swagger query response names an attachment model, while this collection uses the existing SDK attachment query contract { items, pageDetails }; a bare-model response is rejected as INVALID_RESPONSE rather than guessed into a collection.",
|
|
49691
49691
|
"preferredWhen": "Default for filtered reads (the bounded query op). queryAll is the unbounded raw walk — only when you need the ENTIRE set and accept a large payload; default to the bounded query op. Prefer an includeFields subset over the full model (field names via operations.fieldCatalog). latest: N is the latest-N rows (id-descending) when the newest rows are the goal (the vendor has no sort — count-anchored, docs/API.md §4). Prefer a hand-listed includeFields for common narrow reads (removed the closed fieldsPreset presets — the v1 billing_join field list for billing_items.query, if you need it, is: companyID, ticketID, projectID, timeEntryID, contractServiceID, contractID, billingCodeID, expenseItemID, itemDate, quantity, rate, extendedPrice, totalAmount, nonBillable); noteChars: N caps the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose) to N chars each with the explicit … [+N chars truncated] marker (opt-in; the raw result when absent).",
|
|
49692
49692
|
"related": [
|
|
49693
|
-
"
|
|
49693
|
+
"configuration_item_attachments.get"
|
|
49694
49694
|
],
|
|
49695
|
-
"args": "args[0] is a params object: { filter?: FilterCondition[], limit?: total cap (default 500, max 2500; server-side pagination), latest?: number (1-2500 — the N highest-id rows; the vendor has no sort parameter, so this is a count-anchored mechanism — see docs/API.md §4; coexists with limit only when limit >= latest), noteChars?: number (integer >= 1 — opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result) maxRecords?: page size — raw SDK `queryAll`/`query` walks only (this bounded query ignores it; the invoke bag refuses it — pass limit), includeFields?: string[], fieldCheck?: boolean (default true — the pre-request field-name check on includeFields names and filter condition fields; false disables it — consumed by the invoke router, never sent to the vendor), via?: \"post\" | \"get\" (the wire method; the vendor GET has a 2048-char cap), acknowledgeUnscoped?: boolean (query verb only; a walk expected over 500 rows with no id scope in the filter is guarded — one pre-flight <resource>.count, and a count over 500 refuses with the typed SCOPE_REQUIRED before the walk; true walks the unscoped set anyway; a count that fails or is blind lets the walk run and the result’s scopeNote says so), walk?: { maxRows: positive integer (D6: the walk’s TOTAL row cap — serves at most maxRows rows in total; the page size stays min(500, limit), so one vendor page may fetch more rows than maxRows and the surplus is sliced off (fetched, not served); the result’s truncated flag — false only when the cursor is exhausted, true iff more rows exist past the cap (so an exact-multiple count with a live next page reports true); not combinable with latest) } }. Filter grammar: 13 operators: eq, noteq, gt, gte, lt, lte, beginsWith, endsWith, contains, exist, notExist, in, notIn (in/notIn: array or '1,2,3') + and/or grouping (no not-group). Field names in vendor API casing — get them via operations.fieldCatalog. Caps: 500 OR-conditions / 1 UDF / 8000 chars. By default the FULL vendor model is returned (all fields). To slim the payload for context savings pass includeFields with the exact vendor field names you need (discover them via operations.fieldCatalog); only those fields + id come back. The subset persists across the internal page walk."
|
|
49695
|
+
"args": "args[0] is a params object: { filter?: FilterCondition[], limit?: total cap (default 500, max 2500; server-side pagination), latest?: number (1-2500 — the N highest-id rows; the vendor has no sort parameter, so this is a count-anchored mechanism — see docs/API.md §4; coexists with limit only when limit >= latest), noteChars?: number (integer >= 1 — opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result) maxRecords?: page size — raw SDK `queryAll`/`query` walks only (this bounded query ignores it; the invoke bag refuses it — pass limit), includeFields?: string[], fieldCheck?: boolean (default true — the pre-request field-name check on includeFields names and filter condition fields; false disables it — consumed by the invoke router, never sent to the vendor), via?: \"post\" | \"get\" (the wire method; the vendor GET has a 2048-char cap), acknowledgeUnscoped?: boolean (query verb only; a walk expected over 500 rows with no id scope in the filter is guarded — one pre-flight <resource>.count, and a count over 500 refuses with the typed SCOPE_REQUIRED before the walk; true walks the unscoped set anyway; a count that fails or is blind lets the walk run and the result’s scopeNote says so), walk?: { maxRows: positive integer (D6: the walk’s TOTAL row cap — serves at most maxRows rows in total; the page size stays min(500, limit), so one vendor page may fetch more rows than maxRows and the surplus is sliced off (fetched, not served); the result’s truncated flag — false only when the cursor is exhausted, true iff more rows exist past the cap (so an exact-multiple count with a live next page reports true); not combinable with latest) } }. Filter grammar: 13 operators: eq, noteq, gt, gte, lt, lte, beginsWith, endsWith, contains, exist, notExist, in, notIn (in/notIn: array or '1,2,3') + and/or grouping (no not-group). Field names in vendor API casing — get them via operations.fieldCatalog. Caps: 500 OR-conditions / 1 UDF / 8000 chars. By default the FULL vendor model is returned (all fields). To slim the payload for context savings pass includeFields with the exact vendor field names you need (discover them via operations.fieldCatalog); only those fields + id come back. The subset persists across the internal page walk.",
|
|
49696
|
+
"untrustedFields": [
|
|
49697
|
+
"title"
|
|
49698
|
+
]
|
|
49696
49699
|
},
|
|
49697
49700
|
"compact": null,
|
|
49698
49701
|
"status": "tested"
|
|
49699
49702
|
},
|
|
49700
49703
|
{
|
|
49701
|
-
"id": "configuration_item_billing_product_associations.
|
|
49704
|
+
"id": "configuration_item_billing_product_associations.count",
|
|
49702
49705
|
"resource": "configuration_item_billing_product_associations",
|
|
49703
49706
|
"udfCapable": false,
|
|
49704
|
-
"operation": "
|
|
49705
|
-
"kind": "
|
|
49706
|
-
"endpoint":
|
|
49707
|
+
"operation": "count",
|
|
49708
|
+
"kind": "primitive",
|
|
49709
|
+
"endpoint": "GET|POST /V1.0/ConfigurationItemBillingProductAssociations/query/count",
|
|
49707
49710
|
"effect": "read",
|
|
49708
49711
|
"flags": [],
|
|
49709
49712
|
"dryRun": false,
|
|
49710
|
-
"envelope":
|
|
49713
|
+
"envelope": "QueryCountResultModel",
|
|
49711
49714
|
"inputSchema": {
|
|
49712
|
-
"
|
|
49713
|
-
"type": "string | number",
|
|
49714
|
-
"required": true,
|
|
49715
|
-
"description": "A numeric id (the direct fetch, tried first) or an exact value of the primary text field(s) of this resource (exact match only — a complete non-match returns null (resolve never widens to contains; the resource's search op is the contains-candidates channel) — other identifier forms, e.g. an email address, are NOT tried; use the dedicated lookup op for the resource where one exists)."
|
|
49716
|
-
},
|
|
49717
|
-
"opts": {
|
|
49715
|
+
"params": {
|
|
49718
49716
|
"type": "object",
|
|
49719
49717
|
"required": false,
|
|
49720
|
-
"description": "
|
|
49718
|
+
"description": "The query params object (CLOSED — unknown keys are refused pre-request): { filter?: FilterCondition[], fieldCheck?: boolean } — filter is the only wire parameter (the count endpoint takes no MaxRecords/IncludeFields; fieldCheck is consumed by the invoke router — never sent to the vendor). Filter condition field names are name-checked pre-request the same way as the query bag: a refusal costs zero /query/count wire (the cold fieldCache may cost the one authority metadata GET first). fieldCheck: false disables the name check (a non-boolean is refused pre-request; the shape/grammar checks always run) — the opt-out works on the count verb too.",
|
|
49721
49719
|
"properties": [
|
|
49722
49720
|
{
|
|
49723
|
-
"name": "
|
|
49721
|
+
"name": "filter",
|
|
49722
|
+
"type": "FilterCondition[]",
|
|
49723
|
+
"optional": true
|
|
49724
|
+
},
|
|
49725
|
+
{
|
|
49726
|
+
"name": "fieldCheck",
|
|
49724
49727
|
"type": "boolean",
|
|
49725
49728
|
"optional": true
|
|
49726
49729
|
}
|
|
@@ -49729,49 +49732,44 @@
|
|
|
49729
49732
|
},
|
|
49730
49733
|
"inputSchemaStrict": true,
|
|
49731
49734
|
"outputSchema": {
|
|
49732
|
-
"type": "
|
|
49735
|
+
"type": "QueryCountResultModel",
|
|
49733
49736
|
"drops": []
|
|
49734
49737
|
},
|
|
49735
49738
|
"examples": [
|
|
49736
|
-
"await client.configurationItemBillingProductAssociations.
|
|
49739
|
+
"await client.configurationItemBillingProductAssociations.count({ filter: [{ field: 'name', op: 'eq', value: 'example' }] })"
|
|
49737
49740
|
],
|
|
49738
49741
|
"permissions": "unknown",
|
|
49739
49742
|
"pagination": {
|
|
49740
49743
|
"mode": "none"
|
|
49741
49744
|
},
|
|
49742
|
-
"resolution":
|
|
49743
|
-
"basis": "server-filter",
|
|
49744
|
-
"maxScanRecords": 500,
|
|
49745
|
-
"maxScanPages": 4
|
|
49746
|
-
},
|
|
49745
|
+
"resolution": null,
|
|
49747
49746
|
"retry": {
|
|
49748
49747
|
"preset": "retry-ffb3a9cb"
|
|
49749
49748
|
},
|
|
49750
49749
|
"errors": {
|
|
49751
|
-
"set":
|
|
49750
|
+
"set": 0
|
|
49752
49751
|
},
|
|
49753
49752
|
"metadata": {
|
|
49754
|
-
"purpose": "
|
|
49755
|
-
"usage": "
|
|
49753
|
+
"purpose": "Count billing product association records matching a JSON filter. (under a configuration item)",
|
|
49754
|
+
"usage": "Unwraps queryCount; returns a plain number.",
|
|
49756
49755
|
"preferredWhen": null,
|
|
49757
49756
|
"related": [
|
|
49758
|
-
"configuration_item_billing_product_associations.
|
|
49759
|
-
]
|
|
49757
|
+
"configuration_item_billing_product_associations.query"
|
|
49758
|
+
],
|
|
49759
|
+
"args": "args[0] is a params object (CLOSED — unknown keys are refused pre-request): { filter?: FilterCondition[], fieldCheck?: boolean } — filter is the only parameter sent to the vendor (the count endpoint takes no MaxRecords/IncludeFields; fieldCheck is consumed by the invoke router — never sent to the vendor). Filter condition field names are name-checked pre-request the same way as the query bag: a refusal costs zero /query/count wire (the cold fieldCache may cost the one authority metadata GET first). fieldCheck: false disables the name check (a non-boolean is refused pre-request; the shape/grammar checks always run) — the opt-out works on the count verb too. Filter grammar: 13 operators: eq, noteq, gt, gte, lt, lte, beginsWith, endsWith, contains, exist, notExist, in, notIn (in/notIn: array or '1,2,3') + and/or grouping (no not-group). Field names in vendor API casing — get them via operations.fieldCatalog. Caps: 500 OR-conditions / 1 UDF / 8000 chars."
|
|
49760
49760
|
},
|
|
49761
|
-
"compact":
|
|
49761
|
+
"compact": null,
|
|
49762
49762
|
"status": "tested"
|
|
49763
49763
|
},
|
|
49764
49764
|
{
|
|
49765
|
-
"id": "configuration_item_billing_product_associations.
|
|
49765
|
+
"id": "configuration_item_billing_product_associations.create",
|
|
49766
49766
|
"resource": "configuration_item_billing_product_associations",
|
|
49767
49767
|
"udfCapable": false,
|
|
49768
|
-
"operation": "
|
|
49768
|
+
"operation": "create",
|
|
49769
49769
|
"kind": "primitive",
|
|
49770
|
-
"endpoint": "
|
|
49770
|
+
"endpoint": "POST /V1.0/ConfigurationItems/{parentId}/BillingProductAssociations",
|
|
49771
49771
|
"effect": "write",
|
|
49772
|
-
"flags": [
|
|
49773
|
-
"idempotent"
|
|
49774
|
-
],
|
|
49772
|
+
"flags": [],
|
|
49775
49773
|
"dryRun": true,
|
|
49776
49774
|
"envelope": "OperationResultModel",
|
|
49777
49775
|
"inputSchema": {
|
|
@@ -49780,11 +49778,6 @@
|
|
|
49780
49778
|
"required": true,
|
|
49781
49779
|
"description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
|
|
49782
49780
|
},
|
|
49783
|
-
"id": {
|
|
49784
|
-
"type": "string | number",
|
|
49785
|
-
"required": true,
|
|
49786
|
-
"description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
|
|
49787
|
-
},
|
|
49788
49781
|
"data": {
|
|
49789
49782
|
"type": "object",
|
|
49790
49783
|
"required": true,
|
|
@@ -49797,7 +49790,7 @@
|
|
|
49797
49790
|
"drops": []
|
|
49798
49791
|
},
|
|
49799
49792
|
"examples": [
|
|
49800
|
-
"await client.configurationItemBillingProductAssociations.
|
|
49793
|
+
"await client.configurationItemBillingProductAssociations.create('example-value', { name: 'example' }, { dryRun: true })"
|
|
49801
49794
|
],
|
|
49802
49795
|
"permissions": "unknown",
|
|
49803
49796
|
"pagination": {
|
|
@@ -49805,94 +49798,29 @@
|
|
|
49805
49798
|
},
|
|
49806
49799
|
"resolution": null,
|
|
49807
49800
|
"retry": {
|
|
49808
|
-
"preset": "retry-
|
|
49801
|
+
"preset": "retry-c5657094"
|
|
49809
49802
|
},
|
|
49810
49803
|
"errors": {
|
|
49811
49804
|
"set": 1
|
|
49812
49805
|
},
|
|
49813
49806
|
"metadata": {
|
|
49814
|
-
"purpose": "
|
|
49815
|
-
"usage": "
|
|
49816
|
-
"preferredWhen": "
|
|
49817
|
-
"related": [
|
|
49818
|
-
"configuration_item_billing_product_associations.get"
|
|
49819
|
-
]
|
|
49820
|
-
},
|
|
49821
|
-
"compact": null,
|
|
49822
|
-
"status": "tested"
|
|
49823
|
-
},
|
|
49824
|
-
{
|
|
49825
|
-
"id": "configuration_item_dns_records.count",
|
|
49826
|
-
"resource": "configuration_item_dns_records",
|
|
49827
|
-
"udfCapable": false,
|
|
49828
|
-
"operation": "count",
|
|
49829
|
-
"kind": "primitive",
|
|
49830
|
-
"endpoint": "GET|POST /V1.0/ConfigurationItemDnsRecords/query/count",
|
|
49831
|
-
"effect": "read",
|
|
49832
|
-
"flags": [],
|
|
49833
|
-
"dryRun": false,
|
|
49834
|
-
"envelope": "QueryCountResultModel",
|
|
49835
|
-
"inputSchema": {
|
|
49836
|
-
"params": {
|
|
49837
|
-
"type": "object",
|
|
49838
|
-
"required": false,
|
|
49839
|
-
"description": "The query params object (CLOSED — unknown keys are refused pre-request): { filter?: FilterCondition[], fieldCheck?: boolean } — filter is the only wire parameter (the count endpoint takes no MaxRecords/IncludeFields; fieldCheck is consumed by the invoke router — never sent to the vendor). Filter condition field names are name-checked pre-request the same way as the query bag: a refusal costs zero /query/count wire (the cold fieldCache may cost the one authority metadata GET first). fieldCheck: false disables the name check (a non-boolean is refused pre-request; the shape/grammar checks always run) — the opt-out works on the count verb too.",
|
|
49840
|
-
"properties": [
|
|
49841
|
-
{
|
|
49842
|
-
"name": "filter",
|
|
49843
|
-
"type": "FilterCondition[]",
|
|
49844
|
-
"optional": true
|
|
49845
|
-
},
|
|
49846
|
-
{
|
|
49847
|
-
"name": "fieldCheck",
|
|
49848
|
-
"type": "boolean",
|
|
49849
|
-
"optional": true
|
|
49850
|
-
}
|
|
49851
|
-
]
|
|
49852
|
-
}
|
|
49853
|
-
},
|
|
49854
|
-
"inputSchemaStrict": true,
|
|
49855
|
-
"outputSchema": {
|
|
49856
|
-
"type": "QueryCountResultModel",
|
|
49857
|
-
"drops": []
|
|
49858
|
-
},
|
|
49859
|
-
"examples": [
|
|
49860
|
-
"await invoke(client, 'configuration_item_dns_records.count', [{ filter: [{ field: 'installedProductID', op: 'eq', value: 7 }] }])"
|
|
49861
|
-
],
|
|
49862
|
-
"permissions": "unknown",
|
|
49863
|
-
"pagination": {
|
|
49864
|
-
"mode": "none"
|
|
49865
|
-
},
|
|
49866
|
-
"resolution": null,
|
|
49867
|
-
"retry": {
|
|
49868
|
-
"preset": "retry-ffb3a9cb"
|
|
49869
|
-
},
|
|
49870
|
-
"errors": {
|
|
49871
|
-
"set": 0
|
|
49872
|
-
},
|
|
49873
|
-
"metadata": {
|
|
49874
|
-
"purpose": "Count configuration item DNS records matching a JSON filter.",
|
|
49875
|
-
"usage": "Unwraps queryCount; returns a plain number.",
|
|
49876
|
-
"preferredWhen": null,
|
|
49807
|
+
"purpose": "Create a billing product association. (under a configuration item)",
|
|
49808
|
+
"usage": "Returns OperationResultModel.itemId (the new id); the full record is not returned — follow up with get where needed. Parent-scoped: parentId is a path parameter.",
|
|
49809
|
+
"preferredWhen": "Only for a record that does not exist yet; prefer update for an id you already have.",
|
|
49877
49810
|
"related": [
|
|
49878
|
-
"
|
|
49879
|
-
],
|
|
49880
|
-
"args": "args[0] is a params object (CLOSED — unknown keys are refused pre-request): { filter?: FilterCondition[], fieldCheck?: boolean } — filter is the only parameter sent to the vendor (the count endpoint takes no MaxRecords/IncludeFields; fieldCheck is consumed by the invoke router — never sent to the vendor). Filter condition field names are name-checked pre-request the same way as the query bag: a refusal costs zero /query/count wire (the cold fieldCache may cost the one authority metadata GET first). fieldCheck: false disables the name check (a non-boolean is refused pre-request; the shape/grammar checks always run) — the opt-out works on the count verb too. Filter grammar: 13 operators: eq, noteq, gt, gte, lt, lte, beginsWith, endsWith, contains, exist, notExist, in, notIn (in/notIn: array or '1,2,3') + and/or grouping (no not-group). Field names in vendor API casing — get them via operations.fieldCatalog. Caps: 500 OR-conditions / 1 UDF / 8000 chars.",
|
|
49881
|
-
"untrustedFields": [
|
|
49882
|
-
"data",
|
|
49883
|
-
"dnsType"
|
|
49811
|
+
"configuration_item_billing_product_associations.update"
|
|
49884
49812
|
]
|
|
49885
49813
|
},
|
|
49886
49814
|
"compact": null,
|
|
49887
49815
|
"status": "tested"
|
|
49888
49816
|
},
|
|
49889
49817
|
{
|
|
49890
|
-
"id": "
|
|
49891
|
-
"resource": "
|
|
49818
|
+
"id": "configuration_item_billing_product_associations.delete",
|
|
49819
|
+
"resource": "configuration_item_billing_product_associations",
|
|
49892
49820
|
"udfCapable": false,
|
|
49893
49821
|
"operation": "delete",
|
|
49894
49822
|
"kind": "primitive",
|
|
49895
|
-
"endpoint": "DELETE /V1.0/ConfigurationItems/{parentId}/
|
|
49823
|
+
"endpoint": "DELETE /V1.0/ConfigurationItems/{parentId}/BillingProductAssociations/{id}",
|
|
49896
49824
|
"effect": "destructive",
|
|
49897
49825
|
"flags": [
|
|
49898
49826
|
"idempotent",
|
|
@@ -49918,7 +49846,7 @@
|
|
|
49918
49846
|
"drops": []
|
|
49919
49847
|
},
|
|
49920
49848
|
"examples": [
|
|
49921
|
-
"await invoke(client, '
|
|
49849
|
+
"await invoke(client, 'configuration_item_billing_product_associations.delete', ['example-value', 'example-value'], { dryRun: false, confirm: 'configuration_item_billing_product_associations.delete' })"
|
|
49922
49850
|
],
|
|
49923
49851
|
"permissions": "unknown",
|
|
49924
49852
|
"pagination": {
|
|
@@ -49932,31 +49860,27 @@
|
|
|
49932
49860
|
"set": 2
|
|
49933
49861
|
},
|
|
49934
49862
|
"metadata": {
|
|
49935
|
-
"purpose": "Delete a configuration item
|
|
49863
|
+
"purpose": "Delete a billing product association. (under a configuration item)",
|
|
49936
49864
|
"usage": "Irreversible; dry-run validates the target id first. Parent-scoped: parentId + id.",
|
|
49937
49865
|
"preferredWhen": null,
|
|
49938
49866
|
"related": [
|
|
49939
|
-
"
|
|
49940
|
-
],
|
|
49941
|
-
"untrustedFields": [
|
|
49942
|
-
"data",
|
|
49943
|
-
"dnsType"
|
|
49867
|
+
"configuration_item_billing_product_associations.get"
|
|
49944
49868
|
]
|
|
49945
49869
|
},
|
|
49946
49870
|
"compact": null,
|
|
49947
49871
|
"status": "tested"
|
|
49948
49872
|
},
|
|
49949
49873
|
{
|
|
49950
|
-
"id": "
|
|
49951
|
-
"resource": "
|
|
49874
|
+
"id": "configuration_item_billing_product_associations.get",
|
|
49875
|
+
"resource": "configuration_item_billing_product_associations",
|
|
49952
49876
|
"udfCapable": false,
|
|
49953
49877
|
"operation": "get",
|
|
49954
49878
|
"kind": "primitive",
|
|
49955
|
-
"endpoint": "GET /V1.0/ConfigurationItems/{parentId}/
|
|
49879
|
+
"endpoint": "GET /V1.0/ConfigurationItems/{parentId}/BillingProductAssociations/{id}",
|
|
49956
49880
|
"effect": "read",
|
|
49957
49881
|
"flags": [],
|
|
49958
49882
|
"dryRun": false,
|
|
49959
|
-
"envelope": "ItemQueryResultModel[
|
|
49883
|
+
"envelope": "ItemQueryResultModel[ConfigurationItemBillingProductAssociationModel,InstalledProductBillingProductAssociation]",
|
|
49960
49884
|
"inputSchema": {
|
|
49961
49885
|
"parentId": {
|
|
49962
49886
|
"type": "string | number",
|
|
@@ -49983,11 +49907,11 @@
|
|
|
49983
49907
|
},
|
|
49984
49908
|
"inputSchemaStrict": true,
|
|
49985
49909
|
"outputSchema": {
|
|
49986
|
-
"type": "ItemQueryResultModel[
|
|
49910
|
+
"type": "ItemQueryResultModel[ConfigurationItemBillingProductAssociationModel,InstalledProductBillingProductAssociation]",
|
|
49987
49911
|
"drops": []
|
|
49988
49912
|
},
|
|
49989
49913
|
"examples": [
|
|
49990
|
-
"await client.
|
|
49914
|
+
"await client.configurationItemBillingProductAssociations.get('example-value', 'example-value')"
|
|
49991
49915
|
],
|
|
49992
49916
|
"permissions": "unknown",
|
|
49993
49917
|
"pagination": {
|
|
@@ -50001,28 +49925,24 @@
|
|
|
50001
49925
|
"set": 3
|
|
50002
49926
|
},
|
|
50003
49927
|
"metadata": {
|
|
50004
|
-
"purpose": "Get one
|
|
49928
|
+
"purpose": "Get one ConfigurationItemBillingProductAssociations by id.",
|
|
50005
49929
|
"usage": "item: null on the 200 body maps to NotFoundError (vendor not-found signal). Parent-scoped: parentId + id.",
|
|
50006
|
-
"preferredWhen": "Preferred when the numeric id is already known;
|
|
49930
|
+
"preferredWhen": "Preferred when the numeric id is already known; configuration_item_billing_product_associations.resolve is for a field value.",
|
|
50007
49931
|
"related": [
|
|
50008
|
-
"
|
|
49932
|
+
"configuration_item_billing_product_associations.resolve"
|
|
50009
49933
|
],
|
|
50010
|
-
"args": "args are (parentId: number, id: number) Item GET returns the FULL vendor model — the vendor documents no field selection on single-record reads. For a slim record use a
|
|
50011
|
-
"untrustedFields": [
|
|
50012
|
-
"data",
|
|
50013
|
-
"dnsType"
|
|
50014
|
-
]
|
|
49934
|
+
"args": "args are (parentId: number, id: number) Item GET returns the FULL vendor model — the vendor documents no field selection on single-record reads. For a slim record use a configuration_item_billing_product_associations.query with includeFields."
|
|
50015
49935
|
},
|
|
50016
49936
|
"compact": null,
|
|
50017
49937
|
"status": "tested"
|
|
50018
49938
|
},
|
|
50019
49939
|
{
|
|
50020
|
-
"id": "
|
|
50021
|
-
"resource": "
|
|
49940
|
+
"id": "configuration_item_billing_product_associations.getEntityInfo",
|
|
49941
|
+
"resource": "configuration_item_billing_product_associations",
|
|
50022
49942
|
"udfCapable": false,
|
|
50023
49943
|
"operation": "getEntityInfo",
|
|
50024
49944
|
"kind": "primitive",
|
|
50025
|
-
"endpoint": "GET /V1.0/
|
|
49945
|
+
"endpoint": "GET /V1.0/ConfigurationItemBillingProductAssociations/entityInformation",
|
|
50026
49946
|
"effect": "read",
|
|
50027
49947
|
"flags": [],
|
|
50028
49948
|
"dryRun": false,
|
|
@@ -50034,7 +49954,7 @@
|
|
|
50034
49954
|
"drops": []
|
|
50035
49955
|
},
|
|
50036
49956
|
"examples": [
|
|
50037
|
-
"await client.
|
|
49957
|
+
"await client.configurationItemBillingProductAssociations.getEntityInfo()"
|
|
50038
49958
|
],
|
|
50039
49959
|
"permissions": "unknown",
|
|
50040
49960
|
"pagination": {
|
|
@@ -50048,27 +49968,23 @@
|
|
|
50048
49968
|
"set": 0
|
|
50049
49969
|
},
|
|
50050
49970
|
"metadata": {
|
|
50051
|
-
"purpose": "Get the
|
|
49971
|
+
"purpose": "Get the ConfigurationItemBillingProductAssociations capability metadata (canCreate/canUpdate/hasUserDefinedFields/...).",
|
|
50052
49972
|
"usage": "Unwraps info{}; drives client-side capability checks.",
|
|
50053
49973
|
"preferredWhen": null,
|
|
50054
49974
|
"related": [
|
|
50055
|
-
"
|
|
50056
|
-
],
|
|
50057
|
-
"untrustedFields": [
|
|
50058
|
-
"data",
|
|
50059
|
-
"dnsType"
|
|
49975
|
+
"configuration_item_billing_product_associations.getFieldInfo"
|
|
50060
49976
|
]
|
|
50061
49977
|
},
|
|
50062
49978
|
"compact": null,
|
|
50063
49979
|
"status": "tested"
|
|
50064
49980
|
},
|
|
50065
49981
|
{
|
|
50066
|
-
"id": "
|
|
50067
|
-
"resource": "
|
|
49982
|
+
"id": "configuration_item_billing_product_associations.getFieldInfo",
|
|
49983
|
+
"resource": "configuration_item_billing_product_associations",
|
|
50068
49984
|
"udfCapable": false,
|
|
50069
49985
|
"operation": "getFieldInfo",
|
|
50070
49986
|
"kind": "primitive",
|
|
50071
|
-
"endpoint": "GET /V1.0/
|
|
49987
|
+
"endpoint": "GET /V1.0/ConfigurationItemBillingProductAssociations/entityInformation/fields",
|
|
50072
49988
|
"effect": "read",
|
|
50073
49989
|
"flags": [],
|
|
50074
49990
|
"dryRun": false,
|
|
@@ -50080,7 +49996,7 @@
|
|
|
50080
49996
|
"drops": []
|
|
50081
49997
|
},
|
|
50082
49998
|
"examples": [
|
|
50083
|
-
"await client.
|
|
49999
|
+
"await client.configurationItemBillingProductAssociations.getFieldInfo()"
|
|
50084
50000
|
],
|
|
50085
50001
|
"permissions": "unknown",
|
|
50086
50002
|
"pagination": {
|
|
@@ -50094,28 +50010,24 @@
|
|
|
50094
50010
|
"set": 0
|
|
50095
50011
|
},
|
|
50096
50012
|
"metadata": {
|
|
50097
|
-
"purpose": "Get the
|
|
50013
|
+
"purpose": "Get the ConfigurationItemBillingProductAssociations field catalog (types, picklists, required, maxLength) — the full raw field dump (the largest read of the info trio; compact discovery: operations.fieldCatalog).",
|
|
50098
50014
|
"usage": "Unwraps fields[]; full raw field dump — the largest read of the info trio (compact discovery: operations.fieldCatalog); the raw dump is also the basis for UDF handling.",
|
|
50099
50015
|
"preferredWhen": null,
|
|
50100
50016
|
"related": [
|
|
50101
|
-
"
|
|
50102
|
-
"
|
|
50103
|
-
],
|
|
50104
|
-
"untrustedFields": [
|
|
50105
|
-
"data",
|
|
50106
|
-
"dnsType"
|
|
50017
|
+
"configuration_item_billing_product_associations.getEntityInfo",
|
|
50018
|
+
"configuration_item_billing_product_associations.getUdfInfo"
|
|
50107
50019
|
]
|
|
50108
50020
|
},
|
|
50109
50021
|
"compact": null,
|
|
50110
50022
|
"status": "tested"
|
|
50111
50023
|
},
|
|
50112
50024
|
{
|
|
50113
|
-
"id": "
|
|
50114
|
-
"resource": "
|
|
50025
|
+
"id": "configuration_item_billing_product_associations.getUdfInfo",
|
|
50026
|
+
"resource": "configuration_item_billing_product_associations",
|
|
50115
50027
|
"udfCapable": false,
|
|
50116
50028
|
"operation": "getUdfInfo",
|
|
50117
50029
|
"kind": "primitive",
|
|
50118
|
-
"endpoint": "GET /V1.0/
|
|
50030
|
+
"endpoint": "GET /V1.0/ConfigurationItemBillingProductAssociations/entityInformation/userDefinedFields",
|
|
50119
50031
|
"effect": "read",
|
|
50120
50032
|
"flags": [],
|
|
50121
50033
|
"dryRun": false,
|
|
@@ -50127,7 +50039,7 @@
|
|
|
50127
50039
|
"drops": []
|
|
50128
50040
|
},
|
|
50129
50041
|
"examples": [
|
|
50130
|
-
"await client.
|
|
50042
|
+
"await client.configurationItemBillingProductAssociations.getUdfInfo()"
|
|
50131
50043
|
],
|
|
50132
50044
|
"permissions": "unknown",
|
|
50133
50045
|
"pagination": {
|
|
@@ -50141,27 +50053,591 @@
|
|
|
50141
50053
|
"set": 0
|
|
50142
50054
|
},
|
|
50143
50055
|
"metadata": {
|
|
50144
|
-
"purpose": "Get the
|
|
50056
|
+
"purpose": "Get the ConfigurationItemBillingProductAssociations user-defined-field catalog.",
|
|
50145
50057
|
"usage": "Unwraps fields[]; only meaningful where the entity is UDF-capable. (entity is not UDF-capable; catalog is expected empty).",
|
|
50146
50058
|
"preferredWhen": null,
|
|
50147
50059
|
"related": [
|
|
50148
|
-
"
|
|
50149
|
-
],
|
|
50150
|
-
"untrustedFields": [
|
|
50151
|
-
"data",
|
|
50152
|
-
"dnsType"
|
|
50060
|
+
"configuration_item_billing_product_associations.getFieldInfo"
|
|
50153
50061
|
]
|
|
50154
50062
|
},
|
|
50155
50063
|
"compact": null,
|
|
50156
50064
|
"status": "tested"
|
|
50157
50065
|
},
|
|
50158
50066
|
{
|
|
50159
|
-
"id": "
|
|
50160
|
-
"resource": "
|
|
50067
|
+
"id": "configuration_item_billing_product_associations.query",
|
|
50068
|
+
"resource": "configuration_item_billing_product_associations",
|
|
50161
50069
|
"udfCapable": false,
|
|
50162
50070
|
"operation": "query",
|
|
50163
50071
|
"kind": "primitive",
|
|
50164
|
-
"endpoint": "GET|POST /V1.0/
|
|
50072
|
+
"endpoint": "GET|POST /V1.0/ConfigurationItemBillingProductAssociations/query",
|
|
50073
|
+
"effect": "read",
|
|
50074
|
+
"flags": [],
|
|
50075
|
+
"dryRun": false,
|
|
50076
|
+
"envelope": "QueryActionResult[<Model>,<Entity>]",
|
|
50077
|
+
"inputSchema": {
|
|
50078
|
+
"params": {
|
|
50079
|
+
"type": "object",
|
|
50080
|
+
"required": false,
|
|
50081
|
+
"description": "The query params object (CLOSED — unknown keys are refused pre-request with a typed error naming the key + the valid keys): { filter?: FilterCondition[], limit?: number (total cap, default 500, max 2500 — NOT a page size), latest?: number (1-2500; the N highest-id rows — the vendor has no sort; count-probe + id-threshold semantics, see docs/API.md §4; the same-process latest-walk count probes are briefly cached per client — a 30 s TTL, cleared on a write through this client (a probe in flight across the write is discarded by the cache's invalidation epoch); the plain count op and aggregate stay fresh; limit and latest may coexist only when limit >= latest), noteChars?: number (integer >= 1; opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result), includeFields?: string[], fieldCheck?: boolean (default true: every includeFields NAME and every filter condition FIELD NAME is checked pre-request against the live field set (the vendored spec when that read faults — the resource's plan-pinned live-only fields, metadata.liveOnlyFields, are exempt from the vendored refusal: the live entity carries them and the vendor model omits them (e.g. time_entries postedDate/postedOnTime) — a truly unknown name is still refused); a refusal costs zero QUERY wire — the query POST and the count probe that anchors latest are never issued, a COLD fieldCache performs one authority metadata GET first (zero on a warm one); the one udf:true condition per query is exempt (a tenant UDF name is absent from the vendored spec by definition); false disables both name checks, never the shape/grammar checks; the count verb's bag is name-checked the same way and carries the same fieldCheck opt-out; a direct queryBounded/queryAll call is not checked (no bag contract there)), names?: boolean (absent = the client's labels option — OFF by default (the label pass costs a field-catalog read + up to 20 cold name reads per call; the MCP server (iit-mcp-autotask) enables the client labels option when it re-pins to this version (downstream)); true adds the row label siblings: picklist <field>Label (statusLabel), <fk>Name for companyID/contractID/ticketID/roleID/billingCodeID/*ResourceID (contractIDName, assignedResourceIDName) — null, never missing, when the field is keyed with a null value, a 0 id or an unresolved value (a picklist 0 is labelled when the picklist defines it); a names summary appears only when something was left unlabelled (the 20 uncached name-read cap or an unresolved picklist value); false = raw ids, ~30% smaller on a full tickets row), via?: \"post\" | \"get\" (vendor GET has a 2048-char cap), acknowledgeUnscoped?: boolean (query verb only; a walk expected to read over 500 rows with no id scope in the filter is guarded — one pre-flight <resource>.count, and a count over 500 refuses with the typed SCOPE_REQUIRED before the walk; true walks the unscoped set anyway; a count that fails or is blind lets the walk run and the result's scopeNote says so), walk?: object (walk.maxRows: positive integer — (D6): the walk's TOTAL row cap — serves at most maxRows rows in total; the page size stays min(500, limit), so one vendor page may fetch more rows than maxRows and the surplus is sliced off (fetched, not served); the result's truncated flag — false only when the cursor is exhausted, true iff more rows exist past the cap (so an exact-multiple count with a live next page reports true); not combinable with latest) }. Filter grammar: 13 operators (eq, noteq, gt, gte, lt, lte, beginsWith, endsWith, contains, exist, notExist, in, notIn; in/notIn: array or \"1,2,3\") + and/or grouping (no not-group); field names in vendor API casing (via operations.fieldCatalog); caps: 500 OR-conditions / 1 UDF / 8000 chars.",
|
|
50082
|
+
"properties": [
|
|
50083
|
+
{
|
|
50084
|
+
"name": "filter",
|
|
50085
|
+
"type": "FilterCondition[]",
|
|
50086
|
+
"optional": true
|
|
50087
|
+
},
|
|
50088
|
+
{
|
|
50089
|
+
"name": "limit",
|
|
50090
|
+
"type": "number",
|
|
50091
|
+
"optional": true,
|
|
50092
|
+
"default": 500
|
|
50093
|
+
},
|
|
50094
|
+
{
|
|
50095
|
+
"name": "latest",
|
|
50096
|
+
"type": "number",
|
|
50097
|
+
"optional": true
|
|
50098
|
+
},
|
|
50099
|
+
{
|
|
50100
|
+
"name": "noteChars",
|
|
50101
|
+
"type": "number",
|
|
50102
|
+
"optional": true
|
|
50103
|
+
},
|
|
50104
|
+
{
|
|
50105
|
+
"name": "includeFields",
|
|
50106
|
+
"type": "string[]",
|
|
50107
|
+
"optional": true
|
|
50108
|
+
},
|
|
50109
|
+
{
|
|
50110
|
+
"name": "fieldCheck",
|
|
50111
|
+
"type": "boolean",
|
|
50112
|
+
"optional": true,
|
|
50113
|
+
"default": true
|
|
50114
|
+
},
|
|
50115
|
+
{
|
|
50116
|
+
"name": "names",
|
|
50117
|
+
"type": "boolean",
|
|
50118
|
+
"optional": true
|
|
50119
|
+
},
|
|
50120
|
+
{
|
|
50121
|
+
"name": "via",
|
|
50122
|
+
"type": "\"post\" | \"get\"",
|
|
50123
|
+
"optional": true
|
|
50124
|
+
},
|
|
50125
|
+
{
|
|
50126
|
+
"name": "acknowledgeUnscoped",
|
|
50127
|
+
"type": "boolean",
|
|
50128
|
+
"optional": true
|
|
50129
|
+
},
|
|
50130
|
+
{
|
|
50131
|
+
"name": "walk",
|
|
50132
|
+
"type": "object",
|
|
50133
|
+
"optional": true
|
|
50134
|
+
}
|
|
50135
|
+
]
|
|
50136
|
+
}
|
|
50137
|
+
},
|
|
50138
|
+
"inputSchemaStrict": true,
|
|
50139
|
+
"outputSchema": {
|
|
50140
|
+
"type": "QueryActionResult[<Model>,<Entity>]",
|
|
50141
|
+
"drops": []
|
|
50142
|
+
},
|
|
50143
|
+
"examples": [
|
|
50144
|
+
"await client.configurationItemBillingProductAssociations.query({ filter: [{ field: 'name', op: 'eq', value: 'example' }], limit: 500 })"
|
|
50145
|
+
],
|
|
50146
|
+
"permissions": "unknown",
|
|
50147
|
+
"pagination": {
|
|
50148
|
+
"mode": "cursor",
|
|
50149
|
+
"vendorDefault": 10,
|
|
50150
|
+
"vendorMax": 500,
|
|
50151
|
+
"pageGuard": 1000,
|
|
50152
|
+
"queryBounded": {
|
|
50153
|
+
"default": 500,
|
|
50154
|
+
"max": 2500
|
|
50155
|
+
}
|
|
50156
|
+
},
|
|
50157
|
+
"resolution": null,
|
|
50158
|
+
"retry": {
|
|
50159
|
+
"preset": "retry-ffb3a9cb"
|
|
50160
|
+
},
|
|
50161
|
+
"errors": {
|
|
50162
|
+
"set": 4
|
|
50163
|
+
},
|
|
50164
|
+
"metadata": {
|
|
50165
|
+
"purpose": "Query ConfigurationItemBillingProductAssociations records with a JSON filter.",
|
|
50166
|
+
"usage": "Server-side pagination: one call walks the vendor cursor internally (page 1 POSTs the QueryModel body with MaxRecords = the walk's internal page size (at most 500; the default POST path — `via: 'get'` issues a GET on page 1); later pages POST the SAME body — IncludeFields, MaxRecords and the preserved filter — to the absolute vendor cursor, rebased to the client base URL; the vendor honours IncludeFields on a continuation and ignores MaxRecords there, so a later page carries the vendor's own page size) until the limit is met or the cursor is null; 1000-page guard (hasMore stays true at the guard). queryAll is the unbounded raw walk — only when you need the ENTIRE set and accept a large payload; default to the bounded query op. noteChars: N (integer >= 1) is an opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose — the same set the server wraps): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result (zero wire — response-side only). latest: N returns the N highest-id rows (id-descending): the vendor has no sort parameter — this is the only ordering channel, and a date window in `filter` narrows the cost; count-anchored — C ≤ 2500 → one count + a ≤6-page walk of the matching set, C > 2500 → count probes + an id-threshold window (≤64 probes; LATEST_THRESHOLD_UNRESOLVED on budget exhaustion), a blind count → a bounded walk with the blind-surface stamp (LATEST_WINDOW_INCOMPLETE on a truncated walk). Parent-scoped entity: the query stays global (filter with configurationItemID eq <parentId> where the parent is known). Explicit walk.maxRows independently sets the TOTAL returned-row cap (including export-sized walks); the ordinary limit is still validated in 1..2500 and only bounds the internal page size for this form. hasMore and truncated remain true at the page guard or while a cursor or unserved fetched rows remain. Self-resource prefixes are accepted in filter fields and includeFields; dotted UDF names are always refused before metadata or vendor requests, never rewritten to another tenant UDF.",
|
|
50167
|
+
"preferredWhen": "Default for filtered reads (the bounded query op). queryAll is the unbounded raw walk — only when you need the ENTIRE set and accept a large payload; default to the bounded query op. Prefer an includeFields subset over the full model (field names via operations.fieldCatalog). latest: N is the latest-N rows (id-descending) when the newest rows are the goal (the vendor has no sort — count-anchored, docs/API.md §4). Prefer a hand-listed includeFields for common narrow reads (removed the closed fieldsPreset presets — the v1 billing_join field list for billing_items.query, if you need it, is: companyID, ticketID, projectID, timeEntryID, contractServiceID, contractID, billingCodeID, expenseItemID, itemDate, quantity, rate, extendedPrice, totalAmount, nonBillable); noteChars: N caps the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose) to N chars each with the explicit … [+N chars truncated] marker (opt-in; the raw result when absent).",
|
|
50168
|
+
"related": [
|
|
50169
|
+
"configuration_item_billing_product_associations.resolve"
|
|
50170
|
+
],
|
|
50171
|
+
"args": "args[0] is a params object: { filter?: FilterCondition[], limit?: total cap (default 500, max 2500; server-side pagination), latest?: number (1-2500 — the N highest-id rows; the vendor has no sort parameter, so this is a count-anchored mechanism — see docs/API.md §4; coexists with limit only when limit >= latest), noteChars?: number (integer >= 1 — opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result) maxRecords?: page size — raw SDK `queryAll`/`query` walks only (this bounded query ignores it; the invoke bag refuses it — pass limit), includeFields?: string[], fieldCheck?: boolean (default true — the pre-request field-name check on includeFields names and filter condition fields; false disables it — consumed by the invoke router, never sent to the vendor), via?: \"post\" | \"get\" (the wire method; the vendor GET has a 2048-char cap), acknowledgeUnscoped?: boolean (query verb only; a walk expected over 500 rows with no id scope in the filter is guarded — one pre-flight <resource>.count, and a count over 500 refuses with the typed SCOPE_REQUIRED before the walk; true walks the unscoped set anyway; a count that fails or is blind lets the walk run and the result’s scopeNote says so), walk?: { maxRows: positive integer (D6: the walk’s TOTAL row cap — serves at most maxRows rows in total; the page size stays min(500, limit), so one vendor page may fetch more rows than maxRows and the surplus is sliced off (fetched, not served); the result’s truncated flag — false only when the cursor is exhausted, true iff more rows exist past the cap (so an exact-multiple count with a live next page reports true); not combinable with latest) } }. Filter grammar: 13 operators: eq, noteq, gt, gte, lt, lte, beginsWith, endsWith, contains, exist, notExist, in, notIn (in/notIn: array or '1,2,3') + and/or grouping (no not-group). Field names in vendor API casing — get them via operations.fieldCatalog. Caps: 500 OR-conditions / 1 UDF / 8000 chars. By default the FULL vendor model is returned (all fields). To slim the payload for context savings pass includeFields with the exact vendor field names you need (discover them via operations.fieldCatalog); only those fields + id come back. The subset persists across the internal page walk."
|
|
50172
|
+
},
|
|
50173
|
+
"compact": null,
|
|
50174
|
+
"status": "tested"
|
|
50175
|
+
},
|
|
50176
|
+
{
|
|
50177
|
+
"id": "configuration_item_billing_product_associations.resolve",
|
|
50178
|
+
"resource": "configuration_item_billing_product_associations",
|
|
50179
|
+
"udfCapable": false,
|
|
50180
|
+
"operation": "resolve",
|
|
50181
|
+
"kind": "helper",
|
|
50182
|
+
"endpoint": null,
|
|
50183
|
+
"effect": "read",
|
|
50184
|
+
"flags": [],
|
|
50185
|
+
"dryRun": false,
|
|
50186
|
+
"envelope": null,
|
|
50187
|
+
"inputSchema": {
|
|
50188
|
+
"identifier": {
|
|
50189
|
+
"type": "string | number",
|
|
50190
|
+
"required": true,
|
|
50191
|
+
"description": "A numeric id (the direct fetch, tried first) or an exact value of the primary text field(s) of this resource (exact match only — a complete non-match returns null (resolve never widens to contains; the resource's search op is the contains-candidates channel) — other identifier forms, e.g. an email address, are NOT tried; use the dedicated lookup op for the resource where one exists)."
|
|
50192
|
+
},
|
|
50193
|
+
"opts": {
|
|
50194
|
+
"type": "object",
|
|
50195
|
+
"required": false,
|
|
50196
|
+
"description": "ResolutionOpts — { expand?: boolean } (return the full record; a no-op where the Summary is a structural alias).",
|
|
50197
|
+
"properties": [
|
|
50198
|
+
{
|
|
50199
|
+
"name": "expand",
|
|
50200
|
+
"type": "boolean",
|
|
50201
|
+
"optional": true
|
|
50202
|
+
}
|
|
50203
|
+
]
|
|
50204
|
+
}
|
|
50205
|
+
},
|
|
50206
|
+
"inputSchemaStrict": true,
|
|
50207
|
+
"outputSchema": {
|
|
50208
|
+
"type": "ConfigurationItemBillingProductAssociationsSummary",
|
|
50209
|
+
"drops": []
|
|
50210
|
+
},
|
|
50211
|
+
"examples": [
|
|
50212
|
+
"await client.configurationItemBillingProductAssociations.resolve('example-value')"
|
|
50213
|
+
],
|
|
50214
|
+
"permissions": "unknown",
|
|
50215
|
+
"pagination": {
|
|
50216
|
+
"mode": "none"
|
|
50217
|
+
},
|
|
50218
|
+
"resolution": {
|
|
50219
|
+
"basis": "server-filter",
|
|
50220
|
+
"maxScanRecords": 500,
|
|
50221
|
+
"maxScanPages": 4
|
|
50222
|
+
},
|
|
50223
|
+
"retry": {
|
|
50224
|
+
"preset": "retry-ffb3a9cb"
|
|
50225
|
+
},
|
|
50226
|
+
"errors": {
|
|
50227
|
+
"set": 5
|
|
50228
|
+
},
|
|
50229
|
+
"metadata": {
|
|
50230
|
+
"purpose": "Resolve a billing product association from a numeric id (the direct fetch) only — this resource has no searchable text field, so a non-numeric identifier throws a config error. (under a configuration item)",
|
|
50231
|
+
"usage": "Bare values are read in the order: numeric id, then the resource primary text field (see searchCovers), exact match only. { id } miss throws NOT_FOUND.",
|
|
50232
|
+
"preferredWhen": null,
|
|
50233
|
+
"related": [
|
|
50234
|
+
"configuration_item_billing_product_associations.get"
|
|
50235
|
+
]
|
|
50236
|
+
},
|
|
50237
|
+
"compact": "ConfigurationItemBillingProductAssociationsSummary",
|
|
50238
|
+
"status": "tested"
|
|
50239
|
+
},
|
|
50240
|
+
{
|
|
50241
|
+
"id": "configuration_item_billing_product_associations.update",
|
|
50242
|
+
"resource": "configuration_item_billing_product_associations",
|
|
50243
|
+
"udfCapable": false,
|
|
50244
|
+
"operation": "update",
|
|
50245
|
+
"kind": "primitive",
|
|
50246
|
+
"endpoint": "PUT|PATCH /V1.0/ConfigurationItems/{parentId}/BillingProductAssociations",
|
|
50247
|
+
"effect": "write",
|
|
50248
|
+
"flags": [
|
|
50249
|
+
"idempotent"
|
|
50250
|
+
],
|
|
50251
|
+
"dryRun": true,
|
|
50252
|
+
"envelope": "OperationResultModel",
|
|
50253
|
+
"inputSchema": {
|
|
50254
|
+
"parentId": {
|
|
50255
|
+
"type": "string | number",
|
|
50256
|
+
"required": true,
|
|
50257
|
+
"description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
|
|
50258
|
+
},
|
|
50259
|
+
"id": {
|
|
50260
|
+
"type": "string | number",
|
|
50261
|
+
"required": true,
|
|
50262
|
+
"description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
|
|
50263
|
+
},
|
|
50264
|
+
"data": {
|
|
50265
|
+
"type": "object",
|
|
50266
|
+
"required": true,
|
|
50267
|
+
"description": "The record payload (vendor model fields)."
|
|
50268
|
+
}
|
|
50269
|
+
},
|
|
50270
|
+
"inputSchemaStrict": true,
|
|
50271
|
+
"outputSchema": {
|
|
50272
|
+
"type": "OperationResultModel",
|
|
50273
|
+
"drops": []
|
|
50274
|
+
},
|
|
50275
|
+
"examples": [
|
|
50276
|
+
"await client.configurationItemBillingProductAssociations.update('example-value', 'example-value', { name: 'example' }, { dryRun: true })"
|
|
50277
|
+
],
|
|
50278
|
+
"permissions": "unknown",
|
|
50279
|
+
"pagination": {
|
|
50280
|
+
"mode": "none"
|
|
50281
|
+
},
|
|
50282
|
+
"resolution": null,
|
|
50283
|
+
"retry": {
|
|
50284
|
+
"preset": "retry-85897a3a"
|
|
50285
|
+
},
|
|
50286
|
+
"errors": {
|
|
50287
|
+
"set": 1
|
|
50288
|
+
},
|
|
50289
|
+
"metadata": {
|
|
50290
|
+
"purpose": "Update a billing product association. (under a configuration item)",
|
|
50291
|
+
"usage": "Issues PATCH on the collection (swagger documents put+patch there; the node strips the id from the path and the vendor keys the record by the id in the body). Stale check via lastModifiedDate where present. Parent-scoped: parentId + id.",
|
|
50292
|
+
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
50293
|
+
"related": [
|
|
50294
|
+
"configuration_item_billing_product_associations.get"
|
|
50295
|
+
]
|
|
50296
|
+
},
|
|
50297
|
+
"compact": null,
|
|
50298
|
+
"status": "tested"
|
|
50299
|
+
},
|
|
50300
|
+
{
|
|
50301
|
+
"id": "configuration_item_dns_records.count",
|
|
50302
|
+
"resource": "configuration_item_dns_records",
|
|
50303
|
+
"udfCapable": false,
|
|
50304
|
+
"operation": "count",
|
|
50305
|
+
"kind": "primitive",
|
|
50306
|
+
"endpoint": "GET|POST /V1.0/ConfigurationItemDnsRecords/query/count",
|
|
50307
|
+
"effect": "read",
|
|
50308
|
+
"flags": [],
|
|
50309
|
+
"dryRun": false,
|
|
50310
|
+
"envelope": "QueryCountResultModel",
|
|
50311
|
+
"inputSchema": {
|
|
50312
|
+
"params": {
|
|
50313
|
+
"type": "object",
|
|
50314
|
+
"required": false,
|
|
50315
|
+
"description": "The query params object (CLOSED — unknown keys are refused pre-request): { filter?: FilterCondition[], fieldCheck?: boolean } — filter is the only wire parameter (the count endpoint takes no MaxRecords/IncludeFields; fieldCheck is consumed by the invoke router — never sent to the vendor). Filter condition field names are name-checked pre-request the same way as the query bag: a refusal costs zero /query/count wire (the cold fieldCache may cost the one authority metadata GET first). fieldCheck: false disables the name check (a non-boolean is refused pre-request; the shape/grammar checks always run) — the opt-out works on the count verb too.",
|
|
50316
|
+
"properties": [
|
|
50317
|
+
{
|
|
50318
|
+
"name": "filter",
|
|
50319
|
+
"type": "FilterCondition[]",
|
|
50320
|
+
"optional": true
|
|
50321
|
+
},
|
|
50322
|
+
{
|
|
50323
|
+
"name": "fieldCheck",
|
|
50324
|
+
"type": "boolean",
|
|
50325
|
+
"optional": true
|
|
50326
|
+
}
|
|
50327
|
+
]
|
|
50328
|
+
}
|
|
50329
|
+
},
|
|
50330
|
+
"inputSchemaStrict": true,
|
|
50331
|
+
"outputSchema": {
|
|
50332
|
+
"type": "QueryCountResultModel",
|
|
50333
|
+
"drops": []
|
|
50334
|
+
},
|
|
50335
|
+
"examples": [
|
|
50336
|
+
"await invoke(client, 'configuration_item_dns_records.count', [{ filter: [{ field: 'installedProductID', op: 'eq', value: 7 }] }])"
|
|
50337
|
+
],
|
|
50338
|
+
"permissions": "unknown",
|
|
50339
|
+
"pagination": {
|
|
50340
|
+
"mode": "none"
|
|
50341
|
+
},
|
|
50342
|
+
"resolution": null,
|
|
50343
|
+
"retry": {
|
|
50344
|
+
"preset": "retry-ffb3a9cb"
|
|
50345
|
+
},
|
|
50346
|
+
"errors": {
|
|
50347
|
+
"set": 0
|
|
50348
|
+
},
|
|
50349
|
+
"metadata": {
|
|
50350
|
+
"purpose": "Count configuration item DNS records matching a JSON filter.",
|
|
50351
|
+
"usage": "Unwraps queryCount; returns a plain number.",
|
|
50352
|
+
"preferredWhen": null,
|
|
50353
|
+
"related": [
|
|
50354
|
+
"configuration_item_dns_records.query"
|
|
50355
|
+
],
|
|
50356
|
+
"args": "args[0] is a params object (CLOSED — unknown keys are refused pre-request): { filter?: FilterCondition[], fieldCheck?: boolean } — filter is the only parameter sent to the vendor (the count endpoint takes no MaxRecords/IncludeFields; fieldCheck is consumed by the invoke router — never sent to the vendor). Filter condition field names are name-checked pre-request the same way as the query bag: a refusal costs zero /query/count wire (the cold fieldCache may cost the one authority metadata GET first). fieldCheck: false disables the name check (a non-boolean is refused pre-request; the shape/grammar checks always run) — the opt-out works on the count verb too. Filter grammar: 13 operators: eq, noteq, gt, gte, lt, lte, beginsWith, endsWith, contains, exist, notExist, in, notIn (in/notIn: array or '1,2,3') + and/or grouping (no not-group). Field names in vendor API casing — get them via operations.fieldCatalog. Caps: 500 OR-conditions / 1 UDF / 8000 chars.",
|
|
50357
|
+
"untrustedFields": [
|
|
50358
|
+
"data",
|
|
50359
|
+
"dnsType"
|
|
50360
|
+
]
|
|
50361
|
+
},
|
|
50362
|
+
"compact": null,
|
|
50363
|
+
"status": "tested"
|
|
50364
|
+
},
|
|
50365
|
+
{
|
|
50366
|
+
"id": "configuration_item_dns_records.delete",
|
|
50367
|
+
"resource": "configuration_item_dns_records",
|
|
50368
|
+
"udfCapable": false,
|
|
50369
|
+
"operation": "delete",
|
|
50370
|
+
"kind": "primitive",
|
|
50371
|
+
"endpoint": "DELETE /V1.0/ConfigurationItems/{parentId}/DnsRecords/{id}",
|
|
50372
|
+
"effect": "destructive",
|
|
50373
|
+
"flags": [
|
|
50374
|
+
"idempotent",
|
|
50375
|
+
"requiresApproval"
|
|
50376
|
+
],
|
|
50377
|
+
"dryRun": true,
|
|
50378
|
+
"envelope": "OperationResultModel",
|
|
50379
|
+
"inputSchema": {
|
|
50380
|
+
"parentId": {
|
|
50381
|
+
"type": "string | number",
|
|
50382
|
+
"required": true,
|
|
50383
|
+
"description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
|
|
50384
|
+
},
|
|
50385
|
+
"id": {
|
|
50386
|
+
"type": "string | number",
|
|
50387
|
+
"required": true,
|
|
50388
|
+
"description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
|
|
50389
|
+
}
|
|
50390
|
+
},
|
|
50391
|
+
"inputSchemaStrict": true,
|
|
50392
|
+
"outputSchema": {
|
|
50393
|
+
"type": "OperationResultModel",
|
|
50394
|
+
"drops": []
|
|
50395
|
+
},
|
|
50396
|
+
"examples": [
|
|
50397
|
+
"await invoke(client, 'configuration_item_dns_records.delete', ['example-value', 'example-value'], { dryRun: false, confirm: 'configuration_item_dns_records.delete' })"
|
|
50398
|
+
],
|
|
50399
|
+
"permissions": "unknown",
|
|
50400
|
+
"pagination": {
|
|
50401
|
+
"mode": "none"
|
|
50402
|
+
},
|
|
50403
|
+
"resolution": null,
|
|
50404
|
+
"retry": {
|
|
50405
|
+
"preset": "retry-1849870d"
|
|
50406
|
+
},
|
|
50407
|
+
"errors": {
|
|
50408
|
+
"set": 2
|
|
50409
|
+
},
|
|
50410
|
+
"metadata": {
|
|
50411
|
+
"purpose": "Delete a configuration item DNS record.",
|
|
50412
|
+
"usage": "Irreversible; dry-run validates the target id first. Parent-scoped: parentId + id.",
|
|
50413
|
+
"preferredWhen": null,
|
|
50414
|
+
"related": [
|
|
50415
|
+
"configuration_item_dns_records.get"
|
|
50416
|
+
],
|
|
50417
|
+
"untrustedFields": [
|
|
50418
|
+
"data",
|
|
50419
|
+
"dnsType"
|
|
50420
|
+
]
|
|
50421
|
+
},
|
|
50422
|
+
"compact": null,
|
|
50423
|
+
"status": "tested"
|
|
50424
|
+
},
|
|
50425
|
+
{
|
|
50426
|
+
"id": "configuration_item_dns_records.get",
|
|
50427
|
+
"resource": "configuration_item_dns_records",
|
|
50428
|
+
"udfCapable": false,
|
|
50429
|
+
"operation": "get",
|
|
50430
|
+
"kind": "primitive",
|
|
50431
|
+
"endpoint": "GET /V1.0/ConfigurationItems/{parentId}/DnsRecords/{id}",
|
|
50432
|
+
"effect": "read",
|
|
50433
|
+
"flags": [],
|
|
50434
|
+
"dryRun": false,
|
|
50435
|
+
"envelope": "ItemQueryResultModel[ConfigurationItemDnsRecordModel,InstalledProductDnsRecord]",
|
|
50436
|
+
"inputSchema": {
|
|
50437
|
+
"parentId": {
|
|
50438
|
+
"type": "string | number",
|
|
50439
|
+
"required": true,
|
|
50440
|
+
"description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
|
|
50441
|
+
},
|
|
50442
|
+
"id": {
|
|
50443
|
+
"type": "string | number",
|
|
50444
|
+
"required": true,
|
|
50445
|
+
"description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
|
|
50446
|
+
},
|
|
50447
|
+
"opts": {
|
|
50448
|
+
"type": "object",
|
|
50449
|
+
"required": false,
|
|
50450
|
+
"description": "The read options bag (CLOSED): { fresh?: boolean } — fresh: true bypasses the read-cache lookup and refreshes the entry with the live response. Omitted: the cached read (default unchanged). A positional fresh via invoke is REFUSED (typed error, zero wire — the fresh invoke option is the only spelling); the typed method get(id, { fresh: true }) is unchanged.",
|
|
50451
|
+
"properties": [
|
|
50452
|
+
{
|
|
50453
|
+
"name": "fresh",
|
|
50454
|
+
"type": "boolean",
|
|
50455
|
+
"optional": true
|
|
50456
|
+
}
|
|
50457
|
+
]
|
|
50458
|
+
}
|
|
50459
|
+
},
|
|
50460
|
+
"inputSchemaStrict": true,
|
|
50461
|
+
"outputSchema": {
|
|
50462
|
+
"type": "ItemQueryResultModel[ConfigurationItemDnsRecordModel,InstalledProductDnsRecord]",
|
|
50463
|
+
"drops": []
|
|
50464
|
+
},
|
|
50465
|
+
"examples": [
|
|
50466
|
+
"await client.configurationItemDnsRecords.get('example-value', 'example-value')"
|
|
50467
|
+
],
|
|
50468
|
+
"permissions": "unknown",
|
|
50469
|
+
"pagination": {
|
|
50470
|
+
"mode": "none"
|
|
50471
|
+
},
|
|
50472
|
+
"resolution": null,
|
|
50473
|
+
"retry": {
|
|
50474
|
+
"preset": "retry-ffb3a9cb"
|
|
50475
|
+
},
|
|
50476
|
+
"errors": {
|
|
50477
|
+
"set": 3
|
|
50478
|
+
},
|
|
50479
|
+
"metadata": {
|
|
50480
|
+
"purpose": "Get one ConfigurationItemDnsRecord by id.",
|
|
50481
|
+
"usage": "item: null on the 200 body maps to NotFoundError (vendor not-found signal). Parent-scoped: parentId + id.",
|
|
50482
|
+
"preferredWhen": "Preferred when the numeric id is already known; configuration_item_dns_records.resolve is for a field value.",
|
|
50483
|
+
"related": [
|
|
50484
|
+
"configuration_item_dns_records.resolve"
|
|
50485
|
+
],
|
|
50486
|
+
"args": "args are (parentId: number, id: number) Item GET returns the FULL vendor model — the vendor documents no field selection on single-record reads. For a slim record use a configuration_item_dns_records.query with includeFields.",
|
|
50487
|
+
"untrustedFields": [
|
|
50488
|
+
"data",
|
|
50489
|
+
"dnsType"
|
|
50490
|
+
]
|
|
50491
|
+
},
|
|
50492
|
+
"compact": null,
|
|
50493
|
+
"status": "tested"
|
|
50494
|
+
},
|
|
50495
|
+
{
|
|
50496
|
+
"id": "configuration_item_dns_records.getEntityInfo",
|
|
50497
|
+
"resource": "configuration_item_dns_records",
|
|
50498
|
+
"udfCapable": false,
|
|
50499
|
+
"operation": "getEntityInfo",
|
|
50500
|
+
"kind": "primitive",
|
|
50501
|
+
"endpoint": "GET /V1.0/ConfigurationItemDnsRecords/entityInformation",
|
|
50502
|
+
"effect": "read",
|
|
50503
|
+
"flags": [],
|
|
50504
|
+
"dryRun": false,
|
|
50505
|
+
"envelope": "EntityInformationResultModel",
|
|
50506
|
+
"inputSchema": {},
|
|
50507
|
+
"inputSchemaStrict": true,
|
|
50508
|
+
"outputSchema": {
|
|
50509
|
+
"type": "EntityInformationResultModel",
|
|
50510
|
+
"drops": []
|
|
50511
|
+
},
|
|
50512
|
+
"examples": [
|
|
50513
|
+
"await client.configurationItemDnsRecords.getEntityInfo()"
|
|
50514
|
+
],
|
|
50515
|
+
"permissions": "unknown",
|
|
50516
|
+
"pagination": {
|
|
50517
|
+
"mode": "none"
|
|
50518
|
+
},
|
|
50519
|
+
"resolution": null,
|
|
50520
|
+
"retry": {
|
|
50521
|
+
"preset": "retry-ffb3a9cb"
|
|
50522
|
+
},
|
|
50523
|
+
"errors": {
|
|
50524
|
+
"set": 0
|
|
50525
|
+
},
|
|
50526
|
+
"metadata": {
|
|
50527
|
+
"purpose": "Get the ConfigurationItemDnsRecord capability metadata (canCreate/canUpdate/hasUserDefinedFields/...).",
|
|
50528
|
+
"usage": "Unwraps info{}; drives client-side capability checks.",
|
|
50529
|
+
"preferredWhen": null,
|
|
50530
|
+
"related": [
|
|
50531
|
+
"configuration_item_dns_records.getFieldInfo"
|
|
50532
|
+
],
|
|
50533
|
+
"untrustedFields": [
|
|
50534
|
+
"data",
|
|
50535
|
+
"dnsType"
|
|
50536
|
+
]
|
|
50537
|
+
},
|
|
50538
|
+
"compact": null,
|
|
50539
|
+
"status": "tested"
|
|
50540
|
+
},
|
|
50541
|
+
{
|
|
50542
|
+
"id": "configuration_item_dns_records.getFieldInfo",
|
|
50543
|
+
"resource": "configuration_item_dns_records",
|
|
50544
|
+
"udfCapable": false,
|
|
50545
|
+
"operation": "getFieldInfo",
|
|
50546
|
+
"kind": "primitive",
|
|
50547
|
+
"endpoint": "GET /V1.0/ConfigurationItemDnsRecords/entityInformation/fields",
|
|
50548
|
+
"effect": "read",
|
|
50549
|
+
"flags": [],
|
|
50550
|
+
"dryRun": false,
|
|
50551
|
+
"envelope": "FieldInformationResultModel",
|
|
50552
|
+
"inputSchema": {},
|
|
50553
|
+
"inputSchemaStrict": true,
|
|
50554
|
+
"outputSchema": {
|
|
50555
|
+
"type": "FieldInformationResultModel",
|
|
50556
|
+
"drops": []
|
|
50557
|
+
},
|
|
50558
|
+
"examples": [
|
|
50559
|
+
"await client.configurationItemDnsRecords.getFieldInfo()"
|
|
50560
|
+
],
|
|
50561
|
+
"permissions": "unknown",
|
|
50562
|
+
"pagination": {
|
|
50563
|
+
"mode": "none"
|
|
50564
|
+
},
|
|
50565
|
+
"resolution": null,
|
|
50566
|
+
"retry": {
|
|
50567
|
+
"preset": "retry-ffb3a9cb"
|
|
50568
|
+
},
|
|
50569
|
+
"errors": {
|
|
50570
|
+
"set": 0
|
|
50571
|
+
},
|
|
50572
|
+
"metadata": {
|
|
50573
|
+
"purpose": "Get the ConfigurationItemDnsRecord field catalog (types, picklists, required, maxLength) — the full raw field dump (the largest read of the info trio; compact discovery: operations.fieldCatalog).",
|
|
50574
|
+
"usage": "Unwraps fields[]; full raw field dump — the largest read of the info trio (compact discovery: operations.fieldCatalog); the raw dump is also the basis for UDF handling.",
|
|
50575
|
+
"preferredWhen": null,
|
|
50576
|
+
"related": [
|
|
50577
|
+
"configuration_item_dns_records.getEntityInfo",
|
|
50578
|
+
"configuration_item_dns_records.getUdfInfo"
|
|
50579
|
+
],
|
|
50580
|
+
"untrustedFields": [
|
|
50581
|
+
"data",
|
|
50582
|
+
"dnsType"
|
|
50583
|
+
]
|
|
50584
|
+
},
|
|
50585
|
+
"compact": null,
|
|
50586
|
+
"status": "tested"
|
|
50587
|
+
},
|
|
50588
|
+
{
|
|
50589
|
+
"id": "configuration_item_dns_records.getUdfInfo",
|
|
50590
|
+
"resource": "configuration_item_dns_records",
|
|
50591
|
+
"udfCapable": false,
|
|
50592
|
+
"operation": "getUdfInfo",
|
|
50593
|
+
"kind": "primitive",
|
|
50594
|
+
"endpoint": "GET /V1.0/ConfigurationItemDnsRecords/entityInformation/userDefinedFields",
|
|
50595
|
+
"effect": "read",
|
|
50596
|
+
"flags": [],
|
|
50597
|
+
"dryRun": false,
|
|
50598
|
+
"envelope": "UserDefinedFieldInformationResultModel",
|
|
50599
|
+
"inputSchema": {},
|
|
50600
|
+
"inputSchemaStrict": true,
|
|
50601
|
+
"outputSchema": {
|
|
50602
|
+
"type": "UserDefinedFieldInformationResultModel",
|
|
50603
|
+
"drops": []
|
|
50604
|
+
},
|
|
50605
|
+
"examples": [
|
|
50606
|
+
"await client.configurationItemDnsRecords.getUdfInfo()"
|
|
50607
|
+
],
|
|
50608
|
+
"permissions": "unknown",
|
|
50609
|
+
"pagination": {
|
|
50610
|
+
"mode": "none"
|
|
50611
|
+
},
|
|
50612
|
+
"resolution": null,
|
|
50613
|
+
"retry": {
|
|
50614
|
+
"preset": "retry-ffb3a9cb"
|
|
50615
|
+
},
|
|
50616
|
+
"errors": {
|
|
50617
|
+
"set": 0
|
|
50618
|
+
},
|
|
50619
|
+
"metadata": {
|
|
50620
|
+
"purpose": "Get the ConfigurationItemDnsRecord user-defined-field catalog.",
|
|
50621
|
+
"usage": "Unwraps fields[]; only meaningful where the entity is UDF-capable. (entity is not UDF-capable; catalog is expected empty).",
|
|
50622
|
+
"preferredWhen": null,
|
|
50623
|
+
"related": [
|
|
50624
|
+
"configuration_item_dns_records.getFieldInfo"
|
|
50625
|
+
],
|
|
50626
|
+
"untrustedFields": [
|
|
50627
|
+
"data",
|
|
50628
|
+
"dnsType"
|
|
50629
|
+
]
|
|
50630
|
+
},
|
|
50631
|
+
"compact": null,
|
|
50632
|
+
"status": "tested"
|
|
50633
|
+
},
|
|
50634
|
+
{
|
|
50635
|
+
"id": "configuration_item_dns_records.query",
|
|
50636
|
+
"resource": "configuration_item_dns_records",
|
|
50637
|
+
"udfCapable": false,
|
|
50638
|
+
"operation": "query",
|
|
50639
|
+
"kind": "primitive",
|
|
50640
|
+
"endpoint": "GET|POST /V1.0/ConfigurationItemDnsRecords/query",
|
|
50165
50641
|
"effect": "read",
|
|
50166
50642
|
"flags": [],
|
|
50167
50643
|
"dryRun": false,
|
|
@@ -50337,6 +50813,482 @@
|
|
|
50337
50813
|
"compact": "ConfigurationItemDnsRecordSummary",
|
|
50338
50814
|
"status": "tested"
|
|
50339
50815
|
},
|
|
50816
|
+
{
|
|
50817
|
+
"id": "configuration_item_note_attachments.count",
|
|
50818
|
+
"resource": "configuration_item_note_attachments",
|
|
50819
|
+
"udfCapable": false,
|
|
50820
|
+
"operation": "count",
|
|
50821
|
+
"kind": "primitive",
|
|
50822
|
+
"endpoint": "GET|POST /V1.0/ConfigurationItemNoteAttachments/query/count",
|
|
50823
|
+
"effect": "read",
|
|
50824
|
+
"flags": [],
|
|
50825
|
+
"dryRun": false,
|
|
50826
|
+
"envelope": "QueryCountResultModel",
|
|
50827
|
+
"inputSchema": {
|
|
50828
|
+
"params": {
|
|
50829
|
+
"type": "object",
|
|
50830
|
+
"required": false,
|
|
50831
|
+
"description": "The query params object (CLOSED — unknown keys are refused pre-request): { filter?: FilterCondition[], fieldCheck?: boolean } — filter is the only wire parameter (the count endpoint takes no MaxRecords/IncludeFields; fieldCheck is consumed by the invoke router — never sent to the vendor). Filter condition field names are name-checked pre-request the same way as the query bag: a refusal costs zero /query/count wire (the cold fieldCache may cost the one authority metadata GET first). fieldCheck: false disables the name check (a non-boolean is refused pre-request; the shape/grammar checks always run) — the opt-out works on the count verb too.",
|
|
50832
|
+
"properties": [
|
|
50833
|
+
{
|
|
50834
|
+
"name": "filter",
|
|
50835
|
+
"type": "FilterCondition[]",
|
|
50836
|
+
"optional": true
|
|
50837
|
+
},
|
|
50838
|
+
{
|
|
50839
|
+
"name": "fieldCheck",
|
|
50840
|
+
"type": "boolean",
|
|
50841
|
+
"optional": true
|
|
50842
|
+
}
|
|
50843
|
+
]
|
|
50844
|
+
}
|
|
50845
|
+
},
|
|
50846
|
+
"inputSchemaStrict": true,
|
|
50847
|
+
"outputSchema": {
|
|
50848
|
+
"type": "QueryCountResultModel",
|
|
50849
|
+
"drops": []
|
|
50850
|
+
},
|
|
50851
|
+
"examples": [
|
|
50852
|
+
"await invoke(client, 'configuration_item_note_attachments.count', [{ filter: [{ field: 'configurationItemNoteID', op: 'eq', value: 7 }] }])"
|
|
50853
|
+
],
|
|
50854
|
+
"permissions": "unknown",
|
|
50855
|
+
"pagination": {
|
|
50856
|
+
"mode": "none"
|
|
50857
|
+
},
|
|
50858
|
+
"resolution": null,
|
|
50859
|
+
"retry": {
|
|
50860
|
+
"preset": "retry-ffb3a9cb"
|
|
50861
|
+
},
|
|
50862
|
+
"errors": {
|
|
50863
|
+
"set": 0
|
|
50864
|
+
},
|
|
50865
|
+
"metadata": {
|
|
50866
|
+
"purpose": "Count configuration item note attachment records matching a JSON filter. Use configurationItemNoteID for note scope.",
|
|
50867
|
+
"usage": "Unwraps queryCount; returns a plain number. Include an object-specific configurationItemNoteID filter. configurationItemID identifies the owning asset and is distinct from the attachment path’s note identifier. creatorType, data and fileSize are not queryable. Object-specific filters do not establish exact direct-parent attachment membership; an empty result is conditional on API-user permissions and visibility.",
|
|
50868
|
+
"preferredWhen": null,
|
|
50869
|
+
"related": [
|
|
50870
|
+
"configuration_item_note_attachments.query"
|
|
50871
|
+
],
|
|
50872
|
+
"args": "args[0] is a params object (CLOSED — unknown keys are refused pre-request): { filter?: FilterCondition[], fieldCheck?: boolean } — filter is the only parameter sent to the vendor (the count endpoint takes no MaxRecords/IncludeFields; fieldCheck is consumed by the invoke router — never sent to the vendor). Filter condition field names are name-checked pre-request the same way as the query bag: a refusal costs zero /query/count wire (the cold fieldCache may cost the one authority metadata GET first). fieldCheck: false disables the name check (a non-boolean is refused pre-request; the shape/grammar checks always run) — the opt-out works on the count verb too. Filter grammar: 13 operators: eq, noteq, gt, gte, lt, lte, beginsWith, endsWith, contains, exist, notExist, in, notIn (in/notIn: array or '1,2,3') + and/or grouping (no not-group). Field names in vendor API casing — get them via operations.fieldCatalog. Caps: 500 OR-conditions / 1 UDF / 8000 chars.",
|
|
50873
|
+
"untrustedFields": [
|
|
50874
|
+
"title"
|
|
50875
|
+
]
|
|
50876
|
+
},
|
|
50877
|
+
"compact": null,
|
|
50878
|
+
"status": "tested"
|
|
50879
|
+
},
|
|
50880
|
+
{
|
|
50881
|
+
"id": "configuration_item_note_attachments.create",
|
|
50882
|
+
"resource": "configuration_item_note_attachments",
|
|
50883
|
+
"udfCapable": false,
|
|
50884
|
+
"operation": "create",
|
|
50885
|
+
"kind": "primitive",
|
|
50886
|
+
"endpoint": "POST /V1.0/ConfigurationItemNotes/{parentId}/Attachments",
|
|
50887
|
+
"effect": "write",
|
|
50888
|
+
"flags": [],
|
|
50889
|
+
"dryRun": true,
|
|
50890
|
+
"envelope": "OperationResultModel",
|
|
50891
|
+
"inputSchema": {
|
|
50892
|
+
"parentId": {
|
|
50893
|
+
"type": "string | number",
|
|
50894
|
+
"required": true,
|
|
50895
|
+
"description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
|
|
50896
|
+
},
|
|
50897
|
+
"data": {
|
|
50898
|
+
"type": "object",
|
|
50899
|
+
"required": true,
|
|
50900
|
+
"description": "The record payload (vendor model fields)."
|
|
50901
|
+
}
|
|
50902
|
+
},
|
|
50903
|
+
"inputSchemaStrict": true,
|
|
50904
|
+
"outputSchema": {
|
|
50905
|
+
"type": "OperationResultModel",
|
|
50906
|
+
"drops": []
|
|
50907
|
+
},
|
|
50908
|
+
"examples": [
|
|
50909
|
+
"const fields = await client.configurationItemNoteAttachments.getFieldInfo();\nconst values = fields.find(field => field.name === 'publish')?.picklistValues?.filter(value => value.isActive === true && /^-?\\d+$/.test(value.value) && Number.isSafeInteger(Number(value.value)));\nif (!values?.length) throw new Error('No active numeric publish value is exposed');\nawait client.configurationItemNoteAttachments.create(7, { attachmentType: 'FILE_ATTACHMENT', fullPath: 'note.txt', title: 'Supporting note', publish: Number(values[0].value), data: 'bm90ZQ==' }, { dryRun: true });"
|
|
50910
|
+
],
|
|
50911
|
+
"permissions": "unknown",
|
|
50912
|
+
"pagination": {
|
|
50913
|
+
"mode": "none"
|
|
50914
|
+
},
|
|
50915
|
+
"resolution": null,
|
|
50916
|
+
"retry": {
|
|
50917
|
+
"preset": "retry-c5657094"
|
|
50918
|
+
},
|
|
50919
|
+
"errors": {
|
|
50920
|
+
"set": 1
|
|
50921
|
+
},
|
|
50922
|
+
"metadata": {
|
|
50923
|
+
"purpose": "Create a file attachment under a configuration-item note.",
|
|
50924
|
+
"usage": "Create a file attachment under ConfigurationItemNotes/{parentId}/Attachments. Use the configuration-item note id as parentId. Required inputs are attachmentType FILE_ATTACHMENT, title and fullPath (at most 255 characters), numeric publish from current metadata, and base64 data. The vendor validates permissions, visibility, resource impersonation and file limits. Existing attachments cannot be updated. For documented nesting use the owning configuration-item attachment route. Exact-parent deduplication is unproven, so use explicit create.",
|
|
50925
|
+
"preferredWhen": "Add a new attachment; existing attachments cannot be updated. Replace through separately governed delete and create actions.",
|
|
50926
|
+
"related": [
|
|
50927
|
+
"configuration_item_note_attachments.get"
|
|
50928
|
+
],
|
|
50929
|
+
"argNotes": {
|
|
50930
|
+
"data": "File uploads only. Asset and note associations, audit fields, contentType, creatorType, fileSize, contact author overrides and nesting references are outside the supported create body. Resource impersonation uses the configured ImpersonationResourceID header. Other attachment types and UDF writes are unsupported."
|
|
50931
|
+
},
|
|
50932
|
+
"untrustedFields": [
|
|
50933
|
+
"title"
|
|
50934
|
+
],
|
|
50935
|
+
"createRequirements": {
|
|
50936
|
+
"requires": {
|
|
50937
|
+
"allOf": [
|
|
50938
|
+
"attachmentType",
|
|
50939
|
+
"fullPath",
|
|
50940
|
+
"title",
|
|
50941
|
+
"publish",
|
|
50942
|
+
"data"
|
|
50943
|
+
]
|
|
50944
|
+
},
|
|
50945
|
+
"requiresByValue": [
|
|
50946
|
+
{
|
|
50947
|
+
"field": "attachmentType",
|
|
50948
|
+
"value": "FILE_ATTACHMENT",
|
|
50949
|
+
"requires": {
|
|
50950
|
+
"allOf": [
|
|
50951
|
+
"data"
|
|
50952
|
+
]
|
|
50953
|
+
}
|
|
50954
|
+
}
|
|
50955
|
+
]
|
|
50956
|
+
}
|
|
50957
|
+
},
|
|
50958
|
+
"compact": null,
|
|
50959
|
+
"status": "tested"
|
|
50960
|
+
},
|
|
50961
|
+
{
|
|
50962
|
+
"id": "configuration_item_note_attachments.delete",
|
|
50963
|
+
"resource": "configuration_item_note_attachments",
|
|
50964
|
+
"udfCapable": false,
|
|
50965
|
+
"operation": "delete",
|
|
50966
|
+
"kind": "primitive",
|
|
50967
|
+
"endpoint": "DELETE /V1.0/ConfigurationItemNotes/{parentId}/Attachments/{id}",
|
|
50968
|
+
"effect": "destructive",
|
|
50969
|
+
"flags": [
|
|
50970
|
+
"idempotent",
|
|
50971
|
+
"requiresApproval"
|
|
50972
|
+
],
|
|
50973
|
+
"dryRun": true,
|
|
50974
|
+
"envelope": "OperationResultModel (attachment entities: the deleted attachment model is returned, not OperationResultModel)",
|
|
50975
|
+
"inputSchema": {
|
|
50976
|
+
"parentId": {
|
|
50977
|
+
"type": "string | number",
|
|
50978
|
+
"required": true,
|
|
50979
|
+
"description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
|
|
50980
|
+
},
|
|
50981
|
+
"id": {
|
|
50982
|
+
"type": "string | number",
|
|
50983
|
+
"required": true,
|
|
50984
|
+
"description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
|
|
50985
|
+
}
|
|
50986
|
+
},
|
|
50987
|
+
"inputSchemaStrict": true,
|
|
50988
|
+
"outputSchema": {
|
|
50989
|
+
"type": "OperationResultModel (attachment entities: the deleted attachment model is returned, not OperationResultModel)",
|
|
50990
|
+
"drops": []
|
|
50991
|
+
},
|
|
50992
|
+
"examples": [
|
|
50993
|
+
"await invoke(client, 'configuration_item_note_attachments.delete', [7, 3], { confirm: 'configuration_item_note_attachments.delete' })"
|
|
50994
|
+
],
|
|
50995
|
+
"permissions": "unknown",
|
|
50996
|
+
"pagination": {
|
|
50997
|
+
"mode": "none"
|
|
50998
|
+
},
|
|
50999
|
+
"resolution": null,
|
|
51000
|
+
"retry": {
|
|
51001
|
+
"preset": "retry-1849870d"
|
|
51002
|
+
},
|
|
51003
|
+
"errors": {
|
|
51004
|
+
"set": 2
|
|
51005
|
+
},
|
|
51006
|
+
"metadata": {
|
|
51007
|
+
"purpose": "Delete an attachment under a configuration-item note.",
|
|
51008
|
+
"usage": "Irreversible. Confirm the exact operation before governed deletion. Dry-run verifies the attachment under the supplied note id. Arguments are (note id, attachment id).",
|
|
51009
|
+
"preferredWhen": null,
|
|
51010
|
+
"related": [
|
|
51011
|
+
"configuration_item_note_attachments.get"
|
|
51012
|
+
],
|
|
51013
|
+
"untrustedFields": [
|
|
51014
|
+
"title"
|
|
51015
|
+
]
|
|
51016
|
+
},
|
|
51017
|
+
"compact": null,
|
|
51018
|
+
"status": "tested"
|
|
51019
|
+
},
|
|
51020
|
+
{
|
|
51021
|
+
"id": "configuration_item_note_attachments.get",
|
|
51022
|
+
"resource": "configuration_item_note_attachments",
|
|
51023
|
+
"udfCapable": false,
|
|
51024
|
+
"operation": "get",
|
|
51025
|
+
"kind": "primitive",
|
|
51026
|
+
"endpoint": "GET /V1.0/ConfigurationItemNotes/{parentId}/Attachments/{id}",
|
|
51027
|
+
"effect": "read",
|
|
51028
|
+
"flags": [],
|
|
51029
|
+
"dryRun": false,
|
|
51030
|
+
"envelope": "ConfigurationItemNoteAttachmentModel",
|
|
51031
|
+
"inputSchema": {
|
|
51032
|
+
"parentId": {
|
|
51033
|
+
"type": "string | number",
|
|
51034
|
+
"required": true,
|
|
51035
|
+
"description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
|
|
51036
|
+
},
|
|
51037
|
+
"id": {
|
|
51038
|
+
"type": "string | number",
|
|
51039
|
+
"required": true,
|
|
51040
|
+
"description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
|
|
51041
|
+
},
|
|
51042
|
+
"opts": {
|
|
51043
|
+
"type": "object",
|
|
51044
|
+
"required": false,
|
|
51045
|
+
"description": "The read options bag (CLOSED): { fresh?: boolean } — fresh: true bypasses the read-cache lookup and refreshes the entry with the live response. Omitted: the cached read (default unchanged). A positional fresh via invoke is REFUSED (typed error, zero wire — the fresh invoke option is the only spelling); the typed method get(id, { fresh: true }) is unchanged.",
|
|
51046
|
+
"properties": [
|
|
51047
|
+
{
|
|
51048
|
+
"name": "fresh",
|
|
51049
|
+
"type": "boolean",
|
|
51050
|
+
"optional": true
|
|
51051
|
+
}
|
|
51052
|
+
]
|
|
51053
|
+
}
|
|
51054
|
+
},
|
|
51055
|
+
"inputSchemaStrict": true,
|
|
51056
|
+
"outputSchema": {
|
|
51057
|
+
"type": "ConfigurationItemNoteAttachmentModel",
|
|
51058
|
+
"drops": []
|
|
51059
|
+
},
|
|
51060
|
+
"examples": [
|
|
51061
|
+
"await client.configurationItemNoteAttachments.get(7, 3)"
|
|
51062
|
+
],
|
|
51063
|
+
"permissions": "unknown",
|
|
51064
|
+
"pagination": {
|
|
51065
|
+
"mode": "none"
|
|
51066
|
+
},
|
|
51067
|
+
"resolution": null,
|
|
51068
|
+
"retry": {
|
|
51069
|
+
"preset": "retry-ffb3a9cb"
|
|
51070
|
+
},
|
|
51071
|
+
"errors": {
|
|
51072
|
+
"set": 3
|
|
51073
|
+
},
|
|
51074
|
+
"metadata": {
|
|
51075
|
+
"purpose": "Get one ConfigurationItemNoteAttachment by id.",
|
|
51076
|
+
"usage": "Returns the attachment model directly; item: null or an empty model is a typed not-found. Parent-scoped: parentId is the configuration-item note id, followed by the attachment id.",
|
|
51077
|
+
"preferredWhen": "Use a known note id and attachment id. Use the global query filtered by configurationItemNoteID to discover attachments.",
|
|
51078
|
+
"related": [
|
|
51079
|
+
"configuration_item_note_attachments.query"
|
|
51080
|
+
],
|
|
51081
|
+
"args": "args are (parentId: number, id: number) Item GET returns the FULL vendor model — the vendor documents no field selection on single-record reads. For a slim record use a configuration_item_note_attachments.query with includeFields.",
|
|
51082
|
+
"untrustedFields": [
|
|
51083
|
+
"title"
|
|
51084
|
+
]
|
|
51085
|
+
},
|
|
51086
|
+
"compact": null,
|
|
51087
|
+
"status": "tested"
|
|
51088
|
+
},
|
|
51089
|
+
{
|
|
51090
|
+
"id": "configuration_item_note_attachments.getEntityInfo",
|
|
51091
|
+
"resource": "configuration_item_note_attachments",
|
|
51092
|
+
"udfCapable": false,
|
|
51093
|
+
"operation": "getEntityInfo",
|
|
51094
|
+
"kind": "primitive",
|
|
51095
|
+
"endpoint": "GET /V1.0/ConfigurationItemNoteAttachments/entityInformation",
|
|
51096
|
+
"effect": "read",
|
|
51097
|
+
"flags": [],
|
|
51098
|
+
"dryRun": false,
|
|
51099
|
+
"envelope": "EntityInformationResultModel",
|
|
51100
|
+
"inputSchema": {},
|
|
51101
|
+
"inputSchemaStrict": true,
|
|
51102
|
+
"outputSchema": {
|
|
51103
|
+
"type": "EntityInformationResultModel",
|
|
51104
|
+
"drops": []
|
|
51105
|
+
},
|
|
51106
|
+
"examples": [
|
|
51107
|
+
"await client.configurationItemNoteAttachments.getEntityInfo()"
|
|
51108
|
+
],
|
|
51109
|
+
"permissions": "unknown",
|
|
51110
|
+
"pagination": {
|
|
51111
|
+
"mode": "none"
|
|
51112
|
+
},
|
|
51113
|
+
"resolution": null,
|
|
51114
|
+
"retry": {
|
|
51115
|
+
"preset": "retry-ffb3a9cb"
|
|
51116
|
+
},
|
|
51117
|
+
"errors": {
|
|
51118
|
+
"set": 0
|
|
51119
|
+
},
|
|
51120
|
+
"metadata": {
|
|
51121
|
+
"purpose": "Get the ConfigurationItemNoteAttachment capability metadata (canCreate/canUpdate/hasUserDefinedFields/...).",
|
|
51122
|
+
"usage": "Unwraps info{}; drives client-side capability checks.",
|
|
51123
|
+
"preferredWhen": null,
|
|
51124
|
+
"related": [
|
|
51125
|
+
"configuration_item_note_attachments.getFieldInfo"
|
|
51126
|
+
],
|
|
51127
|
+
"untrustedFields": [
|
|
51128
|
+
"title"
|
|
51129
|
+
]
|
|
51130
|
+
},
|
|
51131
|
+
"compact": null,
|
|
51132
|
+
"status": "tested"
|
|
51133
|
+
},
|
|
51134
|
+
{
|
|
51135
|
+
"id": "configuration_item_note_attachments.getFieldInfo",
|
|
51136
|
+
"resource": "configuration_item_note_attachments",
|
|
51137
|
+
"udfCapable": false,
|
|
51138
|
+
"operation": "getFieldInfo",
|
|
51139
|
+
"kind": "primitive",
|
|
51140
|
+
"endpoint": "GET /V1.0/ConfigurationItemNoteAttachments/entityInformation/fields",
|
|
51141
|
+
"effect": "read",
|
|
51142
|
+
"flags": [],
|
|
51143
|
+
"dryRun": false,
|
|
51144
|
+
"envelope": "FieldInformationResultModel",
|
|
51145
|
+
"inputSchema": {},
|
|
51146
|
+
"inputSchemaStrict": true,
|
|
51147
|
+
"outputSchema": {
|
|
51148
|
+
"type": "FieldInformationResultModel",
|
|
51149
|
+
"drops": []
|
|
51150
|
+
},
|
|
51151
|
+
"examples": [
|
|
51152
|
+
"await client.configurationItemNoteAttachments.getFieldInfo()"
|
|
51153
|
+
],
|
|
51154
|
+
"permissions": "unknown",
|
|
51155
|
+
"pagination": {
|
|
51156
|
+
"mode": "none"
|
|
51157
|
+
},
|
|
51158
|
+
"resolution": null,
|
|
51159
|
+
"retry": {
|
|
51160
|
+
"preset": "retry-ffb3a9cb"
|
|
51161
|
+
},
|
|
51162
|
+
"errors": {
|
|
51163
|
+
"set": 0
|
|
51164
|
+
},
|
|
51165
|
+
"metadata": {
|
|
51166
|
+
"purpose": "Get the ConfigurationItemNoteAttachment field catalog (types, picklists, required, maxLength) — the full raw field dump (the largest read of the info trio; compact discovery: operations.fieldCatalog).",
|
|
51167
|
+
"usage": "Unwraps fields[]; full raw field dump — the largest read of the info trio (compact discovery: operations.fieldCatalog); the raw dump is also the basis for UDF handling.",
|
|
51168
|
+
"preferredWhen": null,
|
|
51169
|
+
"related": [
|
|
51170
|
+
"configuration_item_note_attachments.getEntityInfo"
|
|
51171
|
+
],
|
|
51172
|
+
"untrustedFields": [
|
|
51173
|
+
"title"
|
|
51174
|
+
]
|
|
51175
|
+
},
|
|
51176
|
+
"compact": null,
|
|
51177
|
+
"status": "tested"
|
|
51178
|
+
},
|
|
51179
|
+
{
|
|
51180
|
+
"id": "configuration_item_note_attachments.query",
|
|
51181
|
+
"resource": "configuration_item_note_attachments",
|
|
51182
|
+
"udfCapable": false,
|
|
51183
|
+
"operation": "query",
|
|
51184
|
+
"kind": "primitive",
|
|
51185
|
+
"endpoint": "GET|POST /V1.0/ConfigurationItemNoteAttachments/query",
|
|
51186
|
+
"effect": "read",
|
|
51187
|
+
"flags": [],
|
|
51188
|
+
"dryRun": false,
|
|
51189
|
+
"envelope": "QueryActionResult[<Model>,<Entity>]",
|
|
51190
|
+
"inputSchema": {
|
|
51191
|
+
"params": {
|
|
51192
|
+
"type": "object",
|
|
51193
|
+
"required": false,
|
|
51194
|
+
"description": "The query params object (CLOSED — unknown keys are refused pre-request with a typed error naming the key + the valid keys): { filter?: FilterCondition[], limit?: number (total cap, default 500, max 2500 — NOT a page size), latest?: number (1-2500; the N highest-id rows — the vendor has no sort; count-probe + id-threshold semantics, see docs/API.md §4; the same-process latest-walk count probes are briefly cached per client — a 30 s TTL, cleared on a write through this client (a probe in flight across the write is discarded by the cache's invalidation epoch); the plain count op and aggregate stay fresh; limit and latest may coexist only when limit >= latest), noteChars?: number (integer >= 1; opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result), includeFields?: string[], fieldCheck?: boolean (default true: every includeFields NAME and every filter condition FIELD NAME is checked pre-request against the live field set (the vendored spec when that read faults — the resource's plan-pinned live-only fields, metadata.liveOnlyFields, are exempt from the vendored refusal: the live entity carries them and the vendor model omits them (e.g. time_entries postedDate/postedOnTime) — a truly unknown name is still refused); a refusal costs zero QUERY wire — the query POST and the count probe that anchors latest are never issued, a COLD fieldCache performs one authority metadata GET first (zero on a warm one); the one udf:true condition per query is exempt (a tenant UDF name is absent from the vendored spec by definition); false disables both name checks, never the shape/grammar checks; the count verb's bag is name-checked the same way and carries the same fieldCheck opt-out; a direct queryBounded/queryAll call is not checked (no bag contract there)), names?: boolean (absent = the client's labels option — OFF by default (the label pass costs a field-catalog read + up to 20 cold name reads per call; the MCP server (iit-mcp-autotask) enables the client labels option when it re-pins to this version (downstream)); true adds the row label siblings: picklist <field>Label (statusLabel), <fk>Name for companyID/contractID/ticketID/roleID/billingCodeID/*ResourceID (contractIDName, assignedResourceIDName) — null, never missing, when the field is keyed with a null value, a 0 id or an unresolved value (a picklist 0 is labelled when the picklist defines it); a names summary appears only when something was left unlabelled (the 20 uncached name-read cap or an unresolved picklist value); false = raw ids, ~30% smaller on a full tickets row), via?: \"post\" | \"get\" (vendor GET has a 2048-char cap), acknowledgeUnscoped?: boolean (query verb only; a walk expected to read over 500 rows with no id scope in the filter is guarded — one pre-flight <resource>.count, and a count over 500 refuses with the typed SCOPE_REQUIRED before the walk; true walks the unscoped set anyway; a count that fails or is blind lets the walk run and the result's scopeNote says so), walk?: object (walk.maxRows: positive integer — (D6): the walk's TOTAL row cap — serves at most maxRows rows in total; the page size stays min(500, limit), so one vendor page may fetch more rows than maxRows and the surplus is sliced off (fetched, not served); the result's truncated flag — false only when the cursor is exhausted, true iff more rows exist past the cap (so an exact-multiple count with a live next page reports true); not combinable with latest) }. Filter grammar: 13 operators (eq, noteq, gt, gte, lt, lte, beginsWith, endsWith, contains, exist, notExist, in, notIn; in/notIn: array or \"1,2,3\") + and/or grouping (no not-group); field names in vendor API casing (via operations.fieldCatalog); caps: 500 OR-conditions / 1 UDF / 8000 chars.",
|
|
51195
|
+
"properties": [
|
|
51196
|
+
{
|
|
51197
|
+
"name": "filter",
|
|
51198
|
+
"type": "FilterCondition[]",
|
|
51199
|
+
"optional": true
|
|
51200
|
+
},
|
|
51201
|
+
{
|
|
51202
|
+
"name": "limit",
|
|
51203
|
+
"type": "number",
|
|
51204
|
+
"optional": true,
|
|
51205
|
+
"default": 500
|
|
51206
|
+
},
|
|
51207
|
+
{
|
|
51208
|
+
"name": "latest",
|
|
51209
|
+
"type": "number",
|
|
51210
|
+
"optional": true
|
|
51211
|
+
},
|
|
51212
|
+
{
|
|
51213
|
+
"name": "noteChars",
|
|
51214
|
+
"type": "number",
|
|
51215
|
+
"optional": true
|
|
51216
|
+
},
|
|
51217
|
+
{
|
|
51218
|
+
"name": "includeFields",
|
|
51219
|
+
"type": "string[]",
|
|
51220
|
+
"optional": true
|
|
51221
|
+
},
|
|
51222
|
+
{
|
|
51223
|
+
"name": "fieldCheck",
|
|
51224
|
+
"type": "boolean",
|
|
51225
|
+
"optional": true,
|
|
51226
|
+
"default": true
|
|
51227
|
+
},
|
|
51228
|
+
{
|
|
51229
|
+
"name": "names",
|
|
51230
|
+
"type": "boolean",
|
|
51231
|
+
"optional": true
|
|
51232
|
+
},
|
|
51233
|
+
{
|
|
51234
|
+
"name": "via",
|
|
51235
|
+
"type": "\"post\" | \"get\"",
|
|
51236
|
+
"optional": true
|
|
51237
|
+
},
|
|
51238
|
+
{
|
|
51239
|
+
"name": "acknowledgeUnscoped",
|
|
51240
|
+
"type": "boolean",
|
|
51241
|
+
"optional": true
|
|
51242
|
+
},
|
|
51243
|
+
{
|
|
51244
|
+
"name": "walk",
|
|
51245
|
+
"type": "object",
|
|
51246
|
+
"optional": true
|
|
51247
|
+
}
|
|
51248
|
+
]
|
|
51249
|
+
}
|
|
51250
|
+
},
|
|
51251
|
+
"inputSchemaStrict": true,
|
|
51252
|
+
"outputSchema": {
|
|
51253
|
+
"type": "QueryActionResult[<Model>,<Entity>]",
|
|
51254
|
+
"drops": []
|
|
51255
|
+
},
|
|
51256
|
+
"examples": [
|
|
51257
|
+
"await invoke(client, 'configuration_item_note_attachments.query', [{ filter: [{ field: 'configurationItemNoteID', op: 'eq', value: 7 }], limit: 25 }])"
|
|
51258
|
+
],
|
|
51259
|
+
"permissions": "unknown",
|
|
51260
|
+
"pagination": {
|
|
51261
|
+
"mode": "cursor",
|
|
51262
|
+
"vendorDefault": 10,
|
|
51263
|
+
"vendorMax": 500,
|
|
51264
|
+
"pageGuard": 1000,
|
|
51265
|
+
"queryBounded": {
|
|
51266
|
+
"default": 500,
|
|
51267
|
+
"max": 2500
|
|
51268
|
+
}
|
|
51269
|
+
},
|
|
51270
|
+
"resolution": null,
|
|
51271
|
+
"retry": {
|
|
51272
|
+
"preset": "retry-ffb3a9cb"
|
|
51273
|
+
},
|
|
51274
|
+
"errors": {
|
|
51275
|
+
"set": 4
|
|
51276
|
+
},
|
|
51277
|
+
"metadata": {
|
|
51278
|
+
"purpose": "Query ConfigurationItemNoteAttachment records with a JSON filter.",
|
|
51279
|
+
"usage": "Server-side pagination: one call walks the vendor cursor internally (page 1 POSTs the QueryModel body with MaxRecords = the walk's internal page size (at most 500; the default POST path — `via: 'get'` issues a GET on page 1); later pages POST the SAME body — IncludeFields, MaxRecords and the preserved filter — to the absolute vendor cursor, rebased to the client base URL; the vendor honours IncludeFields on a continuation and ignores MaxRecords there, so a later page carries the vendor's own page size) until the limit is met or the cursor is null; 1000-page guard (hasMore stays true at the guard). queryAll is the unbounded raw walk — only when you need the ENTIRE set and accept a large payload; default to the bounded query op. noteChars: N (integer >= 1) is an opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose — the same set the server wraps): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result (zero wire — response-side only). latest: N returns the N highest-id rows (id-descending): the vendor has no sort parameter — this is the only ordering channel, and a date window in `filter` narrows the cost; count-anchored — C ≤ 2500 → one count + a ≤6-page walk of the matching set, C > 2500 → count probes + an id-threshold window (≤64 probes; LATEST_THRESHOLD_UNRESOLVED on budget exhaustion), a blind count → a bounded walk with the blind-surface stamp (LATEST_WINDOW_INCOMPLETE on a truncated walk). Parent-scoped entity: the query stays global (filter with configurationItemNoteID eq <parentId> where the parent is known). Explicit walk.maxRows independently sets the TOTAL returned-row cap (including export-sized walks); the ordinary limit is still validated in 1..2500 and only bounds the internal page size for this form. hasMore and truncated remain true at the page guard or while a cursor or unserved fetched rows remain. Self-resource prefixes are accepted in filter fields and includeFields; dotted UDF names are always refused before metadata or vendor requests, never rewritten to another tenant UDF. Include an object-specific configurationItemNoteID filter. configurationItemID identifies the owning asset and is distinct from the attachment path’s note identifier. creatorType, data and fileSize are not queryable. Object-specific filters do not establish exact direct-parent attachment membership; an empty result is conditional on API-user permissions and visibility. The Swagger query response names an attachment model, while this collection uses the existing SDK attachment query contract { items, pageDetails }; a bare-model response is rejected as INVALID_RESPONSE rather than guessed into a collection.",
|
|
51280
|
+
"preferredWhen": "Default for filtered reads (the bounded query op). queryAll is the unbounded raw walk — only when you need the ENTIRE set and accept a large payload; default to the bounded query op. Prefer an includeFields subset over the full model (field names via operations.fieldCatalog). latest: N is the latest-N rows (id-descending) when the newest rows are the goal (the vendor has no sort — count-anchored, docs/API.md §4). Prefer a hand-listed includeFields for common narrow reads (removed the closed fieldsPreset presets — the v1 billing_join field list for billing_items.query, if you need it, is: companyID, ticketID, projectID, timeEntryID, contractServiceID, contractID, billingCodeID, expenseItemID, itemDate, quantity, rate, extendedPrice, totalAmount, nonBillable); noteChars: N caps the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose) to N chars each with the explicit … [+N chars truncated] marker (opt-in; the raw result when absent).",
|
|
51281
|
+
"related": [
|
|
51282
|
+
"configuration_item_note_attachments.get"
|
|
51283
|
+
],
|
|
51284
|
+
"args": "args[0] is a params object: { filter?: FilterCondition[], limit?: total cap (default 500, max 2500; server-side pagination), latest?: number (1-2500 — the N highest-id rows; the vendor has no sort parameter, so this is a count-anchored mechanism — see docs/API.md §4; coexists with limit only when limit >= latest), noteChars?: number (integer >= 1 — opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result) maxRecords?: page size — raw SDK `queryAll`/`query` walks only (this bounded query ignores it; the invoke bag refuses it — pass limit), includeFields?: string[], fieldCheck?: boolean (default true — the pre-request field-name check on includeFields names and filter condition fields; false disables it — consumed by the invoke router, never sent to the vendor), via?: \"post\" | \"get\" (the wire method; the vendor GET has a 2048-char cap), acknowledgeUnscoped?: boolean (query verb only; a walk expected over 500 rows with no id scope in the filter is guarded — one pre-flight <resource>.count, and a count over 500 refuses with the typed SCOPE_REQUIRED before the walk; true walks the unscoped set anyway; a count that fails or is blind lets the walk run and the result’s scopeNote says so), walk?: { maxRows: positive integer (D6: the walk’s TOTAL row cap — serves at most maxRows rows in total; the page size stays min(500, limit), so one vendor page may fetch more rows than maxRows and the surplus is sliced off (fetched, not served); the result’s truncated flag — false only when the cursor is exhausted, true iff more rows exist past the cap (so an exact-multiple count with a live next page reports true); not combinable with latest) } }. Filter grammar: 13 operators: eq, noteq, gt, gte, lt, lte, beginsWith, endsWith, contains, exist, notExist, in, notIn (in/notIn: array or '1,2,3') + and/or grouping (no not-group). Field names in vendor API casing — get them via operations.fieldCatalog. Caps: 500 OR-conditions / 1 UDF / 8000 chars. By default the FULL vendor model is returned (all fields). To slim the payload for context savings pass includeFields with the exact vendor field names you need (discover them via operations.fieldCatalog); only those fields + id come back. The subset persists across the internal page walk.",
|
|
51285
|
+
"untrustedFields": [
|
|
51286
|
+
"title"
|
|
51287
|
+
]
|
|
51288
|
+
},
|
|
51289
|
+
"compact": null,
|
|
51290
|
+
"status": "tested"
|
|
51291
|
+
},
|
|
50340
51292
|
{
|
|
50341
51293
|
"id": "configuration_item_notes.count",
|
|
50342
51294
|
"resource": "configuration_item_notes",
|
|
@@ -85706,8 +86658,8 @@
|
|
|
85706
86658
|
]
|
|
85707
86659
|
},
|
|
85708
86660
|
"operations": {
|
|
85709
|
-
"planHash": "
|
|
85710
|
-
"builtAt": "2026-11-
|
|
86661
|
+
"planHash": "a84c111cf8c415f470fc48dff7ad406f0f67ee9c2a8d75f963e4812e5a2577b2",
|
|
86662
|
+
"builtAt": "2026-11-19T06:42:18.403Z",
|
|
85711
86663
|
"records": [
|
|
85712
86664
|
{
|
|
85713
86665
|
"id": "operations.aggregate",
|