node-autotask 0.76.0 → 0.77.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.
Files changed (39) hide show
  1. package/CHANGELOG.md +6 -0
  2. package/MCP_TOOL_CATALOG.json +137 -9
  3. package/README.md +1 -1
  4. package/capabilities.json +483 -7
  5. package/dist/capabilities-data.js +482 -6
  6. package/dist/capabilities.cjs +4 -4
  7. package/dist/capabilities.js +1 -1
  8. package/dist/{chunk-C4S3EKIK.cjs → chunk-3FZJJX5B.cjs} +3 -3
  9. package/dist/{chunk-55BQEFBO.cjs → chunk-5MH3MPLB.cjs} +31 -30
  10. package/dist/{chunk-Y4BH5N6R.cjs → chunk-6VBOBCWA.cjs} +186 -27
  11. package/dist/{chunk-3SFIKG2R.js → chunk-F5Y7WBWY.js} +181 -22
  12. package/dist/{chunk-ECSE6B3U.js → chunk-G2U6NHPO.js} +3 -3
  13. package/dist/{chunk-YRTOAPWD.cjs → chunk-NAI7XIX4.cjs} +199 -199
  14. package/dist/{chunk-UFK7JYYC.js → chunk-QTFK2HAO.js} +3 -2
  15. package/dist/{chunk-S7QPD6TR.js → chunk-RLXUY4VM.js} +2 -2
  16. package/dist/{index-BbAzrm2i.d.cts → index-B-vNyiD_.d.cts} +47 -1
  17. package/dist/{index-BbAzrm2i.d.ts → index-B-vNyiD_.d.ts} +47 -1
  18. package/dist/{index-MY7qYY5d.d.cts → index-PLdAoAFJ.d.cts} +3 -2
  19. package/dist/{index-CY7exGOe.d.ts → index-ecr6unv3.d.ts} +3 -2
  20. package/dist/index.cjs +84 -84
  21. package/dist/index.d.cts +3 -3
  22. package/dist/index.d.ts +3 -3
  23. package/dist/index.js +5 -5
  24. package/dist/operations/index.cjs +51 -51
  25. package/dist/operations/index.d.cts +4 -4
  26. package/dist/operations/index.d.ts +4 -4
  27. package/dist/operations/index.js +2 -2
  28. package/dist/pool.cjs +12 -12
  29. package/dist/pool.d.cts +1 -1
  30. package/dist/pool.d.ts +1 -1
  31. package/dist/pool.js +4 -4
  32. package/dist/resources/index.cjs +27 -27
  33. package/dist/resources/index.d.cts +2 -2
  34. package/dist/resources/index.d.ts +2 -2
  35. package/dist/resources/index.js +3 -3
  36. package/dist/types/index.d.cts +1 -1
  37. package/dist/types/index.d.ts +1 -1
  38. package/docs/API.md +3 -2
  39. package/package.json +1 -1
package/capabilities.json CHANGED
@@ -1,9 +1,9 @@
1
1
  {
2
- "generatedAt": "2026-11-19T03:48:00.887Z",
2
+ "generatedAt": "2026-11-19T05:20:04.050Z",
3
3
  "groups": {
4
4
  "B": {
5
- "planHash": "ad752908bb8c2b868f1df63ba52fd308bd4eaec8e6c9c9182f97504ad79f5ca4",
6
- "builtAt": "2026-11-19T03:48:00.874Z",
5
+ "planHash": "3b14a93bbda886bce89c87d61ba40092f9acf6a829a959f042be1c3a0744ed42",
6
+ "builtAt": "2026-11-19T05:20:04.039Z",
7
7
  "records": [
8
8
  {
9
9
  "id": "appointments.count",
@@ -42918,8 +42918,8 @@
42918
42918
  ]
42919
42919
  },
42920
42920
  "A": {
42921
- "planHash": "ad752908bb8c2b868f1df63ba52fd308bd4eaec8e6c9c9182f97504ad79f5ca4",
42922
- "builtAt": "2026-11-19T03:48:00.874Z",
42921
+ "planHash": "3b14a93bbda886bce89c87d61ba40092f9acf6a829a959f042be1c3a0744ed42",
42922
+ "builtAt": "2026-11-19T05:20:04.039Z",
42923
42923
  "records": [
42924
42924
  {
42925
42925
  "id": "attachment_info.count",
@@ -49224,6 +49224,482 @@
49224
49224
  "compact": null,
49225
49225
  "status": "tested"
49226
49226
  },
49227
+ {
49228
+ "id": "configuration_item_attachments.count",
49229
+ "resource": "configuration_item_attachments",
49230
+ "udfCapable": false,
49231
+ "operation": "count",
49232
+ "kind": "primitive",
49233
+ "endpoint": "GET|POST /V1.0/ConfigurationItemAttachments/query/count",
49234
+ "effect": "read",
49235
+ "flags": [],
49236
+ "dryRun": false,
49237
+ "envelope": "QueryCountResultModel",
49238
+ "inputSchema": {
49239
+ "params": {
49240
+ "type": "object",
49241
+ "required": false,
49242
+ "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.",
49243
+ "properties": [
49244
+ {
49245
+ "name": "filter",
49246
+ "type": "FilterCondition[]",
49247
+ "optional": true
49248
+ },
49249
+ {
49250
+ "name": "fieldCheck",
49251
+ "type": "boolean",
49252
+ "optional": true
49253
+ }
49254
+ ]
49255
+ }
49256
+ },
49257
+ "inputSchemaStrict": true,
49258
+ "outputSchema": {
49259
+ "type": "QueryCountResultModel",
49260
+ "drops": []
49261
+ },
49262
+ "examples": [
49263
+ "await invoke(client, 'configuration_item_attachments.count', [{ filter: [{ field: 'configurationItemID', op: 'eq', value: 7 }] }])"
49264
+ ],
49265
+ "permissions": "unknown",
49266
+ "pagination": {
49267
+ "mode": "none"
49268
+ },
49269
+ "resolution": null,
49270
+ "retry": {
49271
+ "preset": "retry-ffb3a9cb"
49272
+ },
49273
+ "errors": {
49274
+ "set": 0
49275
+ },
49276
+ "metadata": {
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
+ "preferredWhen": null,
49280
+ "related": [
49281
+ "configuration_item_attachments.query"
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.",
49284
+ "untrustedFields": [
49285
+ "title"
49286
+ ]
49287
+ },
49288
+ "compact": null,
49289
+ "status": "tested"
49290
+ },
49291
+ {
49292
+ "id": "configuration_item_attachments.create",
49293
+ "resource": "configuration_item_attachments",
49294
+ "udfCapable": false,
49295
+ "operation": "create",
49296
+ "kind": "primitive",
49297
+ "endpoint": "POST /V1.0/ConfigurationItems/{parentId}/Attachments",
49298
+ "effect": "write",
49299
+ "flags": [],
49300
+ "dryRun": true,
49301
+ "envelope": "OperationResultModel",
49302
+ "inputSchema": {
49303
+ "parentId": {
49304
+ "type": "string | number",
49305
+ "required": true,
49306
+ "description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
49307
+ },
49308
+ "data": {
49309
+ "type": "object",
49310
+ "required": true,
49311
+ "description": "The record payload (vendor model fields)."
49312
+ }
49313
+ },
49314
+ "inputSchemaStrict": true,
49315
+ "outputSchema": {
49316
+ "type": "OperationResultModel",
49317
+ "drops": []
49318
+ },
49319
+ "examples": [
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 });"
49321
+ ],
49322
+ "permissions": "unknown",
49323
+ "pagination": {
49324
+ "mode": "none"
49325
+ },
49326
+ "resolution": null,
49327
+ "retry": {
49328
+ "preset": "retry-c5657094"
49329
+ },
49330
+ "errors": {
49331
+ "set": 1
49332
+ },
49333
+ "metadata": {
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.",
49337
+ "related": [
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
+ }
49368
+ },
49369
+ "compact": null,
49370
+ "status": "tested"
49371
+ },
49372
+ {
49373
+ "id": "configuration_item_attachments.delete",
49374
+ "resource": "configuration_item_attachments",
49375
+ "udfCapable": false,
49376
+ "operation": "delete",
49377
+ "kind": "primitive",
49378
+ "endpoint": "DELETE /V1.0/ConfigurationItems/{parentId}/Attachments/{id}",
49379
+ "effect": "destructive",
49380
+ "flags": [
49381
+ "idempotent",
49382
+ "requiresApproval"
49383
+ ],
49384
+ "dryRun": true,
49385
+ "envelope": "OperationResultModel (attachment entities: the deleted attachment model is returned, not OperationResultModel)",
49386
+ "inputSchema": {
49387
+ "parentId": {
49388
+ "type": "string | number",
49389
+ "required": true,
49390
+ "description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
49391
+ },
49392
+ "id": {
49393
+ "type": "string | number",
49394
+ "required": true,
49395
+ "description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
49396
+ }
49397
+ },
49398
+ "inputSchemaStrict": true,
49399
+ "outputSchema": {
49400
+ "type": "OperationResultModel (attachment entities: the deleted attachment model is returned, not OperationResultModel)",
49401
+ "drops": []
49402
+ },
49403
+ "examples": [
49404
+ "await invoke(client, 'configuration_item_attachments.delete', [7, 3], { confirm: 'configuration_item_attachments.delete' })"
49405
+ ],
49406
+ "permissions": "unknown",
49407
+ "pagination": {
49408
+ "mode": "none"
49409
+ },
49410
+ "resolution": null,
49411
+ "retry": {
49412
+ "preset": "retry-1849870d"
49413
+ },
49414
+ "errors": {
49415
+ "set": 2
49416
+ },
49417
+ "metadata": {
49418
+ "purpose": "Delete an attachment under a configuration item.",
49419
+ "usage": "Irreversible; dry-run validates the target id first. Parent-scoped: parentId + id.",
49420
+ "preferredWhen": null,
49421
+ "related": [
49422
+ "configuration_item_attachments.get"
49423
+ ],
49424
+ "untrustedFields": [
49425
+ "title"
49426
+ ]
49427
+ },
49428
+ "compact": null,
49429
+ "status": "tested"
49430
+ },
49431
+ {
49432
+ "id": "configuration_item_attachments.get",
49433
+ "resource": "configuration_item_attachments",
49434
+ "udfCapable": false,
49435
+ "operation": "get",
49436
+ "kind": "primitive",
49437
+ "endpoint": "GET /V1.0/ConfigurationItems/{parentId}/Attachments/{id}",
49438
+ "effect": "read",
49439
+ "flags": [],
49440
+ "dryRun": false,
49441
+ "envelope": "ConfigurationItemAttachmentModel",
49442
+ "inputSchema": {
49443
+ "parentId": {
49444
+ "type": "string | number",
49445
+ "required": true,
49446
+ "description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
49447
+ },
49448
+ "id": {
49449
+ "type": "string | number",
49450
+ "required": true,
49451
+ "description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
49452
+ },
49453
+ "opts": {
49454
+ "type": "object",
49455
+ "required": false,
49456
+ "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.",
49457
+ "properties": [
49458
+ {
49459
+ "name": "fresh",
49460
+ "type": "boolean",
49461
+ "optional": true
49462
+ }
49463
+ ]
49464
+ }
49465
+ },
49466
+ "inputSchemaStrict": true,
49467
+ "outputSchema": {
49468
+ "type": "ConfigurationItemAttachmentModel",
49469
+ "drops": []
49470
+ },
49471
+ "examples": [
49472
+ "await client.configurationItemAttachments.get(7, 3)"
49473
+ ],
49474
+ "permissions": "unknown",
49475
+ "pagination": {
49476
+ "mode": "none"
49477
+ },
49478
+ "resolution": null,
49479
+ "retry": {
49480
+ "preset": "retry-ffb3a9cb"
49481
+ },
49482
+ "errors": {
49483
+ "set": 3
49484
+ },
49485
+ "metadata": {
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.",
49489
+ "related": [
49490
+ "configuration_item_attachments.query"
49491
+ ],
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
+ ]
49496
+ },
49497
+ "compact": null,
49498
+ "status": "tested"
49499
+ },
49500
+ {
49501
+ "id": "configuration_item_attachments.getEntityInfo",
49502
+ "resource": "configuration_item_attachments",
49503
+ "udfCapable": false,
49504
+ "operation": "getEntityInfo",
49505
+ "kind": "primitive",
49506
+ "endpoint": "GET /V1.0/ConfigurationItemAttachments/entityInformation",
49507
+ "effect": "read",
49508
+ "flags": [],
49509
+ "dryRun": false,
49510
+ "envelope": "EntityInformationResultModel",
49511
+ "inputSchema": {},
49512
+ "inputSchemaStrict": true,
49513
+ "outputSchema": {
49514
+ "type": "EntityInformationResultModel",
49515
+ "drops": []
49516
+ },
49517
+ "examples": [
49518
+ "await client.configurationItemAttachments.getEntityInfo()"
49519
+ ],
49520
+ "permissions": "unknown",
49521
+ "pagination": {
49522
+ "mode": "none"
49523
+ },
49524
+ "resolution": null,
49525
+ "retry": {
49526
+ "preset": "retry-ffb3a9cb"
49527
+ },
49528
+ "errors": {
49529
+ "set": 0
49530
+ },
49531
+ "metadata": {
49532
+ "purpose": "Get the ConfigurationItemAttachment capability metadata (canCreate/canUpdate/hasUserDefinedFields/...).",
49533
+ "usage": "Unwraps info{}; drives client-side capability checks.",
49534
+ "preferredWhen": null,
49535
+ "related": [
49536
+ "configuration_item_attachments.getFieldInfo"
49537
+ ],
49538
+ "untrustedFields": [
49539
+ "title"
49540
+ ]
49541
+ },
49542
+ "compact": null,
49543
+ "status": "tested"
49544
+ },
49545
+ {
49546
+ "id": "configuration_item_attachments.getFieldInfo",
49547
+ "resource": "configuration_item_attachments",
49548
+ "udfCapable": false,
49549
+ "operation": "getFieldInfo",
49550
+ "kind": "primitive",
49551
+ "endpoint": "GET /V1.0/ConfigurationItemAttachments/entityInformation/fields",
49552
+ "effect": "read",
49553
+ "flags": [],
49554
+ "dryRun": false,
49555
+ "envelope": "FieldInformationResultModel",
49556
+ "inputSchema": {},
49557
+ "inputSchemaStrict": true,
49558
+ "outputSchema": {
49559
+ "type": "FieldInformationResultModel",
49560
+ "drops": []
49561
+ },
49562
+ "examples": [
49563
+ "await client.configurationItemAttachments.getFieldInfo()"
49564
+ ],
49565
+ "permissions": "unknown",
49566
+ "pagination": {
49567
+ "mode": "none"
49568
+ },
49569
+ "resolution": null,
49570
+ "retry": {
49571
+ "preset": "retry-ffb3a9cb"
49572
+ },
49573
+ "errors": {
49574
+ "set": 0
49575
+ },
49576
+ "metadata": {
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).",
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.",
49579
+ "preferredWhen": null,
49580
+ "related": [
49581
+ "configuration_item_attachments.getEntityInfo"
49582
+ ],
49583
+ "untrustedFields": [
49584
+ "title"
49585
+ ]
49586
+ },
49587
+ "compact": null,
49588
+ "status": "tested"
49589
+ },
49590
+ {
49591
+ "id": "configuration_item_attachments.query",
49592
+ "resource": "configuration_item_attachments",
49593
+ "udfCapable": false,
49594
+ "operation": "query",
49595
+ "kind": "primitive",
49596
+ "endpoint": "GET|POST /V1.0/ConfigurationItemAttachments/query",
49597
+ "effect": "read",
49598
+ "flags": [],
49599
+ "dryRun": false,
49600
+ "envelope": "QueryActionResult[<Model>,<Entity>]",
49601
+ "inputSchema": {
49602
+ "params": {
49603
+ "type": "object",
49604
+ "required": false,
49605
+ "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.",
49606
+ "properties": [
49607
+ {
49608
+ "name": "filter",
49609
+ "type": "FilterCondition[]",
49610
+ "optional": true
49611
+ },
49612
+ {
49613
+ "name": "limit",
49614
+ "type": "number",
49615
+ "optional": true,
49616
+ "default": 500
49617
+ },
49618
+ {
49619
+ "name": "latest",
49620
+ "type": "number",
49621
+ "optional": true
49622
+ },
49623
+ {
49624
+ "name": "noteChars",
49625
+ "type": "number",
49626
+ "optional": true
49627
+ },
49628
+ {
49629
+ "name": "includeFields",
49630
+ "type": "string[]",
49631
+ "optional": true
49632
+ },
49633
+ {
49634
+ "name": "fieldCheck",
49635
+ "type": "boolean",
49636
+ "optional": true,
49637
+ "default": true
49638
+ },
49639
+ {
49640
+ "name": "names",
49641
+ "type": "boolean",
49642
+ "optional": true
49643
+ },
49644
+ {
49645
+ "name": "via",
49646
+ "type": "\"post\" | \"get\"",
49647
+ "optional": true
49648
+ },
49649
+ {
49650
+ "name": "acknowledgeUnscoped",
49651
+ "type": "boolean",
49652
+ "optional": true
49653
+ },
49654
+ {
49655
+ "name": "walk",
49656
+ "type": "object",
49657
+ "optional": true
49658
+ }
49659
+ ]
49660
+ }
49661
+ },
49662
+ "inputSchemaStrict": true,
49663
+ "outputSchema": {
49664
+ "type": "QueryActionResult[<Model>,<Entity>]",
49665
+ "drops": []
49666
+ },
49667
+ "examples": [
49668
+ "await invoke(client, 'configuration_item_attachments.query', [{ filter: [{ field: 'configurationItemID', op: 'eq', value: 7 }], limit: 25 }])"
49669
+ ],
49670
+ "permissions": "unknown",
49671
+ "pagination": {
49672
+ "mode": "cursor",
49673
+ "vendorDefault": 10,
49674
+ "vendorMax": 500,
49675
+ "pageGuard": 1000,
49676
+ "queryBounded": {
49677
+ "default": 500,
49678
+ "max": 2500
49679
+ }
49680
+ },
49681
+ "resolution": null,
49682
+ "retry": {
49683
+ "preset": "retry-ffb3a9cb"
49684
+ },
49685
+ "errors": {
49686
+ "set": 4
49687
+ },
49688
+ "metadata": {
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
+ "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
+ "related": [
49693
+ "configuration_item_attachments.get"
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.",
49696
+ "untrustedFields": [
49697
+ "title"
49698
+ ]
49699
+ },
49700
+ "compact": null,
49701
+ "status": "tested"
49702
+ },
49227
49703
  {
49228
49704
  "id": "configuration_item_billing_product_associations.count",
49229
49705
  "resource": "configuration_item_billing_product_associations",
@@ -85706,8 +86182,8 @@
85706
86182
  ]
85707
86183
  },
85708
86184
  "operations": {
85709
- "planHash": "ad752908bb8c2b868f1df63ba52fd308bd4eaec8e6c9c9182f97504ad79f5ca4",
85710
- "builtAt": "2026-11-19T03:48:00.874Z",
86185
+ "planHash": "3b14a93bbda886bce89c87d61ba40092f9acf6a829a959f042be1c3a0744ed42",
86186
+ "builtAt": "2026-11-19T05:20:04.039Z",
85711
86187
  "records": [
85712
86188
  {
85713
86189
  "id": "operations.aggregate",