node-autotask 0.90.0 → 0.92.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 +8 -0
- package/MCP_TOOL_CATALOG.json +360 -9
- package/README.md +1 -1
- package/capabilities.json +2022 -655
- package/dist/capabilities-data.js +2021 -654
- package/dist/capabilities.cjs +4 -4
- package/dist/capabilities.js +1 -1
- package/dist/{chunk-K5X4BPQC.js → chunk-2MC3LDZU.js} +3 -3
- package/dist/{chunk-4CI27SCM.cjs → chunk-ATDGRAX2.cjs} +33 -30
- package/dist/{chunk-HU6OGAPI.js → chunk-ELAU2MT5.js} +5 -2
- package/dist/{chunk-OI6E5XQA.cjs → chunk-H24SV774.cjs} +473 -122
- package/dist/{chunk-D7MJC7HA.cjs → chunk-JPZ7M7QI.cjs} +200 -200
- package/dist/{chunk-CY6USWUY.js → chunk-NQNAEA23.js} +468 -117
- package/dist/{chunk-ZLMYYO7R.cjs → chunk-QXJQIZCT.cjs} +3 -3
- package/dist/{chunk-Q73VQSUP.js → chunk-XAOWO42G.js} +2 -2
- package/dist/{index-4jmitXBs.d.cts → index-B9y5IwT1.d.cts} +115 -1
- package/dist/{index-4jmitXBs.d.ts → index-B9y5IwT1.d.ts} +115 -1
- package/dist/{index-DWyJAad_.d.ts → index-U7Lepdm2.d.ts} +10 -5
- package/dist/{index-BEqbDuMk.d.cts → index-lWek2NrV.d.cts} +10 -5
- package/dist/index.cjs +85 -85
- 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 +6 -4
- package/dist/operations/index.d.ts +6 -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 +5 -2
- package/examples/mcp/manifest.ts +1 -1
- package/examples/mcp/tools-mode.ts +15 -6
- package/examples/mcp/tools-read.ts +8 -2
- package/package.json +1 -1
|
@@ -162,6 +162,36 @@ const CAPABILITY_DATA = {
|
|
|
162
162
|
"RESPONSE_REJECTED",
|
|
163
163
|
"QUERY_TOO_LONG"
|
|
164
164
|
],
|
|
165
|
+
[
|
|
166
|
+
"BAD_REQUEST",
|
|
167
|
+
"CONFIG_ERROR",
|
|
168
|
+
"NETWORK_ERROR",
|
|
169
|
+
"UNAUTHORIZED",
|
|
170
|
+
"FORBIDDEN",
|
|
171
|
+
"RATE_LIMITED",
|
|
172
|
+
"TIMEOUT",
|
|
173
|
+
"SERVER_ERROR",
|
|
174
|
+
"INVALID_RESPONSE",
|
|
175
|
+
"ABORTED",
|
|
176
|
+
"RESPONSE_TOO_LARGE",
|
|
177
|
+
"REDIRECT_BLOCKED"
|
|
178
|
+
],
|
|
179
|
+
[
|
|
180
|
+
"BAD_REQUEST",
|
|
181
|
+
"CONFIG_ERROR",
|
|
182
|
+
"NETWORK_ERROR",
|
|
183
|
+
"UNAUTHORIZED",
|
|
184
|
+
"FORBIDDEN",
|
|
185
|
+
"RATE_LIMITED",
|
|
186
|
+
"TIMEOUT",
|
|
187
|
+
"SERVER_ERROR",
|
|
188
|
+
"INVALID_RESPONSE",
|
|
189
|
+
"ABORTED",
|
|
190
|
+
"RESPONSE_TOO_LARGE",
|
|
191
|
+
"REDIRECT_BLOCKED",
|
|
192
|
+
"RESPONSE_REJECTED",
|
|
193
|
+
"SCOPE_REQUIRED"
|
|
194
|
+
],
|
|
165
195
|
[
|
|
166
196
|
"BAD_REQUEST",
|
|
167
197
|
"CONFIG_ERROR",
|
|
@@ -263,6 +293,40 @@ const CAPABILITY_DATA = {
|
|
|
263
293
|
"RESPONSE_TOO_LARGE",
|
|
264
294
|
"REDIRECT_BLOCKED"
|
|
265
295
|
],
|
|
296
|
+
[
|
|
297
|
+
"BAD_REQUEST",
|
|
298
|
+
"CONFIG_ERROR",
|
|
299
|
+
"NETWORK_ERROR",
|
|
300
|
+
"UNAUTHORIZED",
|
|
301
|
+
"RATE_LIMITED",
|
|
302
|
+
"VALIDATION_FAILED",
|
|
303
|
+
"CONFLICT",
|
|
304
|
+
"TIMEOUT",
|
|
305
|
+
"SERVER_ERROR",
|
|
306
|
+
"INVALID_RESPONSE",
|
|
307
|
+
"ABORTED",
|
|
308
|
+
"RESPONSE_TOO_LARGE",
|
|
309
|
+
"REDIRECT_BLOCKED",
|
|
310
|
+
"FORBIDDEN",
|
|
311
|
+
"NOT_FOUND",
|
|
312
|
+
"MAINTENANCE"
|
|
313
|
+
],
|
|
314
|
+
[
|
|
315
|
+
"BAD_REQUEST",
|
|
316
|
+
"CONFIG_ERROR",
|
|
317
|
+
"NETWORK_ERROR",
|
|
318
|
+
"UNAUTHORIZED",
|
|
319
|
+
"RATE_LIMITED",
|
|
320
|
+
"TIMEOUT",
|
|
321
|
+
"SERVER_ERROR",
|
|
322
|
+
"INVALID_RESPONSE",
|
|
323
|
+
"ABORTED",
|
|
324
|
+
"RESPONSE_TOO_LARGE",
|
|
325
|
+
"REDIRECT_BLOCKED",
|
|
326
|
+
"SCOPE_REQUIRED",
|
|
327
|
+
"FORBIDDEN",
|
|
328
|
+
"RESPONSE_REJECTED"
|
|
329
|
+
],
|
|
266
330
|
[
|
|
267
331
|
"BAD_REQUEST",
|
|
268
332
|
"CONFIG_ERROR",
|
|
@@ -462,8 +526,8 @@ const CAPABILITY_DATA = {
|
|
|
462
526
|
],
|
|
463
527
|
"groups": {
|
|
464
528
|
"B": {
|
|
465
|
-
"planHash": "
|
|
466
|
-
"builtAt": "2026-11-
|
|
529
|
+
"planHash": "21e75d0f8bf9986b21c6b7996dfb1fec78b3aaa9afa86f50f5351c54c733d4ac",
|
|
530
|
+
"builtAt": "2026-11-21T07:49:35.531Z",
|
|
467
531
|
"records": [
|
|
468
532
|
{
|
|
469
533
|
"id": "appointments.count",
|
|
@@ -17237,6 +17301,401 @@ const CAPABILITY_DATA = {
|
|
|
17237
17301
|
"compact": null,
|
|
17238
17302
|
"status": "tested"
|
|
17239
17303
|
},
|
|
17304
|
+
{
|
|
17305
|
+
"id": "internal_locations.count",
|
|
17306
|
+
"resource": "internal_locations",
|
|
17307
|
+
"udfCapable": false,
|
|
17308
|
+
"operation": "count",
|
|
17309
|
+
"kind": "primitive",
|
|
17310
|
+
"endpoint": "POST /V1.0/InternalLocations/query/count",
|
|
17311
|
+
"effect": "read",
|
|
17312
|
+
"flags": [],
|
|
17313
|
+
"dryRun": false,
|
|
17314
|
+
"envelope": "QueryCountResultModel",
|
|
17315
|
+
"inputSchema": {
|
|
17316
|
+
"params": {
|
|
17317
|
+
"type": "object",
|
|
17318
|
+
"required": false,
|
|
17319
|
+
"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.",
|
|
17320
|
+
"properties": [
|
|
17321
|
+
{
|
|
17322
|
+
"name": "filter",
|
|
17323
|
+
"type": "FilterCondition[]",
|
|
17324
|
+
"optional": true
|
|
17325
|
+
},
|
|
17326
|
+
{
|
|
17327
|
+
"name": "fieldCheck",
|
|
17328
|
+
"type": "boolean",
|
|
17329
|
+
"optional": true
|
|
17330
|
+
}
|
|
17331
|
+
]
|
|
17332
|
+
}
|
|
17333
|
+
},
|
|
17334
|
+
"inputSchemaStrict": true,
|
|
17335
|
+
"outputSchema": {
|
|
17336
|
+
"type": "QueryCountResultModel",
|
|
17337
|
+
"drops": []
|
|
17338
|
+
},
|
|
17339
|
+
"examples": [
|
|
17340
|
+
"await invoke(client, 'internal_locations.count', [{ filter: [{ field: 'id', op: 'eq', value: 1 }] }])"
|
|
17341
|
+
],
|
|
17342
|
+
"permissions": "unknown",
|
|
17343
|
+
"pagination": {
|
|
17344
|
+
"mode": "none"
|
|
17345
|
+
},
|
|
17346
|
+
"resolution": null,
|
|
17347
|
+
"retry": {
|
|
17348
|
+
"preset": "retry-ffb3a9cb"
|
|
17349
|
+
},
|
|
17350
|
+
"errors": {
|
|
17351
|
+
"set": 8
|
|
17352
|
+
},
|
|
17353
|
+
"metadata": {
|
|
17354
|
+
"purpose": "Count internal location records matching a JSON filter.",
|
|
17355
|
+
"usage": "Unwraps queryCount; returns a plain number. Read-only internal location view configured in Admin Company Setup, distinct from CompanySiteConfigurations and InternalLocationWithBusinessHours; no create, update, delete or UDF writes, and no automatic write routing to another entity. timeZone returns a Microsoft Time Zone Index value. Country queries match the country display label; for a custom country mapped to Other, filter country with the literal Other rather than the custom text returned in the record. Visibility depends on API-user permissions and tenant data; an empty query does not prove absence. Enable redactPersonalData to mask the SDK personal-data field set.",
|
|
17356
|
+
"preferredWhen": null,
|
|
17357
|
+
"related": [
|
|
17358
|
+
"internal_locations.query"
|
|
17359
|
+
],
|
|
17360
|
+
"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.",
|
|
17361
|
+
"untrustedFields": [
|
|
17362
|
+
"additionalAddressInfo",
|
|
17363
|
+
"country",
|
|
17364
|
+
"name",
|
|
17365
|
+
"timeZone"
|
|
17366
|
+
]
|
|
17367
|
+
},
|
|
17368
|
+
"compact": null,
|
|
17369
|
+
"status": "tested"
|
|
17370
|
+
},
|
|
17371
|
+
{
|
|
17372
|
+
"id": "internal_locations.get",
|
|
17373
|
+
"resource": "internal_locations",
|
|
17374
|
+
"udfCapable": false,
|
|
17375
|
+
"operation": "get",
|
|
17376
|
+
"kind": "primitive",
|
|
17377
|
+
"endpoint": "GET /V1.0/InternalLocations/{id}",
|
|
17378
|
+
"effect": "read",
|
|
17379
|
+
"flags": [],
|
|
17380
|
+
"dryRun": false,
|
|
17381
|
+
"envelope": "ItemQueryResultModel[InternalLocationModel,InternalLocation]",
|
|
17382
|
+
"inputSchema": {
|
|
17383
|
+
"id": {
|
|
17384
|
+
"type": "string | number",
|
|
17385
|
+
"required": true,
|
|
17386
|
+
"description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
|
|
17387
|
+
},
|
|
17388
|
+
"opts": {
|
|
17389
|
+
"type": "object",
|
|
17390
|
+
"required": false,
|
|
17391
|
+
"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.",
|
|
17392
|
+
"properties": [
|
|
17393
|
+
{
|
|
17394
|
+
"name": "fresh",
|
|
17395
|
+
"type": "boolean",
|
|
17396
|
+
"optional": true
|
|
17397
|
+
}
|
|
17398
|
+
]
|
|
17399
|
+
}
|
|
17400
|
+
},
|
|
17401
|
+
"inputSchemaStrict": true,
|
|
17402
|
+
"outputSchema": {
|
|
17403
|
+
"type": "ItemQueryResultModel[InternalLocationModel,InternalLocation]",
|
|
17404
|
+
"drops": []
|
|
17405
|
+
},
|
|
17406
|
+
"examples": [
|
|
17407
|
+
"await invoke(client, 'internal_locations.get', [3])"
|
|
17408
|
+
],
|
|
17409
|
+
"permissions": "unknown",
|
|
17410
|
+
"pagination": {
|
|
17411
|
+
"mode": "none"
|
|
17412
|
+
},
|
|
17413
|
+
"resolution": null,
|
|
17414
|
+
"retry": {
|
|
17415
|
+
"preset": "retry-ffb3a9cb"
|
|
17416
|
+
},
|
|
17417
|
+
"errors": {
|
|
17418
|
+
"set": 3
|
|
17419
|
+
},
|
|
17420
|
+
"metadata": {
|
|
17421
|
+
"purpose": "Get one InternalLocation by id.",
|
|
17422
|
+
"usage": "Returns item from the standard item envelope; item: null is a typed not-found. Read-only internal location view configured in Admin Company Setup, distinct from CompanySiteConfigurations and InternalLocationWithBusinessHours; no create, update, delete or UDF writes, and no automatic write routing to another entity. timeZone returns a Microsoft Time Zone Index value. Country queries match the country display label; for a custom country mapped to Other, filter country with the literal Other rather than the custom text returned in the record. Visibility depends on API-user permissions and tenant data; an empty query does not prove absence. Enable redactPersonalData to mask the SDK personal-data field set.",
|
|
17423
|
+
"preferredWhen": "Use a known internal location id; use internal_locations.query for bounded discovery.",
|
|
17424
|
+
"related": [
|
|
17425
|
+
"internal_locations.query"
|
|
17426
|
+
],
|
|
17427
|
+
"args": "args[0] is the record id (safe integer or decimal string; use the string form above Number.MAX_SAFE_INTEGER). Item GET returns the FULL vendor model — the vendor documents no field selection on single-record reads. For a slim record use an internal_locations.query with includeFields.",
|
|
17428
|
+
"untrustedFields": [
|
|
17429
|
+
"additionalAddressInfo",
|
|
17430
|
+
"country",
|
|
17431
|
+
"name",
|
|
17432
|
+
"timeZone"
|
|
17433
|
+
]
|
|
17434
|
+
},
|
|
17435
|
+
"compact": null,
|
|
17436
|
+
"status": "tested"
|
|
17437
|
+
},
|
|
17438
|
+
{
|
|
17439
|
+
"id": "internal_locations.getEntityInfo",
|
|
17440
|
+
"resource": "internal_locations",
|
|
17441
|
+
"udfCapable": false,
|
|
17442
|
+
"operation": "getEntityInfo",
|
|
17443
|
+
"kind": "primitive",
|
|
17444
|
+
"endpoint": "GET /V1.0/InternalLocations/entityInformation",
|
|
17445
|
+
"effect": "read",
|
|
17446
|
+
"flags": [],
|
|
17447
|
+
"dryRun": false,
|
|
17448
|
+
"envelope": "EntityInformationResultModel",
|
|
17449
|
+
"inputSchema": {},
|
|
17450
|
+
"inputSchemaStrict": true,
|
|
17451
|
+
"outputSchema": {
|
|
17452
|
+
"type": "EntityInformationResultModel",
|
|
17453
|
+
"drops": []
|
|
17454
|
+
},
|
|
17455
|
+
"examples": [
|
|
17456
|
+
"await client.internalLocations.getEntityInfo()"
|
|
17457
|
+
],
|
|
17458
|
+
"permissions": "unknown",
|
|
17459
|
+
"pagination": {
|
|
17460
|
+
"mode": "none"
|
|
17461
|
+
},
|
|
17462
|
+
"resolution": null,
|
|
17463
|
+
"retry": {
|
|
17464
|
+
"preset": "retry-ffb3a9cb"
|
|
17465
|
+
},
|
|
17466
|
+
"errors": {
|
|
17467
|
+
"set": 8
|
|
17468
|
+
},
|
|
17469
|
+
"metadata": {
|
|
17470
|
+
"purpose": "Get the InternalLocation capability metadata (canCreate/canUpdate/hasUserDefinedFields/...).",
|
|
17471
|
+
"usage": "Unwraps info{}; drives client-side capability checks. Read-only internal location view configured in Admin Company Setup, distinct from CompanySiteConfigurations and InternalLocationWithBusinessHours; no create, update, delete or UDF writes, and no automatic write routing to another entity. timeZone returns a Microsoft Time Zone Index value. Country queries match the country display label; for a custom country mapped to Other, filter country with the literal Other rather than the custom text returned in the record. Visibility depends on API-user permissions and tenant data; an empty query does not prove absence. Enable redactPersonalData to mask the SDK personal-data field set.",
|
|
17472
|
+
"preferredWhen": null,
|
|
17473
|
+
"related": [
|
|
17474
|
+
"internal_locations.getFieldInfo"
|
|
17475
|
+
],
|
|
17476
|
+
"untrustedFields": [
|
|
17477
|
+
"additionalAddressInfo",
|
|
17478
|
+
"country",
|
|
17479
|
+
"name",
|
|
17480
|
+
"timeZone"
|
|
17481
|
+
]
|
|
17482
|
+
},
|
|
17483
|
+
"compact": null,
|
|
17484
|
+
"status": "tested"
|
|
17485
|
+
},
|
|
17486
|
+
{
|
|
17487
|
+
"id": "internal_locations.getFieldInfo",
|
|
17488
|
+
"resource": "internal_locations",
|
|
17489
|
+
"udfCapable": false,
|
|
17490
|
+
"operation": "getFieldInfo",
|
|
17491
|
+
"kind": "primitive",
|
|
17492
|
+
"endpoint": "GET /V1.0/InternalLocations/entityInformation/fields",
|
|
17493
|
+
"effect": "read",
|
|
17494
|
+
"flags": [],
|
|
17495
|
+
"dryRun": false,
|
|
17496
|
+
"envelope": "FieldInformationResultModel",
|
|
17497
|
+
"inputSchema": {},
|
|
17498
|
+
"inputSchemaStrict": true,
|
|
17499
|
+
"outputSchema": {
|
|
17500
|
+
"type": "FieldInformationResultModel",
|
|
17501
|
+
"drops": []
|
|
17502
|
+
},
|
|
17503
|
+
"examples": [
|
|
17504
|
+
"await client.internalLocations.getFieldInfo()"
|
|
17505
|
+
],
|
|
17506
|
+
"permissions": "unknown",
|
|
17507
|
+
"pagination": {
|
|
17508
|
+
"mode": "none"
|
|
17509
|
+
},
|
|
17510
|
+
"resolution": null,
|
|
17511
|
+
"retry": {
|
|
17512
|
+
"preset": "retry-ffb3a9cb"
|
|
17513
|
+
},
|
|
17514
|
+
"errors": {
|
|
17515
|
+
"set": 8
|
|
17516
|
+
},
|
|
17517
|
+
"metadata": {
|
|
17518
|
+
"purpose": "Get the InternalLocation field catalog (types, picklists, required, maxLength) — the full raw field dump (the largest read of the info trio; compact discovery: operations.fieldCatalog).",
|
|
17519
|
+
"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.",
|
|
17520
|
+
"preferredWhen": "Read-only internal location view configured in Admin Company Setup, distinct from CompanySiteConfigurations and InternalLocationWithBusinessHours; no create, update, delete or UDF writes, and no automatic write routing to another entity. timeZone returns a Microsoft Time Zone Index value. Country queries match the country display label; for a custom country mapped to Other, filter country with the literal Other rather than the custom text returned in the record. Visibility depends on API-user permissions and tenant data; an empty query does not prove absence. Enable redactPersonalData to mask the SDK personal-data field set.",
|
|
17521
|
+
"related": [
|
|
17522
|
+
"internal_locations.getEntityInfo",
|
|
17523
|
+
"internal_locations.getUdfInfo"
|
|
17524
|
+
],
|
|
17525
|
+
"untrustedFields": [
|
|
17526
|
+
"additionalAddressInfo",
|
|
17527
|
+
"country",
|
|
17528
|
+
"name",
|
|
17529
|
+
"timeZone"
|
|
17530
|
+
]
|
|
17531
|
+
},
|
|
17532
|
+
"compact": null,
|
|
17533
|
+
"status": "tested"
|
|
17534
|
+
},
|
|
17535
|
+
{
|
|
17536
|
+
"id": "internal_locations.getUdfInfo",
|
|
17537
|
+
"resource": "internal_locations",
|
|
17538
|
+
"udfCapable": false,
|
|
17539
|
+
"operation": "getUdfInfo",
|
|
17540
|
+
"kind": "primitive",
|
|
17541
|
+
"endpoint": "GET /V1.0/InternalLocations/entityInformation/userDefinedFields",
|
|
17542
|
+
"effect": "read",
|
|
17543
|
+
"flags": [],
|
|
17544
|
+
"dryRun": false,
|
|
17545
|
+
"envelope": "UserDefinedFieldInformationResultModel",
|
|
17546
|
+
"inputSchema": {},
|
|
17547
|
+
"inputSchemaStrict": true,
|
|
17548
|
+
"outputSchema": {
|
|
17549
|
+
"type": "UserDefinedFieldInformationResultModel",
|
|
17550
|
+
"drops": []
|
|
17551
|
+
},
|
|
17552
|
+
"examples": [
|
|
17553
|
+
"await client.internalLocations.getUdfInfo()"
|
|
17554
|
+
],
|
|
17555
|
+
"permissions": "unknown",
|
|
17556
|
+
"pagination": {
|
|
17557
|
+
"mode": "none"
|
|
17558
|
+
},
|
|
17559
|
+
"resolution": null,
|
|
17560
|
+
"retry": {
|
|
17561
|
+
"preset": "retry-ffb3a9cb"
|
|
17562
|
+
},
|
|
17563
|
+
"errors": {
|
|
17564
|
+
"set": 8
|
|
17565
|
+
},
|
|
17566
|
+
"metadata": {
|
|
17567
|
+
"purpose": "Get the InternalLocation user-defined-field catalog.",
|
|
17568
|
+
"usage": "Unwraps fields[]; only meaningful where the entity is UDF-capable. (entity is not UDF-capable; catalog is expected empty). Read-only internal location view configured in Admin Company Setup, distinct from CompanySiteConfigurations and InternalLocationWithBusinessHours; no create, update, delete or UDF writes, and no automatic write routing to another entity. timeZone returns a Microsoft Time Zone Index value. Country queries match the country display label; for a custom country mapped to Other, filter country with the literal Other rather than the custom text returned in the record. Visibility depends on API-user permissions and tenant data; an empty query does not prove absence. Enable redactPersonalData to mask the SDK personal-data field set.",
|
|
17569
|
+
"preferredWhen": null,
|
|
17570
|
+
"related": [
|
|
17571
|
+
"internal_locations.getFieldInfo"
|
|
17572
|
+
],
|
|
17573
|
+
"untrustedFields": [
|
|
17574
|
+
"additionalAddressInfo",
|
|
17575
|
+
"country",
|
|
17576
|
+
"name",
|
|
17577
|
+
"timeZone"
|
|
17578
|
+
]
|
|
17579
|
+
},
|
|
17580
|
+
"compact": null,
|
|
17581
|
+
"status": "tested"
|
|
17582
|
+
},
|
|
17583
|
+
{
|
|
17584
|
+
"id": "internal_locations.query",
|
|
17585
|
+
"resource": "internal_locations",
|
|
17586
|
+
"udfCapable": false,
|
|
17587
|
+
"operation": "query",
|
|
17588
|
+
"kind": "primitive",
|
|
17589
|
+
"endpoint": "GET|POST /V1.0/InternalLocations/query",
|
|
17590
|
+
"effect": "read",
|
|
17591
|
+
"flags": [],
|
|
17592
|
+
"dryRun": false,
|
|
17593
|
+
"envelope": "QueryActionResult[InternalLocationModel,InternalLocation]",
|
|
17594
|
+
"inputSchema": {
|
|
17595
|
+
"params": {
|
|
17596
|
+
"type": "object",
|
|
17597
|
+
"required": false,
|
|
17598
|
+
"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 + a capped number of cold name reads per call (several ids of one table share one batched read); 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/productID/vendorID (a company)/configurationItemCategoryID/*ResourceID (contractIDName, productIDName, assignedResourceIDName) — null, never missing, when the field is keyed with a null value, a 0 id (except companyID/vendorID 0, which name the tenant owner's own company) 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 uncached name-read cap, an id a batched name read did not return, 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.",
|
|
17599
|
+
"properties": [
|
|
17600
|
+
{
|
|
17601
|
+
"name": "filter",
|
|
17602
|
+
"type": "FilterCondition[]",
|
|
17603
|
+
"optional": true
|
|
17604
|
+
},
|
|
17605
|
+
{
|
|
17606
|
+
"name": "limit",
|
|
17607
|
+
"type": "number",
|
|
17608
|
+
"optional": true,
|
|
17609
|
+
"default": 500
|
|
17610
|
+
},
|
|
17611
|
+
{
|
|
17612
|
+
"name": "latest",
|
|
17613
|
+
"type": "number",
|
|
17614
|
+
"optional": true
|
|
17615
|
+
},
|
|
17616
|
+
{
|
|
17617
|
+
"name": "noteChars",
|
|
17618
|
+
"type": "number",
|
|
17619
|
+
"optional": true
|
|
17620
|
+
},
|
|
17621
|
+
{
|
|
17622
|
+
"name": "includeFields",
|
|
17623
|
+
"type": "string[]",
|
|
17624
|
+
"optional": true
|
|
17625
|
+
},
|
|
17626
|
+
{
|
|
17627
|
+
"name": "fieldCheck",
|
|
17628
|
+
"type": "boolean",
|
|
17629
|
+
"optional": true,
|
|
17630
|
+
"default": true
|
|
17631
|
+
},
|
|
17632
|
+
{
|
|
17633
|
+
"name": "names",
|
|
17634
|
+
"type": "boolean",
|
|
17635
|
+
"optional": true
|
|
17636
|
+
},
|
|
17637
|
+
{
|
|
17638
|
+
"name": "via",
|
|
17639
|
+
"type": "\"post\" | \"get\"",
|
|
17640
|
+
"optional": true
|
|
17641
|
+
},
|
|
17642
|
+
{
|
|
17643
|
+
"name": "acknowledgeUnscoped",
|
|
17644
|
+
"type": "boolean",
|
|
17645
|
+
"optional": true
|
|
17646
|
+
},
|
|
17647
|
+
{
|
|
17648
|
+
"name": "walk",
|
|
17649
|
+
"type": "object",
|
|
17650
|
+
"optional": true
|
|
17651
|
+
}
|
|
17652
|
+
]
|
|
17653
|
+
}
|
|
17654
|
+
},
|
|
17655
|
+
"inputSchemaStrict": true,
|
|
17656
|
+
"outputSchema": {
|
|
17657
|
+
"type": "QueryActionResult[InternalLocationModel,InternalLocation]",
|
|
17658
|
+
"drops": []
|
|
17659
|
+
},
|
|
17660
|
+
"examples": [
|
|
17661
|
+
"await invoke(client, 'internal_locations.query', [{ filter: [{ field: 'id', op: 'eq', value: 1 }], limit: 25 }])"
|
|
17662
|
+
],
|
|
17663
|
+
"permissions": "unknown",
|
|
17664
|
+
"pagination": {
|
|
17665
|
+
"mode": "cursor",
|
|
17666
|
+
"vendorDefault": 10,
|
|
17667
|
+
"vendorMax": 500,
|
|
17668
|
+
"pageGuard": 1000,
|
|
17669
|
+
"queryBounded": {
|
|
17670
|
+
"default": 500,
|
|
17671
|
+
"max": 2500
|
|
17672
|
+
}
|
|
17673
|
+
},
|
|
17674
|
+
"resolution": null,
|
|
17675
|
+
"retry": {
|
|
17676
|
+
"preset": "retry-ffb3a9cb"
|
|
17677
|
+
},
|
|
17678
|
+
"errors": {
|
|
17679
|
+
"set": 9
|
|
17680
|
+
},
|
|
17681
|
+
"metadata": {
|
|
17682
|
+
"purpose": "Query InternalLocation records with a JSON filter.",
|
|
17683
|
+
"usage": "Server-side pagination: one call walks the vendor cursor internally and preserves the initial HTTP method until the limit is met or the cursor is null. By default, each POST carries the same QueryModel body (IncludeFields, MaxRecords and the original filter). The vendor honours IncludeFields on POST continuations and uses its own continuation page size. With `via: 'get'`, the SDK follows the GET cursor with the original search parameters. Cursors must stay on the configured origin; 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). 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. Read-only internal location view configured in Admin Company Setup, distinct from CompanySiteConfigurations and InternalLocationWithBusinessHours; no create, update, delete or UDF writes, and no automatic write routing to another entity. timeZone returns a Microsoft Time Zone Index value. Country queries match the country display label; for a custom country mapped to Other, filter country with the literal Other rather than the custom text returned in the record. Visibility depends on API-user permissions and tenant data; an empty query does not prove absence. Enable redactPersonalData to mask the SDK personal-data field set.",
|
|
17684
|
+
"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).",
|
|
17685
|
+
"related": [
|
|
17686
|
+
"internal_locations.get"
|
|
17687
|
+
],
|
|
17688
|
+
"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.",
|
|
17689
|
+
"untrustedFields": [
|
|
17690
|
+
"additionalAddressInfo",
|
|
17691
|
+
"country",
|
|
17692
|
+
"name",
|
|
17693
|
+
"timeZone"
|
|
17694
|
+
]
|
|
17695
|
+
},
|
|
17696
|
+
"compact": null,
|
|
17697
|
+
"status": "tested"
|
|
17698
|
+
},
|
|
17240
17699
|
{
|
|
17241
17700
|
"id": "inventory_products.count",
|
|
17242
17701
|
"resource": "inventory_products",
|
|
@@ -18600,7 +19059,7 @@ const CAPABILITY_DATA = {
|
|
|
18600
19059
|
"preset": "retry-1849870d"
|
|
18601
19060
|
},
|
|
18602
19061
|
"errors": {
|
|
18603
|
-
"set":
|
|
19062
|
+
"set": 10
|
|
18604
19063
|
},
|
|
18605
19064
|
"metadata": {
|
|
18606
19065
|
"purpose": "delete article root records.",
|
|
@@ -30100,7 +30559,7 @@ const CAPABILITY_DATA = {
|
|
|
30100
30559
|
"preset": "retry-ffb3a9cb"
|
|
30101
30560
|
},
|
|
30102
30561
|
"errors": {
|
|
30103
|
-
"set":
|
|
30562
|
+
"set": 11
|
|
30104
30563
|
},
|
|
30105
30564
|
"metadata": {
|
|
30106
30565
|
"purpose": "Get a resource's workload in a single call: its open tickets (rows + the exact open totals), its task assignments and the tasks behind them, its time-off balances and requests.",
|
|
@@ -34306,7 +34765,7 @@ const CAPABILITY_DATA = {
|
|
|
34306
34765
|
"preset": "retry-ffb3a9cb"
|
|
34307
34766
|
},
|
|
34308
34767
|
"errors": {
|
|
34309
|
-
"set":
|
|
34768
|
+
"set": 12
|
|
34310
34769
|
},
|
|
34311
34770
|
"metadata": {
|
|
34312
34771
|
"purpose": "Get a service call with its tickets, tasks and resource assignments in a single call — the assignment join runs through the call's task row ids (serviceCallTaskID).",
|
|
@@ -36069,12 +36528,12 @@ const CAPABILITY_DATA = {
|
|
|
36069
36528
|
"status": "tested"
|
|
36070
36529
|
},
|
|
36071
36530
|
{
|
|
36072
|
-
"id": "
|
|
36073
|
-
"resource": "
|
|
36531
|
+
"id": "shipping_types.count",
|
|
36532
|
+
"resource": "shipping_types",
|
|
36074
36533
|
"udfCapable": false,
|
|
36075
36534
|
"operation": "count",
|
|
36076
36535
|
"kind": "primitive",
|
|
36077
|
-
"endpoint": "
|
|
36536
|
+
"endpoint": "POST /V1.0/ShippingTypes/query/count",
|
|
36078
36537
|
"effect": "read",
|
|
36079
36538
|
"flags": [],
|
|
36080
36539
|
"dryRun": false,
|
|
@@ -36104,7 +36563,7 @@ const CAPABILITY_DATA = {
|
|
|
36104
36563
|
"drops": []
|
|
36105
36564
|
},
|
|
36106
36565
|
"examples": [
|
|
36107
|
-
"await client.
|
|
36566
|
+
"await invoke(client, 'shipping_types.count', [{ filter: [{ field: 'id', op: 'eq', value: 1 }] }])"
|
|
36108
36567
|
],
|
|
36109
36568
|
"permissions": "unknown",
|
|
36110
36569
|
"pagination": {
|
|
@@ -36115,14 +36574,14 @@ const CAPABILITY_DATA = {
|
|
|
36115
36574
|
"preset": "retry-ffb3a9cb"
|
|
36116
36575
|
},
|
|
36117
36576
|
"errors": {
|
|
36118
|
-
"set":
|
|
36577
|
+
"set": 8
|
|
36119
36578
|
},
|
|
36120
36579
|
"metadata": {
|
|
36121
|
-
"purpose": "Count
|
|
36122
|
-
"usage": "Unwraps queryCount; returns a plain number.",
|
|
36580
|
+
"purpose": "Count shipping type records matching a JSON filter.",
|
|
36581
|
+
"usage": "Unwraps queryCount; returns a plain number. Read-only shipping catalog configured in Admin and referenced by Quotes in CRM; no create, update, delete or UDF writes. Visibility depends on API-user permissions and tenant data; an empty query does not prove absence. The official field table labels billingCodeID as a ProjectCharges reference, but its name and that reference disagree; no new navigation contract is inferred. Discover authoritative field metadata with shipping_types.getFieldInfo before interpreting the reference.",
|
|
36123
36582
|
"preferredWhen": null,
|
|
36124
36583
|
"related": [
|
|
36125
|
-
"
|
|
36584
|
+
"shipping_types.query"
|
|
36126
36585
|
],
|
|
36127
36586
|
"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.",
|
|
36128
36587
|
"untrustedFields": [
|
|
@@ -36134,16 +36593,16 @@ const CAPABILITY_DATA = {
|
|
|
36134
36593
|
"status": "tested"
|
|
36135
36594
|
},
|
|
36136
36595
|
{
|
|
36137
|
-
"id": "
|
|
36138
|
-
"resource": "
|
|
36596
|
+
"id": "shipping_types.get",
|
|
36597
|
+
"resource": "shipping_types",
|
|
36139
36598
|
"udfCapable": false,
|
|
36140
36599
|
"operation": "get",
|
|
36141
36600
|
"kind": "primitive",
|
|
36142
|
-
"endpoint": "GET /V1.0/
|
|
36601
|
+
"endpoint": "GET /V1.0/ShippingTypes/{id}",
|
|
36143
36602
|
"effect": "read",
|
|
36144
36603
|
"flags": [],
|
|
36145
36604
|
"dryRun": false,
|
|
36146
|
-
"envelope": "ItemQueryResultModel[
|
|
36605
|
+
"envelope": "ItemQueryResultModel[ShippingTypeModel,ShippingType]",
|
|
36147
36606
|
"inputSchema": {
|
|
36148
36607
|
"id": {
|
|
36149
36608
|
"type": "string | number",
|
|
@@ -36165,11 +36624,11 @@ const CAPABILITY_DATA = {
|
|
|
36165
36624
|
},
|
|
36166
36625
|
"inputSchemaStrict": true,
|
|
36167
36626
|
"outputSchema": {
|
|
36168
|
-
"type": "ItemQueryResultModel[
|
|
36627
|
+
"type": "ItemQueryResultModel[ShippingTypeModel,ShippingType]",
|
|
36169
36628
|
"drops": []
|
|
36170
36629
|
},
|
|
36171
36630
|
"examples": [
|
|
36172
|
-
"await client.
|
|
36631
|
+
"await invoke(client, 'shipping_types.get', [3])"
|
|
36173
36632
|
],
|
|
36174
36633
|
"permissions": "unknown",
|
|
36175
36634
|
"pagination": {
|
|
@@ -36183,13 +36642,13 @@ const CAPABILITY_DATA = {
|
|
|
36183
36642
|
"set": 3
|
|
36184
36643
|
},
|
|
36185
36644
|
"metadata": {
|
|
36186
|
-
"purpose": "Get one
|
|
36187
|
-
"usage": "item: null on
|
|
36188
|
-
"preferredWhen": "
|
|
36645
|
+
"purpose": "Get one ShippingType by id.",
|
|
36646
|
+
"usage": "Returns item from the standard item envelope; item: null is a typed not-found. Read-only shipping catalog configured in Admin and referenced by Quotes in CRM; no create, update, delete or UDF writes. Visibility depends on API-user permissions and tenant data; an empty query does not prove absence. The official field table labels billingCodeID as a ProjectCharges reference, but its name and that reference disagree; no new navigation contract is inferred. Discover authoritative field metadata with shipping_types.getFieldInfo before interpreting the reference.",
|
|
36647
|
+
"preferredWhen": "Use a known shipping type id; use shipping_types.query for bounded discovery.",
|
|
36189
36648
|
"related": [
|
|
36190
|
-
"
|
|
36649
|
+
"shipping_types.query"
|
|
36191
36650
|
],
|
|
36192
|
-
"args": "args[0] is the record id (
|
|
36651
|
+
"args": "args[0] is the record id (safe integer or decimal string; use the string form above Number.MAX_SAFE_INTEGER). Item GET returns the FULL vendor model — the vendor documents no field selection on single-record reads. For a slim record use a shipping_types.query with includeFields.",
|
|
36193
36652
|
"untrustedFields": [
|
|
36194
36653
|
"description",
|
|
36195
36654
|
"name"
|
|
@@ -36199,12 +36658,12 @@ const CAPABILITY_DATA = {
|
|
|
36199
36658
|
"status": "tested"
|
|
36200
36659
|
},
|
|
36201
36660
|
{
|
|
36202
|
-
"id": "
|
|
36203
|
-
"resource": "
|
|
36661
|
+
"id": "shipping_types.getEntityInfo",
|
|
36662
|
+
"resource": "shipping_types",
|
|
36204
36663
|
"udfCapable": false,
|
|
36205
36664
|
"operation": "getEntityInfo",
|
|
36206
36665
|
"kind": "primitive",
|
|
36207
|
-
"endpoint": "GET /V1.0/
|
|
36666
|
+
"endpoint": "GET /V1.0/ShippingTypes/entityInformation",
|
|
36208
36667
|
"effect": "read",
|
|
36209
36668
|
"flags": [],
|
|
36210
36669
|
"dryRun": false,
|
|
@@ -36216,7 +36675,7 @@ const CAPABILITY_DATA = {
|
|
|
36216
36675
|
"drops": []
|
|
36217
36676
|
},
|
|
36218
36677
|
"examples": [
|
|
36219
|
-
"await client.
|
|
36678
|
+
"await client.shippingTypes.getEntityInfo()"
|
|
36220
36679
|
],
|
|
36221
36680
|
"permissions": "unknown",
|
|
36222
36681
|
"pagination": {
|
|
@@ -36227,14 +36686,14 @@ const CAPABILITY_DATA = {
|
|
|
36227
36686
|
"preset": "retry-ffb3a9cb"
|
|
36228
36687
|
},
|
|
36229
36688
|
"errors": {
|
|
36230
|
-
"set":
|
|
36689
|
+
"set": 8
|
|
36231
36690
|
},
|
|
36232
36691
|
"metadata": {
|
|
36233
|
-
"purpose": "Get the
|
|
36234
|
-
"usage": "Unwraps info{}; drives client-side capability checks.",
|
|
36692
|
+
"purpose": "Get the ShippingType capability metadata (canCreate/canUpdate/hasUserDefinedFields/...).",
|
|
36693
|
+
"usage": "Unwraps info{}; drives client-side capability checks. Read-only shipping catalog configured in Admin and referenced by Quotes in CRM; no create, update, delete or UDF writes. Visibility depends on API-user permissions and tenant data; an empty query does not prove absence. The official field table labels billingCodeID as a ProjectCharges reference, but its name and that reference disagree; no new navigation contract is inferred. Discover authoritative field metadata with shipping_types.getFieldInfo before interpreting the reference.",
|
|
36235
36694
|
"preferredWhen": null,
|
|
36236
36695
|
"related": [
|
|
36237
|
-
"
|
|
36696
|
+
"shipping_types.getFieldInfo"
|
|
36238
36697
|
],
|
|
36239
36698
|
"untrustedFields": [
|
|
36240
36699
|
"description",
|
|
@@ -36245,12 +36704,12 @@ const CAPABILITY_DATA = {
|
|
|
36245
36704
|
"status": "tested"
|
|
36246
36705
|
},
|
|
36247
36706
|
{
|
|
36248
|
-
"id": "
|
|
36249
|
-
"resource": "
|
|
36707
|
+
"id": "shipping_types.getFieldInfo",
|
|
36708
|
+
"resource": "shipping_types",
|
|
36250
36709
|
"udfCapable": false,
|
|
36251
36710
|
"operation": "getFieldInfo",
|
|
36252
36711
|
"kind": "primitive",
|
|
36253
|
-
"endpoint": "GET /V1.0/
|
|
36712
|
+
"endpoint": "GET /V1.0/ShippingTypes/entityInformation/fields",
|
|
36254
36713
|
"effect": "read",
|
|
36255
36714
|
"flags": [],
|
|
36256
36715
|
"dryRun": false,
|
|
@@ -36262,7 +36721,7 @@ const CAPABILITY_DATA = {
|
|
|
36262
36721
|
"drops": []
|
|
36263
36722
|
},
|
|
36264
36723
|
"examples": [
|
|
36265
|
-
"await client.
|
|
36724
|
+
"await client.shippingTypes.getFieldInfo()"
|
|
36266
36725
|
],
|
|
36267
36726
|
"permissions": "unknown",
|
|
36268
36727
|
"pagination": {
|
|
@@ -36273,15 +36732,15 @@ const CAPABILITY_DATA = {
|
|
|
36273
36732
|
"preset": "retry-ffb3a9cb"
|
|
36274
36733
|
},
|
|
36275
36734
|
"errors": {
|
|
36276
|
-
"set":
|
|
36735
|
+
"set": 8
|
|
36277
36736
|
},
|
|
36278
36737
|
"metadata": {
|
|
36279
|
-
"purpose": "Get the
|
|
36738
|
+
"purpose": "Get the ShippingType field catalog (types, picklists, required, maxLength) — the full raw field dump (the largest read of the info trio; compact discovery: operations.fieldCatalog).",
|
|
36280
36739
|
"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.",
|
|
36281
|
-
"preferredWhen":
|
|
36740
|
+
"preferredWhen": "Read-only shipping catalog configured in Admin and referenced by Quotes in CRM; no create, update, delete or UDF writes. Visibility depends on API-user permissions and tenant data; an empty query does not prove absence. The official field table labels billingCodeID as a ProjectCharges reference, but its name and that reference disagree; no new navigation contract is inferred. Discover authoritative field metadata with shipping_types.getFieldInfo before interpreting the reference.",
|
|
36282
36741
|
"related": [
|
|
36283
|
-
"
|
|
36284
|
-
"
|
|
36742
|
+
"shipping_types.getEntityInfo",
|
|
36743
|
+
"shipping_types.getUdfInfo"
|
|
36285
36744
|
],
|
|
36286
36745
|
"untrustedFields": [
|
|
36287
36746
|
"description",
|
|
@@ -36292,12 +36751,12 @@ const CAPABILITY_DATA = {
|
|
|
36292
36751
|
"status": "tested"
|
|
36293
36752
|
},
|
|
36294
36753
|
{
|
|
36295
|
-
"id": "
|
|
36296
|
-
"resource": "
|
|
36754
|
+
"id": "shipping_types.getUdfInfo",
|
|
36755
|
+
"resource": "shipping_types",
|
|
36297
36756
|
"udfCapable": false,
|
|
36298
36757
|
"operation": "getUdfInfo",
|
|
36299
36758
|
"kind": "primitive",
|
|
36300
|
-
"endpoint": "GET /V1.0/
|
|
36759
|
+
"endpoint": "GET /V1.0/ShippingTypes/entityInformation/userDefinedFields",
|
|
36301
36760
|
"effect": "read",
|
|
36302
36761
|
"flags": [],
|
|
36303
36762
|
"dryRun": false,
|
|
@@ -36309,7 +36768,7 @@ const CAPABILITY_DATA = {
|
|
|
36309
36768
|
"drops": []
|
|
36310
36769
|
},
|
|
36311
36770
|
"examples": [
|
|
36312
|
-
"await client.
|
|
36771
|
+
"await client.shippingTypes.getUdfInfo()"
|
|
36313
36772
|
],
|
|
36314
36773
|
"permissions": "unknown",
|
|
36315
36774
|
"pagination": {
|
|
@@ -36320,14 +36779,14 @@ const CAPABILITY_DATA = {
|
|
|
36320
36779
|
"preset": "retry-ffb3a9cb"
|
|
36321
36780
|
},
|
|
36322
36781
|
"errors": {
|
|
36323
|
-
"set":
|
|
36782
|
+
"set": 8
|
|
36324
36783
|
},
|
|
36325
36784
|
"metadata": {
|
|
36326
|
-
"purpose": "Get the
|
|
36327
|
-
"usage": "Unwraps fields[]; only meaningful where the entity is UDF-capable. (entity is not UDF-capable; catalog is expected empty).",
|
|
36785
|
+
"purpose": "Get the ShippingType user-defined-field catalog.",
|
|
36786
|
+
"usage": "Unwraps fields[]; only meaningful where the entity is UDF-capable. (entity is not UDF-capable; catalog is expected empty). Read-only shipping catalog configured in Admin and referenced by Quotes in CRM; no create, update, delete or UDF writes. Visibility depends on API-user permissions and tenant data; an empty query does not prove absence. The official field table labels billingCodeID as a ProjectCharges reference, but its name and that reference disagree; no new navigation contract is inferred. Discover authoritative field metadata with shipping_types.getFieldInfo before interpreting the reference.",
|
|
36328
36787
|
"preferredWhen": null,
|
|
36329
36788
|
"related": [
|
|
36330
|
-
"
|
|
36789
|
+
"shipping_types.getFieldInfo"
|
|
36331
36790
|
],
|
|
36332
36791
|
"untrustedFields": [
|
|
36333
36792
|
"description",
|
|
@@ -36338,16 +36797,16 @@ const CAPABILITY_DATA = {
|
|
|
36338
36797
|
"status": "tested"
|
|
36339
36798
|
},
|
|
36340
36799
|
{
|
|
36341
|
-
"id": "
|
|
36342
|
-
"resource": "
|
|
36800
|
+
"id": "shipping_types.query",
|
|
36801
|
+
"resource": "shipping_types",
|
|
36343
36802
|
"udfCapable": false,
|
|
36344
36803
|
"operation": "query",
|
|
36345
36804
|
"kind": "primitive",
|
|
36346
|
-
"endpoint": "GET|POST /V1.0/
|
|
36805
|
+
"endpoint": "GET|POST /V1.0/ShippingTypes/query",
|
|
36347
36806
|
"effect": "read",
|
|
36348
36807
|
"flags": [],
|
|
36349
36808
|
"dryRun": false,
|
|
36350
|
-
"envelope": "QueryActionResult[
|
|
36809
|
+
"envelope": "QueryActionResult[ShippingTypeModel,ShippingType]",
|
|
36351
36810
|
"inputSchema": {
|
|
36352
36811
|
"params": {
|
|
36353
36812
|
"type": "object",
|
|
@@ -36411,11 +36870,11 @@ const CAPABILITY_DATA = {
|
|
|
36411
36870
|
},
|
|
36412
36871
|
"inputSchemaStrict": true,
|
|
36413
36872
|
"outputSchema": {
|
|
36414
|
-
"type": "QueryActionResult[
|
|
36873
|
+
"type": "QueryActionResult[ShippingTypeModel,ShippingType]",
|
|
36415
36874
|
"drops": []
|
|
36416
36875
|
},
|
|
36417
36876
|
"examples": [
|
|
36418
|
-
"await client.
|
|
36877
|
+
"await invoke(client, 'shipping_types.query', [{ filter: [{ field: 'id', op: 'eq', value: 1 }], limit: 25 }])"
|
|
36419
36878
|
],
|
|
36420
36879
|
"permissions": "unknown",
|
|
36421
36880
|
"pagination": {
|
|
@@ -36433,16 +36892,16 @@ const CAPABILITY_DATA = {
|
|
|
36433
36892
|
"preset": "retry-ffb3a9cb"
|
|
36434
36893
|
},
|
|
36435
36894
|
"errors": {
|
|
36436
|
-
"set":
|
|
36895
|
+
"set": 9
|
|
36437
36896
|
},
|
|
36438
36897
|
"metadata": {
|
|
36439
|
-
"purpose": "Query
|
|
36440
|
-
"usage": "Server-side pagination: one call walks the vendor cursor internally and preserves the initial HTTP method until the limit is met or the cursor is null. By default, each POST carries the same QueryModel body (IncludeFields, MaxRecords and the original filter). The vendor honours IncludeFields on POST continuations and uses its own continuation page size. With `via: 'get'`, the SDK follows the GET cursor with the original search parameters. Cursors must stay on the configured origin; 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). 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.",
|
|
36898
|
+
"purpose": "Query ShippingType records with a JSON filter.",
|
|
36899
|
+
"usage": "Server-side pagination: one call walks the vendor cursor internally and preserves the initial HTTP method until the limit is met or the cursor is null. By default, each POST carries the same QueryModel body (IncludeFields, MaxRecords and the original filter). The vendor honours IncludeFields on POST continuations and uses its own continuation page size. With `via: 'get'`, the SDK follows the GET cursor with the original search parameters. Cursors must stay on the configured origin; 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). 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. Read-only shipping catalog configured in Admin and referenced by Quotes in CRM; no create, update, delete or UDF writes. Visibility depends on API-user permissions and tenant data; an empty query does not prove absence. The official field table labels billingCodeID as a ProjectCharges reference, but its name and that reference disagree; no new navigation contract is inferred. Discover authoritative field metadata with shipping_types.getFieldInfo before interpreting the reference.",
|
|
36441
36900
|
"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).",
|
|
36442
36901
|
"related": [
|
|
36443
|
-
"
|
|
36902
|
+
"shipping_types.get"
|
|
36444
36903
|
],
|
|
36445
|
-
"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.
|
|
36904
|
+
"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.",
|
|
36446
36905
|
"untrustedFields": [
|
|
36447
36906
|
"description",
|
|
36448
36907
|
"name"
|
|
@@ -36452,149 +36911,12 @@ const CAPABILITY_DATA = {
|
|
|
36452
36911
|
"status": "tested"
|
|
36453
36912
|
},
|
|
36454
36913
|
{
|
|
36455
|
-
"id": "skills.
|
|
36456
|
-
"resource": "skills",
|
|
36457
|
-
"udfCapable": false,
|
|
36458
|
-
"operation": "resolve",
|
|
36459
|
-
"kind": "helper",
|
|
36460
|
-
"endpoint": null,
|
|
36461
|
-
"effect": "read",
|
|
36462
|
-
"flags": [],
|
|
36463
|
-
"dryRun": false,
|
|
36464
|
-
"envelope": null,
|
|
36465
|
-
"inputSchema": {
|
|
36466
|
-
"identifier": {
|
|
36467
|
-
"type": "string | number",
|
|
36468
|
-
"required": true,
|
|
36469
|
-
"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)."
|
|
36470
|
-
},
|
|
36471
|
-
"opts": {
|
|
36472
|
-
"type": "object",
|
|
36473
|
-
"required": false,
|
|
36474
|
-
"description": "ResolutionOpts — { expand?: boolean } (return the full record; a no-op where the Summary is a structural alias).",
|
|
36475
|
-
"properties": [
|
|
36476
|
-
{
|
|
36477
|
-
"name": "expand",
|
|
36478
|
-
"type": "boolean",
|
|
36479
|
-
"optional": true
|
|
36480
|
-
}
|
|
36481
|
-
]
|
|
36482
|
-
}
|
|
36483
|
-
},
|
|
36484
|
-
"inputSchemaStrict": true,
|
|
36485
|
-
"outputSchema": {
|
|
36486
|
-
"type": "SkillSummary",
|
|
36487
|
-
"drops": []
|
|
36488
|
-
},
|
|
36489
|
-
"examples": [
|
|
36490
|
-
"await client.skills.resolve('example-value')"
|
|
36491
|
-
],
|
|
36492
|
-
"permissions": "unknown",
|
|
36493
|
-
"pagination": {
|
|
36494
|
-
"mode": "none"
|
|
36495
|
-
},
|
|
36496
|
-
"resolution": {
|
|
36497
|
-
"basis": "server-filter",
|
|
36498
|
-
"maxScanRecords": 500,
|
|
36499
|
-
"maxScanPages": 4
|
|
36500
|
-
},
|
|
36501
|
-
"retry": {
|
|
36502
|
-
"preset": "retry-ffb3a9cb"
|
|
36503
|
-
},
|
|
36504
|
-
"errors": {
|
|
36505
|
-
"set": 5
|
|
36506
|
-
},
|
|
36507
|
-
"metadata": {
|
|
36508
|
-
"purpose": "Resolve a skill from a numeric id (the direct fetch, tried first) or an exact value of its primary text field(s) (name — exact match only). Returns the Skill record with the numeric id for get/update/delete. Other identifier forms (e.g. an email address) are NOT tried by resolve — use the resource's dedicated lookup op where one exists (see autotask_catalog).",
|
|
36509
|
-
"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.",
|
|
36510
|
-
"preferredWhen": null,
|
|
36511
|
-
"related": [
|
|
36512
|
-
"skills.get"
|
|
36513
|
-
],
|
|
36514
|
-
"untrustedFields": [
|
|
36515
|
-
"description",
|
|
36516
|
-
"name"
|
|
36517
|
-
]
|
|
36518
|
-
},
|
|
36519
|
-
"compact": "SkillSummary",
|
|
36520
|
-
"status": "tested"
|
|
36521
|
-
},
|
|
36522
|
-
{
|
|
36523
|
-
"id": "skills.search",
|
|
36914
|
+
"id": "skills.count",
|
|
36524
36915
|
"resource": "skills",
|
|
36525
36916
|
"udfCapable": false,
|
|
36526
|
-
"operation": "search",
|
|
36527
|
-
"kind": "helper",
|
|
36528
|
-
"endpoint": null,
|
|
36529
|
-
"effect": "read",
|
|
36530
|
-
"flags": [],
|
|
36531
|
-
"dryRun": false,
|
|
36532
|
-
"envelope": null,
|
|
36533
|
-
"inputSchema": {
|
|
36534
|
-
"query": {
|
|
36535
|
-
"type": "string",
|
|
36536
|
-
"required": true,
|
|
36537
|
-
"description": "The free text to match (contains) on the resource searchable fields."
|
|
36538
|
-
},
|
|
36539
|
-
"opts": {
|
|
36540
|
-
"type": "object",
|
|
36541
|
-
"required": false,
|
|
36542
|
-
"description": "SearchOpts — { limit?: number } (1-500, default 25).",
|
|
36543
|
-
"properties": [
|
|
36544
|
-
{
|
|
36545
|
-
"name": "limit",
|
|
36546
|
-
"type": "number",
|
|
36547
|
-
"optional": true
|
|
36548
|
-
}
|
|
36549
|
-
]
|
|
36550
|
-
}
|
|
36551
|
-
},
|
|
36552
|
-
"inputSchemaStrict": true,
|
|
36553
|
-
"outputSchema": {
|
|
36554
|
-
"type": "SkillSummary",
|
|
36555
|
-
"drops": []
|
|
36556
|
-
},
|
|
36557
|
-
"examples": [
|
|
36558
|
-
"await client.skills.search('example')"
|
|
36559
|
-
],
|
|
36560
|
-
"permissions": "unknown",
|
|
36561
|
-
"pagination": {
|
|
36562
|
-
"mode": "none"
|
|
36563
|
-
},
|
|
36564
|
-
"resolution": {
|
|
36565
|
-
"basis": "server-filter",
|
|
36566
|
-
"maxScanRecords": 500,
|
|
36567
|
-
"maxScanPages": 4
|
|
36568
|
-
},
|
|
36569
|
-
"retry": {
|
|
36570
|
-
"preset": "retry-ffb3a9cb"
|
|
36571
|
-
},
|
|
36572
|
-
"errors": {
|
|
36573
|
-
"set": 5
|
|
36574
|
-
},
|
|
36575
|
-
"metadata": {
|
|
36576
|
-
"purpose": "Search skill records by text (contains on the searchable fields).",
|
|
36577
|
-
"usage": "Vendor exposes no free-text search; this is a bounded contains filter: name only (contains). limit defaults to 25, max 500.",
|
|
36578
|
-
"preferredWhen": null,
|
|
36579
|
-
"related": [
|
|
36580
|
-
"skills.resolve",
|
|
36581
|
-
"skills.query"
|
|
36582
|
-
],
|
|
36583
|
-
"untrustedFields": [
|
|
36584
|
-
"description",
|
|
36585
|
-
"name"
|
|
36586
|
-
]
|
|
36587
|
-
},
|
|
36588
|
-
"compact": "SkillSummary",
|
|
36589
|
-
"status": "tested"
|
|
36590
|
-
},
|
|
36591
|
-
{
|
|
36592
|
-
"id": "subscription_periods.count",
|
|
36593
|
-
"resource": "subscription_periods",
|
|
36594
|
-
"udfCapable": false,
|
|
36595
36917
|
"operation": "count",
|
|
36596
36918
|
"kind": "primitive",
|
|
36597
|
-
"endpoint": "GET|POST /V1.0/
|
|
36919
|
+
"endpoint": "GET|POST /V1.0/Skills/query/count",
|
|
36598
36920
|
"effect": "read",
|
|
36599
36921
|
"flags": [],
|
|
36600
36922
|
"dryRun": false,
|
|
@@ -36624,7 +36946,7 @@ const CAPABILITY_DATA = {
|
|
|
36624
36946
|
"drops": []
|
|
36625
36947
|
},
|
|
36626
36948
|
"examples": [
|
|
36627
|
-
"await client.
|
|
36949
|
+
"await client.skills.count({ filter: [{ field: 'name', op: 'eq', value: 'example' }] })"
|
|
36628
36950
|
],
|
|
36629
36951
|
"permissions": "unknown",
|
|
36630
36952
|
"pagination": {
|
|
@@ -36638,28 +36960,32 @@ const CAPABILITY_DATA = {
|
|
|
36638
36960
|
"set": 0
|
|
36639
36961
|
},
|
|
36640
36962
|
"metadata": {
|
|
36641
|
-
"purpose": "Count
|
|
36963
|
+
"purpose": "Count skill records matching a JSON filter.",
|
|
36642
36964
|
"usage": "Unwraps queryCount; returns a plain number.",
|
|
36643
36965
|
"preferredWhen": null,
|
|
36644
36966
|
"related": [
|
|
36645
|
-
"
|
|
36967
|
+
"skills.query"
|
|
36646
36968
|
],
|
|
36647
|
-
"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."
|
|
36969
|
+
"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.",
|
|
36970
|
+
"untrustedFields": [
|
|
36971
|
+
"description",
|
|
36972
|
+
"name"
|
|
36973
|
+
]
|
|
36648
36974
|
},
|
|
36649
36975
|
"compact": null,
|
|
36650
36976
|
"status": "tested"
|
|
36651
36977
|
},
|
|
36652
36978
|
{
|
|
36653
|
-
"id": "
|
|
36654
|
-
"resource": "
|
|
36979
|
+
"id": "skills.get",
|
|
36980
|
+
"resource": "skills",
|
|
36655
36981
|
"udfCapable": false,
|
|
36656
36982
|
"operation": "get",
|
|
36657
36983
|
"kind": "primitive",
|
|
36658
|
-
"endpoint": "GET /V1.0/
|
|
36984
|
+
"endpoint": "GET /V1.0/Skills/{id}",
|
|
36659
36985
|
"effect": "read",
|
|
36660
36986
|
"flags": [],
|
|
36661
36987
|
"dryRun": false,
|
|
36662
|
-
"envelope": "ItemQueryResultModel[
|
|
36988
|
+
"envelope": "ItemQueryResultModel[SkillModel,Skill]",
|
|
36663
36989
|
"inputSchema": {
|
|
36664
36990
|
"id": {
|
|
36665
36991
|
"type": "string | number",
|
|
@@ -36681,11 +37007,11 @@ const CAPABILITY_DATA = {
|
|
|
36681
37007
|
},
|
|
36682
37008
|
"inputSchemaStrict": true,
|
|
36683
37009
|
"outputSchema": {
|
|
36684
|
-
"type": "ItemQueryResultModel[
|
|
37010
|
+
"type": "ItemQueryResultModel[SkillModel,Skill]",
|
|
36685
37011
|
"drops": []
|
|
36686
37012
|
},
|
|
36687
37013
|
"examples": [
|
|
36688
|
-
"await client.
|
|
37014
|
+
"await client.skills.get('example-value')"
|
|
36689
37015
|
],
|
|
36690
37016
|
"permissions": "unknown",
|
|
36691
37017
|
"pagination": {
|
|
@@ -36699,24 +37025,28 @@ const CAPABILITY_DATA = {
|
|
|
36699
37025
|
"set": 3
|
|
36700
37026
|
},
|
|
36701
37027
|
"metadata": {
|
|
36702
|
-
"purpose": "Get one
|
|
37028
|
+
"purpose": "Get one Skill by id.",
|
|
36703
37029
|
"usage": "item: null on the 200 body maps to NotFoundError (vendor not-found signal).",
|
|
36704
|
-
"preferredWhen": "Preferred when the numeric id is already known;
|
|
37030
|
+
"preferredWhen": "Preferred when the numeric id is already known; skills.resolve is for a field value.",
|
|
36705
37031
|
"related": [
|
|
36706
|
-
"
|
|
37032
|
+
"skills.resolve"
|
|
36707
37033
|
],
|
|
36708
|
-
"args": "args[0] is the record 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
|
|
37034
|
+
"args": "args[0] is the record id (number) Item GET returns the FULL vendor model — the vendor documents no field selection on single-record reads. For a slim record use skills.search (compact summary) or a skills.query with includeFields.",
|
|
37035
|
+
"untrustedFields": [
|
|
37036
|
+
"description",
|
|
37037
|
+
"name"
|
|
37038
|
+
]
|
|
36709
37039
|
},
|
|
36710
37040
|
"compact": null,
|
|
36711
37041
|
"status": "tested"
|
|
36712
37042
|
},
|
|
36713
37043
|
{
|
|
36714
|
-
"id": "
|
|
36715
|
-
"resource": "
|
|
37044
|
+
"id": "skills.getEntityInfo",
|
|
37045
|
+
"resource": "skills",
|
|
36716
37046
|
"udfCapable": false,
|
|
36717
37047
|
"operation": "getEntityInfo",
|
|
36718
37048
|
"kind": "primitive",
|
|
36719
|
-
"endpoint": "GET /V1.0/
|
|
37049
|
+
"endpoint": "GET /V1.0/Skills/entityInformation",
|
|
36720
37050
|
"effect": "read",
|
|
36721
37051
|
"flags": [],
|
|
36722
37052
|
"dryRun": false,
|
|
@@ -36728,7 +37058,7 @@ const CAPABILITY_DATA = {
|
|
|
36728
37058
|
"drops": []
|
|
36729
37059
|
},
|
|
36730
37060
|
"examples": [
|
|
36731
|
-
"await client.
|
|
37061
|
+
"await client.skills.getEntityInfo()"
|
|
36732
37062
|
],
|
|
36733
37063
|
"permissions": "unknown",
|
|
36734
37064
|
"pagination": {
|
|
@@ -36742,23 +37072,27 @@ const CAPABILITY_DATA = {
|
|
|
36742
37072
|
"set": 0
|
|
36743
37073
|
},
|
|
36744
37074
|
"metadata": {
|
|
36745
|
-
"purpose": "Get the
|
|
37075
|
+
"purpose": "Get the Skill capability metadata (canCreate/canUpdate/hasUserDefinedFields/...).",
|
|
36746
37076
|
"usage": "Unwraps info{}; drives client-side capability checks.",
|
|
36747
37077
|
"preferredWhen": null,
|
|
36748
37078
|
"related": [
|
|
36749
|
-
"
|
|
37079
|
+
"skills.getFieldInfo"
|
|
37080
|
+
],
|
|
37081
|
+
"untrustedFields": [
|
|
37082
|
+
"description",
|
|
37083
|
+
"name"
|
|
36750
37084
|
]
|
|
36751
37085
|
},
|
|
36752
37086
|
"compact": null,
|
|
36753
37087
|
"status": "tested"
|
|
36754
37088
|
},
|
|
36755
37089
|
{
|
|
36756
|
-
"id": "
|
|
36757
|
-
"resource": "
|
|
37090
|
+
"id": "skills.getFieldInfo",
|
|
37091
|
+
"resource": "skills",
|
|
36758
37092
|
"udfCapable": false,
|
|
36759
37093
|
"operation": "getFieldInfo",
|
|
36760
37094
|
"kind": "primitive",
|
|
36761
|
-
"endpoint": "GET /V1.0/
|
|
37095
|
+
"endpoint": "GET /V1.0/Skills/entityInformation/fields",
|
|
36762
37096
|
"effect": "read",
|
|
36763
37097
|
"flags": [],
|
|
36764
37098
|
"dryRun": false,
|
|
@@ -36770,7 +37104,7 @@ const CAPABILITY_DATA = {
|
|
|
36770
37104
|
"drops": []
|
|
36771
37105
|
},
|
|
36772
37106
|
"examples": [
|
|
36773
|
-
"await client.
|
|
37107
|
+
"await client.skills.getFieldInfo()"
|
|
36774
37108
|
],
|
|
36775
37109
|
"permissions": "unknown",
|
|
36776
37110
|
"pagination": {
|
|
@@ -36784,24 +37118,28 @@ const CAPABILITY_DATA = {
|
|
|
36784
37118
|
"set": 0
|
|
36785
37119
|
},
|
|
36786
37120
|
"metadata": {
|
|
36787
|
-
"purpose": "Get the
|
|
37121
|
+
"purpose": "Get the Skill field catalog (types, picklists, required, maxLength) — the full raw field dump (the largest read of the info trio; compact discovery: operations.fieldCatalog).",
|
|
36788
37122
|
"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.",
|
|
36789
37123
|
"preferredWhen": null,
|
|
36790
37124
|
"related": [
|
|
36791
|
-
"
|
|
36792
|
-
"
|
|
37125
|
+
"skills.getEntityInfo",
|
|
37126
|
+
"skills.getUdfInfo"
|
|
37127
|
+
],
|
|
37128
|
+
"untrustedFields": [
|
|
37129
|
+
"description",
|
|
37130
|
+
"name"
|
|
36793
37131
|
]
|
|
36794
37132
|
},
|
|
36795
37133
|
"compact": null,
|
|
36796
37134
|
"status": "tested"
|
|
36797
37135
|
},
|
|
36798
37136
|
{
|
|
36799
|
-
"id": "
|
|
36800
|
-
"resource": "
|
|
37137
|
+
"id": "skills.getUdfInfo",
|
|
37138
|
+
"resource": "skills",
|
|
36801
37139
|
"udfCapable": false,
|
|
36802
37140
|
"operation": "getUdfInfo",
|
|
36803
37141
|
"kind": "primitive",
|
|
36804
|
-
"endpoint": "GET /V1.0/
|
|
37142
|
+
"endpoint": "GET /V1.0/Skills/entityInformation/userDefinedFields",
|
|
36805
37143
|
"effect": "read",
|
|
36806
37144
|
"flags": [],
|
|
36807
37145
|
"dryRun": false,
|
|
@@ -36813,7 +37151,7 @@ const CAPABILITY_DATA = {
|
|
|
36813
37151
|
"drops": []
|
|
36814
37152
|
},
|
|
36815
37153
|
"examples": [
|
|
36816
|
-
"await client.
|
|
37154
|
+
"await client.skills.getUdfInfo()"
|
|
36817
37155
|
],
|
|
36818
37156
|
"permissions": "unknown",
|
|
36819
37157
|
"pagination": {
|
|
@@ -36827,23 +37165,27 @@ const CAPABILITY_DATA = {
|
|
|
36827
37165
|
"set": 0
|
|
36828
37166
|
},
|
|
36829
37167
|
"metadata": {
|
|
36830
|
-
"purpose": "Get the
|
|
37168
|
+
"purpose": "Get the Skill user-defined-field catalog.",
|
|
36831
37169
|
"usage": "Unwraps fields[]; only meaningful where the entity is UDF-capable. (entity is not UDF-capable; catalog is expected empty).",
|
|
36832
37170
|
"preferredWhen": null,
|
|
36833
37171
|
"related": [
|
|
36834
|
-
"
|
|
37172
|
+
"skills.getFieldInfo"
|
|
37173
|
+
],
|
|
37174
|
+
"untrustedFields": [
|
|
37175
|
+
"description",
|
|
37176
|
+
"name"
|
|
36835
37177
|
]
|
|
36836
37178
|
},
|
|
36837
37179
|
"compact": null,
|
|
36838
37180
|
"status": "tested"
|
|
36839
37181
|
},
|
|
36840
37182
|
{
|
|
36841
|
-
"id": "
|
|
36842
|
-
"resource": "
|
|
37183
|
+
"id": "skills.query",
|
|
37184
|
+
"resource": "skills",
|
|
36843
37185
|
"udfCapable": false,
|
|
36844
37186
|
"operation": "query",
|
|
36845
37187
|
"kind": "primitive",
|
|
36846
|
-
"endpoint": "GET|POST /V1.0/
|
|
37188
|
+
"endpoint": "GET|POST /V1.0/Skills/query",
|
|
36847
37189
|
"effect": "read",
|
|
36848
37190
|
"flags": [],
|
|
36849
37191
|
"dryRun": false,
|
|
@@ -36915,7 +37257,7 @@ const CAPABILITY_DATA = {
|
|
|
36915
37257
|
"drops": []
|
|
36916
37258
|
},
|
|
36917
37259
|
"examples": [
|
|
36918
|
-
"await client.
|
|
37260
|
+
"await client.skills.query({ filter: [{ field: 'name', op: 'eq', value: 'example' }], limit: 500 })"
|
|
36919
37261
|
],
|
|
36920
37262
|
"permissions": "unknown",
|
|
36921
37263
|
"pagination": {
|
|
@@ -36936,20 +37278,24 @@ const CAPABILITY_DATA = {
|
|
|
36936
37278
|
"set": 4
|
|
36937
37279
|
},
|
|
36938
37280
|
"metadata": {
|
|
36939
|
-
"purpose": "Query
|
|
37281
|
+
"purpose": "Query Skill records with a JSON filter.",
|
|
36940
37282
|
"usage": "Server-side pagination: one call walks the vendor cursor internally and preserves the initial HTTP method until the limit is met or the cursor is null. By default, each POST carries the same QueryModel body (IncludeFields, MaxRecords and the original filter). The vendor honours IncludeFields on POST continuations and uses its own continuation page size. With `via: 'get'`, the SDK follows the GET cursor with the original search parameters. Cursors must stay on the configured origin; 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). 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.",
|
|
36941
37283
|
"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).",
|
|
36942
37284
|
"related": [
|
|
36943
|
-
"
|
|
37285
|
+
"skills.resolve"
|
|
36944
37286
|
],
|
|
36945
|
-
"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."
|
|
37287
|
+
"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. For a simple text lookup prefer skills.search. 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.",
|
|
37288
|
+
"untrustedFields": [
|
|
37289
|
+
"description",
|
|
37290
|
+
"name"
|
|
37291
|
+
]
|
|
36946
37292
|
},
|
|
36947
37293
|
"compact": null,
|
|
36948
37294
|
"status": "tested"
|
|
36949
37295
|
},
|
|
36950
37296
|
{
|
|
36951
|
-
"id": "
|
|
36952
|
-
"resource": "
|
|
37297
|
+
"id": "skills.resolve",
|
|
37298
|
+
"resource": "skills",
|
|
36953
37299
|
"udfCapable": false,
|
|
36954
37300
|
"operation": "resolve",
|
|
36955
37301
|
"kind": "helper",
|
|
@@ -36979,11 +37325,11 @@ const CAPABILITY_DATA = {
|
|
|
36979
37325
|
},
|
|
36980
37326
|
"inputSchemaStrict": true,
|
|
36981
37327
|
"outputSchema": {
|
|
36982
|
-
"type": "
|
|
37328
|
+
"type": "SkillSummary",
|
|
36983
37329
|
"drops": []
|
|
36984
37330
|
},
|
|
36985
37331
|
"examples": [
|
|
36986
|
-
"await client.
|
|
37332
|
+
"await client.skills.resolve('example-value')"
|
|
36987
37333
|
],
|
|
36988
37334
|
"permissions": "unknown",
|
|
36989
37335
|
"pagination": {
|
|
@@ -37001,23 +37347,96 @@ const CAPABILITY_DATA = {
|
|
|
37001
37347
|
"set": 5
|
|
37002
37348
|
},
|
|
37003
37349
|
"metadata": {
|
|
37004
|
-
"purpose": "Resolve a
|
|
37350
|
+
"purpose": "Resolve a skill from a numeric id (the direct fetch, tried first) or an exact value of its primary text field(s) (name — exact match only). Returns the Skill record with the numeric id for get/update/delete. Other identifier forms (e.g. an email address) are NOT tried by resolve — use the resource's dedicated lookup op where one exists (see autotask_catalog).",
|
|
37005
37351
|
"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.",
|
|
37006
37352
|
"preferredWhen": null,
|
|
37007
37353
|
"related": [
|
|
37008
|
-
"
|
|
37354
|
+
"skills.get"
|
|
37355
|
+
],
|
|
37356
|
+
"untrustedFields": [
|
|
37357
|
+
"description",
|
|
37358
|
+
"name"
|
|
37009
37359
|
]
|
|
37010
37360
|
},
|
|
37011
|
-
"compact": "
|
|
37361
|
+
"compact": "SkillSummary",
|
|
37012
37362
|
"status": "tested"
|
|
37013
37363
|
},
|
|
37014
37364
|
{
|
|
37015
|
-
"id": "
|
|
37016
|
-
"resource": "
|
|
37365
|
+
"id": "skills.search",
|
|
37366
|
+
"resource": "skills",
|
|
37367
|
+
"udfCapable": false,
|
|
37368
|
+
"operation": "search",
|
|
37369
|
+
"kind": "helper",
|
|
37370
|
+
"endpoint": null,
|
|
37371
|
+
"effect": "read",
|
|
37372
|
+
"flags": [],
|
|
37373
|
+
"dryRun": false,
|
|
37374
|
+
"envelope": null,
|
|
37375
|
+
"inputSchema": {
|
|
37376
|
+
"query": {
|
|
37377
|
+
"type": "string",
|
|
37378
|
+
"required": true,
|
|
37379
|
+
"description": "The free text to match (contains) on the resource searchable fields."
|
|
37380
|
+
},
|
|
37381
|
+
"opts": {
|
|
37382
|
+
"type": "object",
|
|
37383
|
+
"required": false,
|
|
37384
|
+
"description": "SearchOpts — { limit?: number } (1-500, default 25).",
|
|
37385
|
+
"properties": [
|
|
37386
|
+
{
|
|
37387
|
+
"name": "limit",
|
|
37388
|
+
"type": "number",
|
|
37389
|
+
"optional": true
|
|
37390
|
+
}
|
|
37391
|
+
]
|
|
37392
|
+
}
|
|
37393
|
+
},
|
|
37394
|
+
"inputSchemaStrict": true,
|
|
37395
|
+
"outputSchema": {
|
|
37396
|
+
"type": "SkillSummary",
|
|
37397
|
+
"drops": []
|
|
37398
|
+
},
|
|
37399
|
+
"examples": [
|
|
37400
|
+
"await client.skills.search('example')"
|
|
37401
|
+
],
|
|
37402
|
+
"permissions": "unknown",
|
|
37403
|
+
"pagination": {
|
|
37404
|
+
"mode": "none"
|
|
37405
|
+
},
|
|
37406
|
+
"resolution": {
|
|
37407
|
+
"basis": "server-filter",
|
|
37408
|
+
"maxScanRecords": 500,
|
|
37409
|
+
"maxScanPages": 4
|
|
37410
|
+
},
|
|
37411
|
+
"retry": {
|
|
37412
|
+
"preset": "retry-ffb3a9cb"
|
|
37413
|
+
},
|
|
37414
|
+
"errors": {
|
|
37415
|
+
"set": 5
|
|
37416
|
+
},
|
|
37417
|
+
"metadata": {
|
|
37418
|
+
"purpose": "Search skill records by text (contains on the searchable fields).",
|
|
37419
|
+
"usage": "Vendor exposes no free-text search; this is a bounded contains filter: name only (contains). limit defaults to 25, max 500.",
|
|
37420
|
+
"preferredWhen": null,
|
|
37421
|
+
"related": [
|
|
37422
|
+
"skills.resolve",
|
|
37423
|
+
"skills.query"
|
|
37424
|
+
],
|
|
37425
|
+
"untrustedFields": [
|
|
37426
|
+
"description",
|
|
37427
|
+
"name"
|
|
37428
|
+
]
|
|
37429
|
+
},
|
|
37430
|
+
"compact": "SkillSummary",
|
|
37431
|
+
"status": "tested"
|
|
37432
|
+
},
|
|
37433
|
+
{
|
|
37434
|
+
"id": "subscription_periods.count",
|
|
37435
|
+
"resource": "subscription_periods",
|
|
37017
37436
|
"udfCapable": false,
|
|
37018
37437
|
"operation": "count",
|
|
37019
37438
|
"kind": "primitive",
|
|
37020
|
-
"endpoint": "GET|POST /V1.0/
|
|
37439
|
+
"endpoint": "GET|POST /V1.0/SubscriptionPeriods/query/count",
|
|
37021
37440
|
"effect": "read",
|
|
37022
37441
|
"flags": [],
|
|
37023
37442
|
"dryRun": false,
|
|
@@ -37047,7 +37466,7 @@ const CAPABILITY_DATA = {
|
|
|
37047
37466
|
"drops": []
|
|
37048
37467
|
},
|
|
37049
37468
|
"examples": [
|
|
37050
|
-
"await client.
|
|
37469
|
+
"await client.subscriptionPeriods.count({ filter: [{ field: 'name', op: 'eq', value: 'example' }] })"
|
|
37051
37470
|
],
|
|
37052
37471
|
"permissions": "unknown",
|
|
37053
37472
|
"pagination": {
|
|
@@ -37061,11 +37480,11 @@ const CAPABILITY_DATA = {
|
|
|
37061
37480
|
"set": 0
|
|
37062
37481
|
},
|
|
37063
37482
|
"metadata": {
|
|
37064
|
-
"purpose": "Count
|
|
37483
|
+
"purpose": "Count subscription period records matching a JSON filter.",
|
|
37065
37484
|
"usage": "Unwraps queryCount; returns a plain number.",
|
|
37066
37485
|
"preferredWhen": null,
|
|
37067
37486
|
"related": [
|
|
37068
|
-
"
|
|
37487
|
+
"subscription_periods.query"
|
|
37069
37488
|
],
|
|
37070
37489
|
"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."
|
|
37071
37490
|
},
|
|
@@ -37073,16 +37492,16 @@ const CAPABILITY_DATA = {
|
|
|
37073
37492
|
"status": "tested"
|
|
37074
37493
|
},
|
|
37075
37494
|
{
|
|
37076
|
-
"id": "
|
|
37077
|
-
"resource": "
|
|
37495
|
+
"id": "subscription_periods.get",
|
|
37496
|
+
"resource": "subscription_periods",
|
|
37078
37497
|
"udfCapable": false,
|
|
37079
37498
|
"operation": "get",
|
|
37080
37499
|
"kind": "primitive",
|
|
37081
|
-
"endpoint": "GET /V1.0/
|
|
37500
|
+
"endpoint": "GET /V1.0/SubscriptionPeriods/{id}",
|
|
37082
37501
|
"effect": "read",
|
|
37083
37502
|
"flags": [],
|
|
37084
37503
|
"dryRun": false,
|
|
37085
|
-
"envelope": "ItemQueryResultModel[
|
|
37504
|
+
"envelope": "ItemQueryResultModel[SubscriptionPeriodModel,SubscriptionPeriod]",
|
|
37086
37505
|
"inputSchema": {
|
|
37087
37506
|
"id": {
|
|
37088
37507
|
"type": "string | number",
|
|
@@ -37104,11 +37523,11 @@ const CAPABILITY_DATA = {
|
|
|
37104
37523
|
},
|
|
37105
37524
|
"inputSchemaStrict": true,
|
|
37106
37525
|
"outputSchema": {
|
|
37107
|
-
"type": "ItemQueryResultModel[
|
|
37526
|
+
"type": "ItemQueryResultModel[SubscriptionPeriodModel,SubscriptionPeriod]",
|
|
37108
37527
|
"drops": []
|
|
37109
37528
|
},
|
|
37110
37529
|
"examples": [
|
|
37111
|
-
"await client.
|
|
37530
|
+
"await client.subscriptionPeriods.get('example-value')"
|
|
37112
37531
|
],
|
|
37113
37532
|
"permissions": "unknown",
|
|
37114
37533
|
"pagination": {
|
|
@@ -37122,24 +37541,24 @@ const CAPABILITY_DATA = {
|
|
|
37122
37541
|
"set": 3
|
|
37123
37542
|
},
|
|
37124
37543
|
"metadata": {
|
|
37125
|
-
"purpose": "Get one
|
|
37544
|
+
"purpose": "Get one SubscriptionPeriod by id.",
|
|
37126
37545
|
"usage": "item: null on the 200 body maps to NotFoundError (vendor not-found signal).",
|
|
37127
|
-
"preferredWhen": "Preferred when the numeric id is already known;
|
|
37546
|
+
"preferredWhen": "Preferred when the numeric id is already known; subscription_periods.resolve is for a field value.",
|
|
37128
37547
|
"related": [
|
|
37129
|
-
"
|
|
37548
|
+
"subscription_periods.resolve"
|
|
37130
37549
|
],
|
|
37131
|
-
"args": "args[0] is the record 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
|
|
37550
|
+
"args": "args[0] is the record 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 subscription_periods.query with includeFields."
|
|
37132
37551
|
},
|
|
37133
37552
|
"compact": null,
|
|
37134
37553
|
"status": "tested"
|
|
37135
37554
|
},
|
|
37136
37555
|
{
|
|
37137
|
-
"id": "
|
|
37138
|
-
"resource": "
|
|
37556
|
+
"id": "subscription_periods.getEntityInfo",
|
|
37557
|
+
"resource": "subscription_periods",
|
|
37139
37558
|
"udfCapable": false,
|
|
37140
37559
|
"operation": "getEntityInfo",
|
|
37141
37560
|
"kind": "primitive",
|
|
37142
|
-
"endpoint": "GET /V1.0/
|
|
37561
|
+
"endpoint": "GET /V1.0/SubscriptionPeriods/entityInformation",
|
|
37143
37562
|
"effect": "read",
|
|
37144
37563
|
"flags": [],
|
|
37145
37564
|
"dryRun": false,
|
|
@@ -37151,7 +37570,7 @@ const CAPABILITY_DATA = {
|
|
|
37151
37570
|
"drops": []
|
|
37152
37571
|
},
|
|
37153
37572
|
"examples": [
|
|
37154
|
-
"await client.
|
|
37573
|
+
"await client.subscriptionPeriods.getEntityInfo()"
|
|
37155
37574
|
],
|
|
37156
37575
|
"permissions": "unknown",
|
|
37157
37576
|
"pagination": {
|
|
@@ -37165,23 +37584,23 @@ const CAPABILITY_DATA = {
|
|
|
37165
37584
|
"set": 0
|
|
37166
37585
|
},
|
|
37167
37586
|
"metadata": {
|
|
37168
|
-
"purpose": "Get the
|
|
37587
|
+
"purpose": "Get the SubscriptionPeriod capability metadata (canCreate/canUpdate/hasUserDefinedFields/...).",
|
|
37169
37588
|
"usage": "Unwraps info{}; drives client-side capability checks.",
|
|
37170
37589
|
"preferredWhen": null,
|
|
37171
37590
|
"related": [
|
|
37172
|
-
"
|
|
37591
|
+
"subscription_periods.getFieldInfo"
|
|
37173
37592
|
]
|
|
37174
37593
|
},
|
|
37175
37594
|
"compact": null,
|
|
37176
37595
|
"status": "tested"
|
|
37177
37596
|
},
|
|
37178
37597
|
{
|
|
37179
|
-
"id": "
|
|
37180
|
-
"resource": "
|
|
37598
|
+
"id": "subscription_periods.getFieldInfo",
|
|
37599
|
+
"resource": "subscription_periods",
|
|
37181
37600
|
"udfCapable": false,
|
|
37182
37601
|
"operation": "getFieldInfo",
|
|
37183
37602
|
"kind": "primitive",
|
|
37184
|
-
"endpoint": "GET /V1.0/
|
|
37603
|
+
"endpoint": "GET /V1.0/SubscriptionPeriods/entityInformation/fields",
|
|
37185
37604
|
"effect": "read",
|
|
37186
37605
|
"flags": [],
|
|
37187
37606
|
"dryRun": false,
|
|
@@ -37193,7 +37612,7 @@ const CAPABILITY_DATA = {
|
|
|
37193
37612
|
"drops": []
|
|
37194
37613
|
},
|
|
37195
37614
|
"examples": [
|
|
37196
|
-
"await client.
|
|
37615
|
+
"await client.subscriptionPeriods.getFieldInfo()"
|
|
37197
37616
|
],
|
|
37198
37617
|
"permissions": "unknown",
|
|
37199
37618
|
"pagination": {
|
|
@@ -37207,24 +37626,24 @@ const CAPABILITY_DATA = {
|
|
|
37207
37626
|
"set": 0
|
|
37208
37627
|
},
|
|
37209
37628
|
"metadata": {
|
|
37210
|
-
"purpose": "Get the
|
|
37629
|
+
"purpose": "Get the SubscriptionPeriod field catalog (types, picklists, required, maxLength) — the full raw field dump (the largest read of the info trio; compact discovery: operations.fieldCatalog).",
|
|
37211
37630
|
"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.",
|
|
37212
37631
|
"preferredWhen": null,
|
|
37213
37632
|
"related": [
|
|
37214
|
-
"
|
|
37215
|
-
"
|
|
37633
|
+
"subscription_periods.getEntityInfo",
|
|
37634
|
+
"subscription_periods.getUdfInfo"
|
|
37216
37635
|
]
|
|
37217
37636
|
},
|
|
37218
37637
|
"compact": null,
|
|
37219
37638
|
"status": "tested"
|
|
37220
37639
|
},
|
|
37221
37640
|
{
|
|
37222
|
-
"id": "
|
|
37223
|
-
"resource": "
|
|
37641
|
+
"id": "subscription_periods.getUdfInfo",
|
|
37642
|
+
"resource": "subscription_periods",
|
|
37224
37643
|
"udfCapable": false,
|
|
37225
37644
|
"operation": "getUdfInfo",
|
|
37226
37645
|
"kind": "primitive",
|
|
37227
|
-
"endpoint": "GET /V1.0/
|
|
37646
|
+
"endpoint": "GET /V1.0/SubscriptionPeriods/entityInformation/userDefinedFields",
|
|
37228
37647
|
"effect": "read",
|
|
37229
37648
|
"flags": [],
|
|
37230
37649
|
"dryRun": false,
|
|
@@ -37236,7 +37655,7 @@ const CAPABILITY_DATA = {
|
|
|
37236
37655
|
"drops": []
|
|
37237
37656
|
},
|
|
37238
37657
|
"examples": [
|
|
37239
|
-
"await client.
|
|
37658
|
+
"await client.subscriptionPeriods.getUdfInfo()"
|
|
37240
37659
|
],
|
|
37241
37660
|
"permissions": "unknown",
|
|
37242
37661
|
"pagination": {
|
|
@@ -37250,23 +37669,23 @@ const CAPABILITY_DATA = {
|
|
|
37250
37669
|
"set": 0
|
|
37251
37670
|
},
|
|
37252
37671
|
"metadata": {
|
|
37253
|
-
"purpose": "Get the
|
|
37672
|
+
"purpose": "Get the SubscriptionPeriod user-defined-field catalog.",
|
|
37254
37673
|
"usage": "Unwraps fields[]; only meaningful where the entity is UDF-capable. (entity is not UDF-capable; catalog is expected empty).",
|
|
37255
37674
|
"preferredWhen": null,
|
|
37256
37675
|
"related": [
|
|
37257
|
-
"
|
|
37676
|
+
"subscription_periods.getFieldInfo"
|
|
37258
37677
|
]
|
|
37259
37678
|
},
|
|
37260
37679
|
"compact": null,
|
|
37261
37680
|
"status": "tested"
|
|
37262
37681
|
},
|
|
37263
37682
|
{
|
|
37264
|
-
"id": "
|
|
37265
|
-
"resource": "
|
|
37683
|
+
"id": "subscription_periods.query",
|
|
37684
|
+
"resource": "subscription_periods",
|
|
37266
37685
|
"udfCapable": false,
|
|
37267
37686
|
"operation": "query",
|
|
37268
37687
|
"kind": "primitive",
|
|
37269
|
-
"endpoint": "GET|POST /V1.0/
|
|
37688
|
+
"endpoint": "GET|POST /V1.0/SubscriptionPeriods/query",
|
|
37270
37689
|
"effect": "read",
|
|
37271
37690
|
"flags": [],
|
|
37272
37691
|
"dryRun": false,
|
|
@@ -37338,7 +37757,7 @@ const CAPABILITY_DATA = {
|
|
|
37338
37757
|
"drops": []
|
|
37339
37758
|
},
|
|
37340
37759
|
"examples": [
|
|
37341
|
-
"await client.
|
|
37760
|
+
"await client.subscriptionPeriods.query({ filter: [{ field: 'name', op: 'eq', value: 'example' }], limit: 500 })"
|
|
37342
37761
|
],
|
|
37343
37762
|
"permissions": "unknown",
|
|
37344
37763
|
"pagination": {
|
|
@@ -37359,11 +37778,11 @@ const CAPABILITY_DATA = {
|
|
|
37359
37778
|
"set": 4
|
|
37360
37779
|
},
|
|
37361
37780
|
"metadata": {
|
|
37362
|
-
"purpose": "Query
|
|
37781
|
+
"purpose": "Query SubscriptionPeriod records with a JSON filter.",
|
|
37363
37782
|
"usage": "Server-side pagination: one call walks the vendor cursor internally and preserves the initial HTTP method until the limit is met or the cursor is null. By default, each POST carries the same QueryModel body (IncludeFields, MaxRecords and the original filter). The vendor honours IncludeFields on POST continuations and uses its own continuation page size. With `via: 'get'`, the SDK follows the GET cursor with the original search parameters. Cursors must stay on the configured origin; 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). 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.",
|
|
37364
37783
|
"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).",
|
|
37365
37784
|
"related": [
|
|
37366
|
-
"
|
|
37785
|
+
"subscription_periods.resolve"
|
|
37367
37786
|
],
|
|
37368
37787
|
"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."
|
|
37369
37788
|
},
|
|
@@ -37371,8 +37790,8 @@ const CAPABILITY_DATA = {
|
|
|
37371
37790
|
"status": "tested"
|
|
37372
37791
|
},
|
|
37373
37792
|
{
|
|
37374
|
-
"id": "
|
|
37375
|
-
"resource": "
|
|
37793
|
+
"id": "subscription_periods.resolve",
|
|
37794
|
+
"resource": "subscription_periods",
|
|
37376
37795
|
"udfCapable": false,
|
|
37377
37796
|
"operation": "resolve",
|
|
37378
37797
|
"kind": "helper",
|
|
@@ -37402,11 +37821,11 @@ const CAPABILITY_DATA = {
|
|
|
37402
37821
|
},
|
|
37403
37822
|
"inputSchemaStrict": true,
|
|
37404
37823
|
"outputSchema": {
|
|
37405
|
-
"type": "
|
|
37824
|
+
"type": "SubscriptionPeriodSummary",
|
|
37406
37825
|
"drops": []
|
|
37407
37826
|
},
|
|
37408
37827
|
"examples": [
|
|
37409
|
-
"await client.
|
|
37828
|
+
"await client.subscriptionPeriods.resolve('example-value')"
|
|
37410
37829
|
],
|
|
37411
37830
|
"permissions": "unknown",
|
|
37412
37831
|
"pagination": {
|
|
@@ -37424,23 +37843,23 @@ const CAPABILITY_DATA = {
|
|
|
37424
37843
|
"set": 5
|
|
37425
37844
|
},
|
|
37426
37845
|
"metadata": {
|
|
37427
|
-
"purpose": "Resolve a
|
|
37846
|
+
"purpose": "Resolve a subscription period from a numeric id (the direct fetch) only — this resource has no searchable text field, so a non-numeric identifier throws a config error.",
|
|
37428
37847
|
"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.",
|
|
37429
37848
|
"preferredWhen": null,
|
|
37430
37849
|
"related": [
|
|
37431
|
-
"
|
|
37850
|
+
"subscription_periods.get"
|
|
37432
37851
|
]
|
|
37433
37852
|
},
|
|
37434
|
-
"compact": "
|
|
37853
|
+
"compact": "SubscriptionPeriodSummary",
|
|
37435
37854
|
"status": "tested"
|
|
37436
37855
|
},
|
|
37437
37856
|
{
|
|
37438
|
-
"id": "
|
|
37439
|
-
"resource": "
|
|
37857
|
+
"id": "survey_results.count",
|
|
37858
|
+
"resource": "survey_results",
|
|
37440
37859
|
"udfCapable": false,
|
|
37441
37860
|
"operation": "count",
|
|
37442
37861
|
"kind": "primitive",
|
|
37443
|
-
"endpoint": "GET|POST /V1.0/
|
|
37862
|
+
"endpoint": "GET|POST /V1.0/SurveyResults/query/count",
|
|
37444
37863
|
"effect": "read",
|
|
37445
37864
|
"flags": [],
|
|
37446
37865
|
"dryRun": false,
|
|
@@ -37470,7 +37889,7 @@ const CAPABILITY_DATA = {
|
|
|
37470
37889
|
"drops": []
|
|
37471
37890
|
},
|
|
37472
37891
|
"examples": [
|
|
37473
|
-
"await client.
|
|
37892
|
+
"await client.surveyResults.count({ filter: [{ field: 'name', op: 'eq', value: 'example' }] })"
|
|
37474
37893
|
],
|
|
37475
37894
|
"permissions": "unknown",
|
|
37476
37895
|
"pagination": {
|
|
@@ -37484,33 +37903,28 @@ const CAPABILITY_DATA = {
|
|
|
37484
37903
|
"set": 0
|
|
37485
37904
|
},
|
|
37486
37905
|
"metadata": {
|
|
37487
|
-
"purpose": "Count survey records matching a JSON filter.",
|
|
37906
|
+
"purpose": "Count survey result records matching a JSON filter.",
|
|
37488
37907
|
"usage": "Unwraps queryCount; returns a plain number.",
|
|
37489
37908
|
"preferredWhen": null,
|
|
37490
37909
|
"related": [
|
|
37491
|
-
"
|
|
37910
|
+
"survey_results.query"
|
|
37492
37911
|
],
|
|
37493
|
-
"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."
|
|
37494
|
-
"untrustedFields": [
|
|
37495
|
-
"description",
|
|
37496
|
-
"displayName",
|
|
37497
|
-
"name"
|
|
37498
|
-
]
|
|
37912
|
+
"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."
|
|
37499
37913
|
},
|
|
37500
37914
|
"compact": null,
|
|
37501
37915
|
"status": "tested"
|
|
37502
37916
|
},
|
|
37503
37917
|
{
|
|
37504
|
-
"id": "
|
|
37505
|
-
"resource": "
|
|
37918
|
+
"id": "survey_results.get",
|
|
37919
|
+
"resource": "survey_results",
|
|
37506
37920
|
"udfCapable": false,
|
|
37507
37921
|
"operation": "get",
|
|
37508
37922
|
"kind": "primitive",
|
|
37509
|
-
"endpoint": "GET /V1.0/
|
|
37923
|
+
"endpoint": "GET /V1.0/SurveyResults/{id}",
|
|
37510
37924
|
"effect": "read",
|
|
37511
37925
|
"flags": [],
|
|
37512
37926
|
"dryRun": false,
|
|
37513
|
-
"envelope": "ItemQueryResultModel[
|
|
37927
|
+
"envelope": "ItemQueryResultModel[SurveyResultsModel,SurveyResults]",
|
|
37514
37928
|
"inputSchema": {
|
|
37515
37929
|
"id": {
|
|
37516
37930
|
"type": "string | number",
|
|
@@ -37532,11 +37946,11 @@ const CAPABILITY_DATA = {
|
|
|
37532
37946
|
},
|
|
37533
37947
|
"inputSchemaStrict": true,
|
|
37534
37948
|
"outputSchema": {
|
|
37535
|
-
"type": "ItemQueryResultModel[
|
|
37949
|
+
"type": "ItemQueryResultModel[SurveyResultsModel,SurveyResults]",
|
|
37536
37950
|
"drops": []
|
|
37537
37951
|
},
|
|
37538
37952
|
"examples": [
|
|
37539
|
-
"await client.
|
|
37953
|
+
"await client.surveyResults.get('example-value')"
|
|
37540
37954
|
],
|
|
37541
37955
|
"permissions": "unknown",
|
|
37542
37956
|
"pagination": {
|
|
@@ -37550,29 +37964,24 @@ const CAPABILITY_DATA = {
|
|
|
37550
37964
|
"set": 3
|
|
37551
37965
|
},
|
|
37552
37966
|
"metadata": {
|
|
37553
|
-
"purpose": "Get one
|
|
37967
|
+
"purpose": "Get one SurveyResults by id.",
|
|
37554
37968
|
"usage": "item: null on the 200 body maps to NotFoundError (vendor not-found signal).",
|
|
37555
|
-
"preferredWhen": "Preferred when the numeric id is already known;
|
|
37969
|
+
"preferredWhen": "Preferred when the numeric id is already known; survey_results.resolve is for a field value.",
|
|
37556
37970
|
"related": [
|
|
37557
|
-
"
|
|
37971
|
+
"survey_results.resolve"
|
|
37558
37972
|
],
|
|
37559
|
-
"args": "args[0] is the record id (number) Item GET returns the FULL vendor model — the vendor documents no field selection on single-record reads. For a slim record use
|
|
37560
|
-
"untrustedFields": [
|
|
37561
|
-
"description",
|
|
37562
|
-
"displayName",
|
|
37563
|
-
"name"
|
|
37564
|
-
]
|
|
37973
|
+
"args": "args[0] is the record 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 survey_results.query with includeFields."
|
|
37565
37974
|
},
|
|
37566
37975
|
"compact": null,
|
|
37567
37976
|
"status": "tested"
|
|
37568
37977
|
},
|
|
37569
37978
|
{
|
|
37570
|
-
"id": "
|
|
37571
|
-
"resource": "
|
|
37979
|
+
"id": "survey_results.getEntityInfo",
|
|
37980
|
+
"resource": "survey_results",
|
|
37572
37981
|
"udfCapable": false,
|
|
37573
37982
|
"operation": "getEntityInfo",
|
|
37574
37983
|
"kind": "primitive",
|
|
37575
|
-
"endpoint": "GET /V1.0/
|
|
37984
|
+
"endpoint": "GET /V1.0/SurveyResults/entityInformation",
|
|
37576
37985
|
"effect": "read",
|
|
37577
37986
|
"flags": [],
|
|
37578
37987
|
"dryRun": false,
|
|
@@ -37584,7 +37993,7 @@ const CAPABILITY_DATA = {
|
|
|
37584
37993
|
"drops": []
|
|
37585
37994
|
},
|
|
37586
37995
|
"examples": [
|
|
37587
|
-
"await client.
|
|
37996
|
+
"await client.surveyResults.getEntityInfo()"
|
|
37588
37997
|
],
|
|
37589
37998
|
"permissions": "unknown",
|
|
37590
37999
|
"pagination": {
|
|
@@ -37598,28 +38007,23 @@ const CAPABILITY_DATA = {
|
|
|
37598
38007
|
"set": 0
|
|
37599
38008
|
},
|
|
37600
38009
|
"metadata": {
|
|
37601
|
-
"purpose": "Get the
|
|
38010
|
+
"purpose": "Get the SurveyResults capability metadata (canCreate/canUpdate/hasUserDefinedFields/...).",
|
|
37602
38011
|
"usage": "Unwraps info{}; drives client-side capability checks.",
|
|
37603
38012
|
"preferredWhen": null,
|
|
37604
38013
|
"related": [
|
|
37605
|
-
"
|
|
37606
|
-
],
|
|
37607
|
-
"untrustedFields": [
|
|
37608
|
-
"description",
|
|
37609
|
-
"displayName",
|
|
37610
|
-
"name"
|
|
38014
|
+
"survey_results.getFieldInfo"
|
|
37611
38015
|
]
|
|
37612
38016
|
},
|
|
37613
38017
|
"compact": null,
|
|
37614
38018
|
"status": "tested"
|
|
37615
38019
|
},
|
|
37616
38020
|
{
|
|
37617
|
-
"id": "
|
|
37618
|
-
"resource": "
|
|
38021
|
+
"id": "survey_results.getFieldInfo",
|
|
38022
|
+
"resource": "survey_results",
|
|
37619
38023
|
"udfCapable": false,
|
|
37620
38024
|
"operation": "getFieldInfo",
|
|
37621
38025
|
"kind": "primitive",
|
|
37622
|
-
"endpoint": "GET /V1.0/
|
|
38026
|
+
"endpoint": "GET /V1.0/SurveyResults/entityInformation/fields",
|
|
37623
38027
|
"effect": "read",
|
|
37624
38028
|
"flags": [],
|
|
37625
38029
|
"dryRun": false,
|
|
@@ -37631,7 +38035,7 @@ const CAPABILITY_DATA = {
|
|
|
37631
38035
|
"drops": []
|
|
37632
38036
|
},
|
|
37633
38037
|
"examples": [
|
|
37634
|
-
"await client.
|
|
38038
|
+
"await client.surveyResults.getFieldInfo()"
|
|
37635
38039
|
],
|
|
37636
38040
|
"permissions": "unknown",
|
|
37637
38041
|
"pagination": {
|
|
@@ -37645,29 +38049,24 @@ const CAPABILITY_DATA = {
|
|
|
37645
38049
|
"set": 0
|
|
37646
38050
|
},
|
|
37647
38051
|
"metadata": {
|
|
37648
|
-
"purpose": "Get the
|
|
38052
|
+
"purpose": "Get the SurveyResults field catalog (types, picklists, required, maxLength) — the full raw field dump (the largest read of the info trio; compact discovery: operations.fieldCatalog).",
|
|
37649
38053
|
"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.",
|
|
37650
38054
|
"preferredWhen": null,
|
|
37651
38055
|
"related": [
|
|
37652
|
-
"
|
|
37653
|
-
"
|
|
37654
|
-
],
|
|
37655
|
-
"untrustedFields": [
|
|
37656
|
-
"description",
|
|
37657
|
-
"displayName",
|
|
37658
|
-
"name"
|
|
38056
|
+
"survey_results.getEntityInfo",
|
|
38057
|
+
"survey_results.getUdfInfo"
|
|
37659
38058
|
]
|
|
37660
38059
|
},
|
|
37661
38060
|
"compact": null,
|
|
37662
38061
|
"status": "tested"
|
|
37663
38062
|
},
|
|
37664
38063
|
{
|
|
37665
|
-
"id": "
|
|
37666
|
-
"resource": "
|
|
38064
|
+
"id": "survey_results.getUdfInfo",
|
|
38065
|
+
"resource": "survey_results",
|
|
37667
38066
|
"udfCapable": false,
|
|
37668
38067
|
"operation": "getUdfInfo",
|
|
37669
38068
|
"kind": "primitive",
|
|
37670
|
-
"endpoint": "GET /V1.0/
|
|
38069
|
+
"endpoint": "GET /V1.0/SurveyResults/entityInformation/userDefinedFields",
|
|
37671
38070
|
"effect": "read",
|
|
37672
38071
|
"flags": [],
|
|
37673
38072
|
"dryRun": false,
|
|
@@ -37679,7 +38078,7 @@ const CAPABILITY_DATA = {
|
|
|
37679
38078
|
"drops": []
|
|
37680
38079
|
},
|
|
37681
38080
|
"examples": [
|
|
37682
|
-
"await client.
|
|
38081
|
+
"await client.surveyResults.getUdfInfo()"
|
|
37683
38082
|
],
|
|
37684
38083
|
"permissions": "unknown",
|
|
37685
38084
|
"pagination": {
|
|
@@ -37693,28 +38092,471 @@ const CAPABILITY_DATA = {
|
|
|
37693
38092
|
"set": 0
|
|
37694
38093
|
},
|
|
37695
38094
|
"metadata": {
|
|
37696
|
-
"purpose": "Get the
|
|
38095
|
+
"purpose": "Get the SurveyResults user-defined-field catalog.",
|
|
37697
38096
|
"usage": "Unwraps fields[]; only meaningful where the entity is UDF-capable. (entity is not UDF-capable; catalog is expected empty).",
|
|
37698
38097
|
"preferredWhen": null,
|
|
37699
38098
|
"related": [
|
|
37700
|
-
"
|
|
37701
|
-
],
|
|
37702
|
-
"untrustedFields": [
|
|
37703
|
-
"description",
|
|
37704
|
-
"displayName",
|
|
37705
|
-
"name"
|
|
38099
|
+
"survey_results.getFieldInfo"
|
|
37706
38100
|
]
|
|
37707
38101
|
},
|
|
37708
38102
|
"compact": null,
|
|
37709
38103
|
"status": "tested"
|
|
37710
38104
|
},
|
|
37711
38105
|
{
|
|
37712
|
-
"id": "
|
|
37713
|
-
"resource": "
|
|
38106
|
+
"id": "survey_results.query",
|
|
38107
|
+
"resource": "survey_results",
|
|
37714
38108
|
"udfCapable": false,
|
|
37715
38109
|
"operation": "query",
|
|
37716
38110
|
"kind": "primitive",
|
|
37717
|
-
"endpoint": "GET|POST /V1.0/
|
|
38111
|
+
"endpoint": "GET|POST /V1.0/SurveyResults/query",
|
|
38112
|
+
"effect": "read",
|
|
38113
|
+
"flags": [],
|
|
38114
|
+
"dryRun": false,
|
|
38115
|
+
"envelope": "QueryActionResult[<Model>,<Entity>]",
|
|
38116
|
+
"inputSchema": {
|
|
38117
|
+
"params": {
|
|
38118
|
+
"type": "object",
|
|
38119
|
+
"required": false,
|
|
38120
|
+
"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 + a capped number of cold name reads per call (several ids of one table share one batched read); 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/productID/vendorID (a company)/configurationItemCategoryID/*ResourceID (contractIDName, productIDName, assignedResourceIDName) — null, never missing, when the field is keyed with a null value, a 0 id (except companyID/vendorID 0, which name the tenant owner's own company) 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 uncached name-read cap, an id a batched name read did not return, 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.",
|
|
38121
|
+
"properties": [
|
|
38122
|
+
{
|
|
38123
|
+
"name": "filter",
|
|
38124
|
+
"type": "FilterCondition[]",
|
|
38125
|
+
"optional": true
|
|
38126
|
+
},
|
|
38127
|
+
{
|
|
38128
|
+
"name": "limit",
|
|
38129
|
+
"type": "number",
|
|
38130
|
+
"optional": true,
|
|
38131
|
+
"default": 500
|
|
38132
|
+
},
|
|
38133
|
+
{
|
|
38134
|
+
"name": "latest",
|
|
38135
|
+
"type": "number",
|
|
38136
|
+
"optional": true
|
|
38137
|
+
},
|
|
38138
|
+
{
|
|
38139
|
+
"name": "noteChars",
|
|
38140
|
+
"type": "number",
|
|
38141
|
+
"optional": true
|
|
38142
|
+
},
|
|
38143
|
+
{
|
|
38144
|
+
"name": "includeFields",
|
|
38145
|
+
"type": "string[]",
|
|
38146
|
+
"optional": true
|
|
38147
|
+
},
|
|
38148
|
+
{
|
|
38149
|
+
"name": "fieldCheck",
|
|
38150
|
+
"type": "boolean",
|
|
38151
|
+
"optional": true,
|
|
38152
|
+
"default": true
|
|
38153
|
+
},
|
|
38154
|
+
{
|
|
38155
|
+
"name": "names",
|
|
38156
|
+
"type": "boolean",
|
|
38157
|
+
"optional": true
|
|
38158
|
+
},
|
|
38159
|
+
{
|
|
38160
|
+
"name": "via",
|
|
38161
|
+
"type": "\"post\" | \"get\"",
|
|
38162
|
+
"optional": true
|
|
38163
|
+
},
|
|
38164
|
+
{
|
|
38165
|
+
"name": "acknowledgeUnscoped",
|
|
38166
|
+
"type": "boolean",
|
|
38167
|
+
"optional": true
|
|
38168
|
+
},
|
|
38169
|
+
{
|
|
38170
|
+
"name": "walk",
|
|
38171
|
+
"type": "object",
|
|
38172
|
+
"optional": true
|
|
38173
|
+
}
|
|
38174
|
+
]
|
|
38175
|
+
}
|
|
38176
|
+
},
|
|
38177
|
+
"inputSchemaStrict": true,
|
|
38178
|
+
"outputSchema": {
|
|
38179
|
+
"type": "QueryActionResult[<Model>,<Entity>]",
|
|
38180
|
+
"drops": []
|
|
38181
|
+
},
|
|
38182
|
+
"examples": [
|
|
38183
|
+
"await client.surveyResults.query({ filter: [{ field: 'name', op: 'eq', value: 'example' }], limit: 500 })"
|
|
38184
|
+
],
|
|
38185
|
+
"permissions": "unknown",
|
|
38186
|
+
"pagination": {
|
|
38187
|
+
"mode": "cursor",
|
|
38188
|
+
"vendorDefault": 10,
|
|
38189
|
+
"vendorMax": 500,
|
|
38190
|
+
"pageGuard": 1000,
|
|
38191
|
+
"queryBounded": {
|
|
38192
|
+
"default": 500,
|
|
38193
|
+
"max": 2500
|
|
38194
|
+
}
|
|
38195
|
+
},
|
|
38196
|
+
"resolution": null,
|
|
38197
|
+
"retry": {
|
|
38198
|
+
"preset": "retry-ffb3a9cb"
|
|
38199
|
+
},
|
|
38200
|
+
"errors": {
|
|
38201
|
+
"set": 4
|
|
38202
|
+
},
|
|
38203
|
+
"metadata": {
|
|
38204
|
+
"purpose": "Query SurveyResults records with a JSON filter.",
|
|
38205
|
+
"usage": "Server-side pagination: one call walks the vendor cursor internally and preserves the initial HTTP method until the limit is met or the cursor is null. By default, each POST carries the same QueryModel body (IncludeFields, MaxRecords and the original filter). The vendor honours IncludeFields on POST continuations and uses its own continuation page size. With `via: 'get'`, the SDK follows the GET cursor with the original search parameters. Cursors must stay on the configured origin; 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). 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.",
|
|
38206
|
+
"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).",
|
|
38207
|
+
"related": [
|
|
38208
|
+
"survey_results.resolve"
|
|
38209
|
+
],
|
|
38210
|
+
"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."
|
|
38211
|
+
},
|
|
38212
|
+
"compact": null,
|
|
38213
|
+
"status": "tested"
|
|
38214
|
+
},
|
|
38215
|
+
{
|
|
38216
|
+
"id": "survey_results.resolve",
|
|
38217
|
+
"resource": "survey_results",
|
|
38218
|
+
"udfCapable": false,
|
|
38219
|
+
"operation": "resolve",
|
|
38220
|
+
"kind": "helper",
|
|
38221
|
+
"endpoint": null,
|
|
38222
|
+
"effect": "read",
|
|
38223
|
+
"flags": [],
|
|
38224
|
+
"dryRun": false,
|
|
38225
|
+
"envelope": null,
|
|
38226
|
+
"inputSchema": {
|
|
38227
|
+
"identifier": {
|
|
38228
|
+
"type": "string | number",
|
|
38229
|
+
"required": true,
|
|
38230
|
+
"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)."
|
|
38231
|
+
},
|
|
38232
|
+
"opts": {
|
|
38233
|
+
"type": "object",
|
|
38234
|
+
"required": false,
|
|
38235
|
+
"description": "ResolutionOpts — { expand?: boolean } (return the full record; a no-op where the Summary is a structural alias).",
|
|
38236
|
+
"properties": [
|
|
38237
|
+
{
|
|
38238
|
+
"name": "expand",
|
|
38239
|
+
"type": "boolean",
|
|
38240
|
+
"optional": true
|
|
38241
|
+
}
|
|
38242
|
+
]
|
|
38243
|
+
}
|
|
38244
|
+
},
|
|
38245
|
+
"inputSchemaStrict": true,
|
|
38246
|
+
"outputSchema": {
|
|
38247
|
+
"type": "SurveyResultsSummary",
|
|
38248
|
+
"drops": []
|
|
38249
|
+
},
|
|
38250
|
+
"examples": [
|
|
38251
|
+
"await client.surveyResults.resolve('example-value')"
|
|
38252
|
+
],
|
|
38253
|
+
"permissions": "unknown",
|
|
38254
|
+
"pagination": {
|
|
38255
|
+
"mode": "none"
|
|
38256
|
+
},
|
|
38257
|
+
"resolution": {
|
|
38258
|
+
"basis": "server-filter",
|
|
38259
|
+
"maxScanRecords": 500,
|
|
38260
|
+
"maxScanPages": 4
|
|
38261
|
+
},
|
|
38262
|
+
"retry": {
|
|
38263
|
+
"preset": "retry-ffb3a9cb"
|
|
38264
|
+
},
|
|
38265
|
+
"errors": {
|
|
38266
|
+
"set": 5
|
|
38267
|
+
},
|
|
38268
|
+
"metadata": {
|
|
38269
|
+
"purpose": "Resolve a survey result from a numeric id (the direct fetch) only — this resource has no searchable text field, so a non-numeric identifier throws a config error.",
|
|
38270
|
+
"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.",
|
|
38271
|
+
"preferredWhen": null,
|
|
38272
|
+
"related": [
|
|
38273
|
+
"survey_results.get"
|
|
38274
|
+
]
|
|
38275
|
+
},
|
|
38276
|
+
"compact": "SurveyResultsSummary",
|
|
38277
|
+
"status": "tested"
|
|
38278
|
+
},
|
|
38279
|
+
{
|
|
38280
|
+
"id": "surveys.count",
|
|
38281
|
+
"resource": "surveys",
|
|
38282
|
+
"udfCapable": false,
|
|
38283
|
+
"operation": "count",
|
|
38284
|
+
"kind": "primitive",
|
|
38285
|
+
"endpoint": "GET|POST /V1.0/Surveys/query/count",
|
|
38286
|
+
"effect": "read",
|
|
38287
|
+
"flags": [],
|
|
38288
|
+
"dryRun": false,
|
|
38289
|
+
"envelope": "QueryCountResultModel",
|
|
38290
|
+
"inputSchema": {
|
|
38291
|
+
"params": {
|
|
38292
|
+
"type": "object",
|
|
38293
|
+
"required": false,
|
|
38294
|
+
"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.",
|
|
38295
|
+
"properties": [
|
|
38296
|
+
{
|
|
38297
|
+
"name": "filter",
|
|
38298
|
+
"type": "FilterCondition[]",
|
|
38299
|
+
"optional": true
|
|
38300
|
+
},
|
|
38301
|
+
{
|
|
38302
|
+
"name": "fieldCheck",
|
|
38303
|
+
"type": "boolean",
|
|
38304
|
+
"optional": true
|
|
38305
|
+
}
|
|
38306
|
+
]
|
|
38307
|
+
}
|
|
38308
|
+
},
|
|
38309
|
+
"inputSchemaStrict": true,
|
|
38310
|
+
"outputSchema": {
|
|
38311
|
+
"type": "QueryCountResultModel",
|
|
38312
|
+
"drops": []
|
|
38313
|
+
},
|
|
38314
|
+
"examples": [
|
|
38315
|
+
"await client.surveys.count({ filter: [{ field: 'name', op: 'eq', value: 'example' }] })"
|
|
38316
|
+
],
|
|
38317
|
+
"permissions": "unknown",
|
|
38318
|
+
"pagination": {
|
|
38319
|
+
"mode": "none"
|
|
38320
|
+
},
|
|
38321
|
+
"resolution": null,
|
|
38322
|
+
"retry": {
|
|
38323
|
+
"preset": "retry-ffb3a9cb"
|
|
38324
|
+
},
|
|
38325
|
+
"errors": {
|
|
38326
|
+
"set": 0
|
|
38327
|
+
},
|
|
38328
|
+
"metadata": {
|
|
38329
|
+
"purpose": "Count survey records matching a JSON filter.",
|
|
38330
|
+
"usage": "Unwraps queryCount; returns a plain number.",
|
|
38331
|
+
"preferredWhen": null,
|
|
38332
|
+
"related": [
|
|
38333
|
+
"surveys.query"
|
|
38334
|
+
],
|
|
38335
|
+
"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.",
|
|
38336
|
+
"untrustedFields": [
|
|
38337
|
+
"description",
|
|
38338
|
+
"displayName",
|
|
38339
|
+
"name"
|
|
38340
|
+
]
|
|
38341
|
+
},
|
|
38342
|
+
"compact": null,
|
|
38343
|
+
"status": "tested"
|
|
38344
|
+
},
|
|
38345
|
+
{
|
|
38346
|
+
"id": "surveys.get",
|
|
38347
|
+
"resource": "surveys",
|
|
38348
|
+
"udfCapable": false,
|
|
38349
|
+
"operation": "get",
|
|
38350
|
+
"kind": "primitive",
|
|
38351
|
+
"endpoint": "GET /V1.0/Surveys/{id}",
|
|
38352
|
+
"effect": "read",
|
|
38353
|
+
"flags": [],
|
|
38354
|
+
"dryRun": false,
|
|
38355
|
+
"envelope": "ItemQueryResultModel[SurveyModel,Survey]",
|
|
38356
|
+
"inputSchema": {
|
|
38357
|
+
"id": {
|
|
38358
|
+
"type": "string | number",
|
|
38359
|
+
"required": true,
|
|
38360
|
+
"description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
|
|
38361
|
+
},
|
|
38362
|
+
"opts": {
|
|
38363
|
+
"type": "object",
|
|
38364
|
+
"required": false,
|
|
38365
|
+
"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.",
|
|
38366
|
+
"properties": [
|
|
38367
|
+
{
|
|
38368
|
+
"name": "fresh",
|
|
38369
|
+
"type": "boolean",
|
|
38370
|
+
"optional": true
|
|
38371
|
+
}
|
|
38372
|
+
]
|
|
38373
|
+
}
|
|
38374
|
+
},
|
|
38375
|
+
"inputSchemaStrict": true,
|
|
38376
|
+
"outputSchema": {
|
|
38377
|
+
"type": "ItemQueryResultModel[SurveyModel,Survey]",
|
|
38378
|
+
"drops": []
|
|
38379
|
+
},
|
|
38380
|
+
"examples": [
|
|
38381
|
+
"await client.surveys.get('example-value')"
|
|
38382
|
+
],
|
|
38383
|
+
"permissions": "unknown",
|
|
38384
|
+
"pagination": {
|
|
38385
|
+
"mode": "none"
|
|
38386
|
+
},
|
|
38387
|
+
"resolution": null,
|
|
38388
|
+
"retry": {
|
|
38389
|
+
"preset": "retry-ffb3a9cb"
|
|
38390
|
+
},
|
|
38391
|
+
"errors": {
|
|
38392
|
+
"set": 3
|
|
38393
|
+
},
|
|
38394
|
+
"metadata": {
|
|
38395
|
+
"purpose": "Get one Survey by id.",
|
|
38396
|
+
"usage": "item: null on the 200 body maps to NotFoundError (vendor not-found signal).",
|
|
38397
|
+
"preferredWhen": "Preferred when the numeric id is already known; surveys.resolve is for a field value.",
|
|
38398
|
+
"related": [
|
|
38399
|
+
"surveys.resolve"
|
|
38400
|
+
],
|
|
38401
|
+
"args": "args[0] is the record id (number) Item GET returns the FULL vendor model — the vendor documents no field selection on single-record reads. For a slim record use surveys.search (compact summary) or a surveys.query with includeFields.",
|
|
38402
|
+
"untrustedFields": [
|
|
38403
|
+
"description",
|
|
38404
|
+
"displayName",
|
|
38405
|
+
"name"
|
|
38406
|
+
]
|
|
38407
|
+
},
|
|
38408
|
+
"compact": null,
|
|
38409
|
+
"status": "tested"
|
|
38410
|
+
},
|
|
38411
|
+
{
|
|
38412
|
+
"id": "surveys.getEntityInfo",
|
|
38413
|
+
"resource": "surveys",
|
|
38414
|
+
"udfCapable": false,
|
|
38415
|
+
"operation": "getEntityInfo",
|
|
38416
|
+
"kind": "primitive",
|
|
38417
|
+
"endpoint": "GET /V1.0/Surveys/entityInformation",
|
|
38418
|
+
"effect": "read",
|
|
38419
|
+
"flags": [],
|
|
38420
|
+
"dryRun": false,
|
|
38421
|
+
"envelope": "EntityInformationResultModel",
|
|
38422
|
+
"inputSchema": {},
|
|
38423
|
+
"inputSchemaStrict": true,
|
|
38424
|
+
"outputSchema": {
|
|
38425
|
+
"type": "EntityInformationResultModel",
|
|
38426
|
+
"drops": []
|
|
38427
|
+
},
|
|
38428
|
+
"examples": [
|
|
38429
|
+
"await client.surveys.getEntityInfo()"
|
|
38430
|
+
],
|
|
38431
|
+
"permissions": "unknown",
|
|
38432
|
+
"pagination": {
|
|
38433
|
+
"mode": "none"
|
|
38434
|
+
},
|
|
38435
|
+
"resolution": null,
|
|
38436
|
+
"retry": {
|
|
38437
|
+
"preset": "retry-ffb3a9cb"
|
|
38438
|
+
},
|
|
38439
|
+
"errors": {
|
|
38440
|
+
"set": 0
|
|
38441
|
+
},
|
|
38442
|
+
"metadata": {
|
|
38443
|
+
"purpose": "Get the Survey capability metadata (canCreate/canUpdate/hasUserDefinedFields/...).",
|
|
38444
|
+
"usage": "Unwraps info{}; drives client-side capability checks.",
|
|
38445
|
+
"preferredWhen": null,
|
|
38446
|
+
"related": [
|
|
38447
|
+
"surveys.getFieldInfo"
|
|
38448
|
+
],
|
|
38449
|
+
"untrustedFields": [
|
|
38450
|
+
"description",
|
|
38451
|
+
"displayName",
|
|
38452
|
+
"name"
|
|
38453
|
+
]
|
|
38454
|
+
},
|
|
38455
|
+
"compact": null,
|
|
38456
|
+
"status": "tested"
|
|
38457
|
+
},
|
|
38458
|
+
{
|
|
38459
|
+
"id": "surveys.getFieldInfo",
|
|
38460
|
+
"resource": "surveys",
|
|
38461
|
+
"udfCapable": false,
|
|
38462
|
+
"operation": "getFieldInfo",
|
|
38463
|
+
"kind": "primitive",
|
|
38464
|
+
"endpoint": "GET /V1.0/Surveys/entityInformation/fields",
|
|
38465
|
+
"effect": "read",
|
|
38466
|
+
"flags": [],
|
|
38467
|
+
"dryRun": false,
|
|
38468
|
+
"envelope": "FieldInformationResultModel",
|
|
38469
|
+
"inputSchema": {},
|
|
38470
|
+
"inputSchemaStrict": true,
|
|
38471
|
+
"outputSchema": {
|
|
38472
|
+
"type": "FieldInformationResultModel",
|
|
38473
|
+
"drops": []
|
|
38474
|
+
},
|
|
38475
|
+
"examples": [
|
|
38476
|
+
"await client.surveys.getFieldInfo()"
|
|
38477
|
+
],
|
|
38478
|
+
"permissions": "unknown",
|
|
38479
|
+
"pagination": {
|
|
38480
|
+
"mode": "none"
|
|
38481
|
+
},
|
|
38482
|
+
"resolution": null,
|
|
38483
|
+
"retry": {
|
|
38484
|
+
"preset": "retry-ffb3a9cb"
|
|
38485
|
+
},
|
|
38486
|
+
"errors": {
|
|
38487
|
+
"set": 0
|
|
38488
|
+
},
|
|
38489
|
+
"metadata": {
|
|
38490
|
+
"purpose": "Get the Survey field catalog (types, picklists, required, maxLength) — the full raw field dump (the largest read of the info trio; compact discovery: operations.fieldCatalog).",
|
|
38491
|
+
"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.",
|
|
38492
|
+
"preferredWhen": null,
|
|
38493
|
+
"related": [
|
|
38494
|
+
"surveys.getEntityInfo",
|
|
38495
|
+
"surveys.getUdfInfo"
|
|
38496
|
+
],
|
|
38497
|
+
"untrustedFields": [
|
|
38498
|
+
"description",
|
|
38499
|
+
"displayName",
|
|
38500
|
+
"name"
|
|
38501
|
+
]
|
|
38502
|
+
},
|
|
38503
|
+
"compact": null,
|
|
38504
|
+
"status": "tested"
|
|
38505
|
+
},
|
|
38506
|
+
{
|
|
38507
|
+
"id": "surveys.getUdfInfo",
|
|
38508
|
+
"resource": "surveys",
|
|
38509
|
+
"udfCapable": false,
|
|
38510
|
+
"operation": "getUdfInfo",
|
|
38511
|
+
"kind": "primitive",
|
|
38512
|
+
"endpoint": "GET /V1.0/Surveys/entityInformation/userDefinedFields",
|
|
38513
|
+
"effect": "read",
|
|
38514
|
+
"flags": [],
|
|
38515
|
+
"dryRun": false,
|
|
38516
|
+
"envelope": "UserDefinedFieldInformationResultModel",
|
|
38517
|
+
"inputSchema": {},
|
|
38518
|
+
"inputSchemaStrict": true,
|
|
38519
|
+
"outputSchema": {
|
|
38520
|
+
"type": "UserDefinedFieldInformationResultModel",
|
|
38521
|
+
"drops": []
|
|
38522
|
+
},
|
|
38523
|
+
"examples": [
|
|
38524
|
+
"await client.surveys.getUdfInfo()"
|
|
38525
|
+
],
|
|
38526
|
+
"permissions": "unknown",
|
|
38527
|
+
"pagination": {
|
|
38528
|
+
"mode": "none"
|
|
38529
|
+
},
|
|
38530
|
+
"resolution": null,
|
|
38531
|
+
"retry": {
|
|
38532
|
+
"preset": "retry-ffb3a9cb"
|
|
38533
|
+
},
|
|
38534
|
+
"errors": {
|
|
38535
|
+
"set": 0
|
|
38536
|
+
},
|
|
38537
|
+
"metadata": {
|
|
38538
|
+
"purpose": "Get the Survey user-defined-field catalog.",
|
|
38539
|
+
"usage": "Unwraps fields[]; only meaningful where the entity is UDF-capable. (entity is not UDF-capable; catalog is expected empty).",
|
|
38540
|
+
"preferredWhen": null,
|
|
38541
|
+
"related": [
|
|
38542
|
+
"surveys.getFieldInfo"
|
|
38543
|
+
],
|
|
38544
|
+
"untrustedFields": [
|
|
38545
|
+
"description",
|
|
38546
|
+
"displayName",
|
|
38547
|
+
"name"
|
|
38548
|
+
]
|
|
38549
|
+
},
|
|
38550
|
+
"compact": null,
|
|
38551
|
+
"status": "tested"
|
|
38552
|
+
},
|
|
38553
|
+
{
|
|
38554
|
+
"id": "surveys.query",
|
|
38555
|
+
"resource": "surveys",
|
|
38556
|
+
"udfCapable": false,
|
|
38557
|
+
"operation": "query",
|
|
38558
|
+
"kind": "primitive",
|
|
38559
|
+
"endpoint": "GET|POST /V1.0/Surveys/query",
|
|
37718
38560
|
"effect": "read",
|
|
37719
38561
|
"flags": [],
|
|
37720
38562
|
"dryRun": false,
|
|
@@ -43397,7 +44239,7 @@ const CAPABILITY_DATA = {
|
|
|
43397
44239
|
"preset": "retry-ffb3a9cb"
|
|
43398
44240
|
},
|
|
43399
44241
|
"errors": {
|
|
43400
|
-
"set":
|
|
44242
|
+
"set": 13
|
|
43401
44243
|
},
|
|
43402
44244
|
"metadata": {
|
|
43403
44245
|
"purpose": "The ONE posted-state read: a bounded read over the inclusive dateWorked window [from, to] (UTC 'YYYY-MM-DD' days) with the posted/unposted split derived from the billing_items.timeEntryID join — never a postedDate read (the TimeEntry entity has no postedDate; postedDate exist|notExist 500s). Approval is NOT consulted (the vendor never populates billingApprovalDateTime yet bills those entries). The no-window form is gone: read with no dateWorked filter goes through time_entries.query.",
|
|
@@ -47063,8 +47905,8 @@ const CAPABILITY_DATA = {
|
|
|
47063
47905
|
]
|
|
47064
47906
|
},
|
|
47065
47907
|
"A": {
|
|
47066
|
-
"planHash": "
|
|
47067
|
-
"builtAt": "2026-11-
|
|
47908
|
+
"planHash": "21e75d0f8bf9986b21c6b7996dfb1fec78b3aaa9afa86f50f5351c54c733d4ac",
|
|
47909
|
+
"builtAt": "2026-11-21T07:49:35.531Z",
|
|
47068
47910
|
"records": [
|
|
47069
47911
|
{
|
|
47070
47912
|
"id": "attachment_info.count",
|
|
@@ -47717,7 +48559,7 @@ const CAPABILITY_DATA = {
|
|
|
47717
48559
|
"preset": "retry-ffb3a9cb"
|
|
47718
48560
|
},
|
|
47719
48561
|
"errors": {
|
|
47720
|
-
"set":
|
|
48562
|
+
"set": 14
|
|
47721
48563
|
},
|
|
47722
48564
|
"metadata": {
|
|
47723
48565
|
"purpose": "Get everything the node knows about one company in a single call: the company record, its locations, contacts and notes, its open tickets, and its projects — every part separately reported with caps.",
|
|
@@ -47906,7 +48748,7 @@ const CAPABILITY_DATA = {
|
|
|
47906
48748
|
"preset": "retry-ffb3a9cb"
|
|
47907
48749
|
},
|
|
47908
48750
|
"errors": {
|
|
47909
|
-
"set":
|
|
48751
|
+
"set": 15
|
|
47910
48752
|
},
|
|
47911
48753
|
"metadata": {
|
|
47912
48754
|
"purpose": "Get a company with its primary context records in one call.",
|
|
@@ -48192,7 +49034,7 @@ const CAPABILITY_DATA = {
|
|
|
48192
49034
|
"preset": "retry-ffb3a9cb"
|
|
48193
49035
|
},
|
|
48194
49036
|
"errors": {
|
|
48195
|
-
"set":
|
|
49037
|
+
"set": 15
|
|
48196
49038
|
},
|
|
48197
49039
|
"metadata": {
|
|
48198
49040
|
"purpose": "Plan a CRM write: from partial company/contact details, find the company, its locations and the location to link a contact to, duplicate contacts, the required fields still missing (with how to get each) and the next atomic write to preview.",
|
|
@@ -48946,7 +49788,7 @@ const CAPABILITY_DATA = {
|
|
|
48946
49788
|
"preset": "retry-ffb3a9cb"
|
|
48947
49789
|
},
|
|
48948
49790
|
"errors": {
|
|
48949
|
-
"set":
|
|
49791
|
+
"set": 16
|
|
48950
49792
|
},
|
|
48951
49793
|
"metadata": {
|
|
48952
49794
|
"purpose": "One call for a company's unbilled work: its posted billing items (per source), the time behind them (joined through the company's tickets and tasks — time entries carry no companyID), the per-ticket rollup, the unposted anti-join section, ex-tax totals + hours, and the billing-vs-time warnings",
|
|
@@ -58252,7 +59094,7 @@ const CAPABILITY_DATA = {
|
|
|
58252
59094
|
"preset": "retry-ffb3a9cb"
|
|
58253
59095
|
},
|
|
58254
59096
|
"errors": {
|
|
58255
|
-
"set":
|
|
59097
|
+
"set": 15
|
|
58256
59098
|
},
|
|
58257
59099
|
"metadata": {
|
|
58258
59100
|
"purpose": "Get a configuration item with its primary context records in one call.",
|
|
@@ -58645,7 +59487,7 @@ const CAPABILITY_DATA = {
|
|
|
58645
59487
|
"preset": "retry-ffb3a9cb"
|
|
58646
59488
|
},
|
|
58647
59489
|
"errors": {
|
|
58648
|
-
"set":
|
|
59490
|
+
"set": 16
|
|
58649
59491
|
},
|
|
58650
59492
|
"metadata": {
|
|
58651
59493
|
"purpose": "Get the full profile of one configuration item in a single call: the item, its type, category and product records, its notes, related items, billing-product associations and subscriptions (software/licence terms keyed by configurationItemID).",
|
|
@@ -60233,7 +61075,7 @@ const CAPABILITY_DATA = {
|
|
|
60233
61075
|
"preset": "retry-ffb3a9cb"
|
|
60234
61076
|
},
|
|
60235
61077
|
"errors": {
|
|
60236
|
-
"set":
|
|
61078
|
+
"set": 11
|
|
60237
61079
|
},
|
|
60238
61080
|
"metadata": {
|
|
60239
61081
|
"purpose": "Get a contact with its company and its open tickets in a single call: the contact (the parent-scoped root read, or row when the contact has no company FK), its company, and its open tickets — every part separately reported.",
|
|
@@ -60421,7 +61263,7 @@ const CAPABILITY_DATA = {
|
|
|
60421
61263
|
"preset": "retry-ffb3a9cb"
|
|
60422
61264
|
},
|
|
60423
61265
|
"errors": {
|
|
60424
|
-
"set":
|
|
61266
|
+
"set": 15
|
|
60425
61267
|
},
|
|
60426
61268
|
"metadata": {
|
|
60427
61269
|
"purpose": "Get a contact with its primary context records in one call. (under a company)",
|
|
@@ -71361,7 +72203,7 @@ const CAPABILITY_DATA = {
|
|
|
71361
72203
|
"preset": "retry-ffb3a9cb"
|
|
71362
72204
|
},
|
|
71363
72205
|
"errors": {
|
|
71364
|
-
"set":
|
|
72206
|
+
"set": 12
|
|
71365
72207
|
},
|
|
71366
72208
|
"metadata": {
|
|
71367
72209
|
"purpose": "Get a contract with its services, billing rules, recent charges and service units in a single call — the charges part is the N newest (the count-anchored `latest` 50).",
|
|
@@ -71737,7 +72579,7 @@ const CAPABILITY_DATA = {
|
|
|
71737
72579
|
"preset": "retry-ffb3a9cb"
|
|
71738
72580
|
},
|
|
71739
72581
|
"errors": {
|
|
71740
|
-
"set":
|
|
72582
|
+
"set": 16
|
|
71741
72583
|
},
|
|
71742
72584
|
"metadata": {
|
|
71743
72585
|
"purpose": "Get the Line of Business chain for one contract in a single call: the association, the OrganizationalLevel2 (the customizable 'Line of Business' label) and the OrganizationalLevel1 (the division).",
|
|
@@ -71887,7 +72729,7 @@ const CAPABILITY_DATA = {
|
|
|
71887
72729
|
"preset": "retry-ffb3a9cb"
|
|
71888
72730
|
},
|
|
71889
72731
|
"errors": {
|
|
71890
|
-
"set":
|
|
72732
|
+
"set": 16
|
|
71891
72733
|
},
|
|
71892
72734
|
"metadata": {
|
|
71893
72735
|
"purpose": "One call for a contract's profit-and-loss over a date window: monthly revenue (invoiced vs expected-but-unbilled), labour cost through an audited four-rung rate ladder, tooling/recurring/expense costs, break-even hours, the ticketCategory activity fold, the costliest tickets, suspected miscoded time, open/renewal items, and 11 built-in data-quality warnings",
|
|
@@ -72059,7 +72901,745 @@ const CAPABILITY_DATA = {
|
|
|
72059
72901
|
"drops": []
|
|
72060
72902
|
},
|
|
72061
72903
|
"examples": [
|
|
72062
|
-
"await client.contracts.query({ filter: [{ field: 'contractName', op: 'eq', value: 'example' }], limit: 500 })"
|
|
72904
|
+
"await client.contracts.query({ filter: [{ field: 'contractName', op: 'eq', value: 'example' }], limit: 500 })"
|
|
72905
|
+
],
|
|
72906
|
+
"permissions": "unknown",
|
|
72907
|
+
"pagination": {
|
|
72908
|
+
"mode": "cursor",
|
|
72909
|
+
"vendorDefault": 10,
|
|
72910
|
+
"vendorMax": 500,
|
|
72911
|
+
"pageGuard": 1000,
|
|
72912
|
+
"queryBounded": {
|
|
72913
|
+
"default": 500,
|
|
72914
|
+
"max": 2500
|
|
72915
|
+
}
|
|
72916
|
+
},
|
|
72917
|
+
"resolution": null,
|
|
72918
|
+
"retry": {
|
|
72919
|
+
"preset": "retry-ffb3a9cb"
|
|
72920
|
+
},
|
|
72921
|
+
"errors": {
|
|
72922
|
+
"set": 4
|
|
72923
|
+
},
|
|
72924
|
+
"metadata": {
|
|
72925
|
+
"purpose": "Query Contract records with a JSON filter.",
|
|
72926
|
+
"usage": "Server-side pagination: one call walks the vendor cursor internally and preserves the initial HTTP method until the limit is met or the cursor is null. By default, each POST carries the same QueryModel body (IncludeFields, MaxRecords and the original filter). The vendor honours IncludeFields on POST continuations and uses its own continuation page size. With `via: 'get'`, the SDK follows the GET cursor with the original search parameters. Cursors must stay on the configured origin; 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). 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.",
|
|
72927
|
+
"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).",
|
|
72928
|
+
"related": [
|
|
72929
|
+
"contracts.resolve"
|
|
72930
|
+
],
|
|
72931
|
+
"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. For a simple text lookup prefer contracts.search. 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.",
|
|
72932
|
+
"untrustedFields": [
|
|
72933
|
+
"UDF1",
|
|
72934
|
+
"UDF10",
|
|
72935
|
+
"UDF11",
|
|
72936
|
+
"UDF12",
|
|
72937
|
+
"UDF13",
|
|
72938
|
+
"UDF14",
|
|
72939
|
+
"UDF15",
|
|
72940
|
+
"UDF16",
|
|
72941
|
+
"UDF17",
|
|
72942
|
+
"UDF18",
|
|
72943
|
+
"UDF19",
|
|
72944
|
+
"UDF2",
|
|
72945
|
+
"UDF20",
|
|
72946
|
+
"UDF3",
|
|
72947
|
+
"UDF4",
|
|
72948
|
+
"UDF5",
|
|
72949
|
+
"UDF6",
|
|
72950
|
+
"UDF7",
|
|
72951
|
+
"UDF8",
|
|
72952
|
+
"UDF9",
|
|
72953
|
+
"contactName",
|
|
72954
|
+
"contractName",
|
|
72955
|
+
"description"
|
|
72956
|
+
]
|
|
72957
|
+
},
|
|
72958
|
+
"compact": null,
|
|
72959
|
+
"status": "tested"
|
|
72960
|
+
},
|
|
72961
|
+
{
|
|
72962
|
+
"id": "contracts.resolve",
|
|
72963
|
+
"resource": "contracts",
|
|
72964
|
+
"udfCapable": true,
|
|
72965
|
+
"operation": "resolve",
|
|
72966
|
+
"kind": "helper",
|
|
72967
|
+
"endpoint": null,
|
|
72968
|
+
"effect": "read",
|
|
72969
|
+
"flags": [],
|
|
72970
|
+
"dryRun": false,
|
|
72971
|
+
"envelope": null,
|
|
72972
|
+
"inputSchema": {
|
|
72973
|
+
"identifier": {
|
|
72974
|
+
"type": "string | number",
|
|
72975
|
+
"required": true,
|
|
72976
|
+
"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)."
|
|
72977
|
+
},
|
|
72978
|
+
"opts": {
|
|
72979
|
+
"type": "object",
|
|
72980
|
+
"required": false,
|
|
72981
|
+
"description": "ResolutionOpts — { expand?: boolean } (return the full record; a no-op where the Summary is a structural alias).",
|
|
72982
|
+
"properties": [
|
|
72983
|
+
{
|
|
72984
|
+
"name": "expand",
|
|
72985
|
+
"type": "boolean",
|
|
72986
|
+
"optional": true
|
|
72987
|
+
}
|
|
72988
|
+
]
|
|
72989
|
+
}
|
|
72990
|
+
},
|
|
72991
|
+
"inputSchemaStrict": true,
|
|
72992
|
+
"outputSchema": {
|
|
72993
|
+
"type": "ContractSummary",
|
|
72994
|
+
"drops": []
|
|
72995
|
+
},
|
|
72996
|
+
"examples": [
|
|
72997
|
+
"await client.contracts.resolve('example-value')"
|
|
72998
|
+
],
|
|
72999
|
+
"permissions": "unknown",
|
|
73000
|
+
"pagination": {
|
|
73001
|
+
"mode": "none"
|
|
73002
|
+
},
|
|
73003
|
+
"resolution": {
|
|
73004
|
+
"basis": "server-filter",
|
|
73005
|
+
"maxScanRecords": 500,
|
|
73006
|
+
"maxScanPages": 4
|
|
73007
|
+
},
|
|
73008
|
+
"retry": {
|
|
73009
|
+
"preset": "retry-ffb3a9cb"
|
|
73010
|
+
},
|
|
73011
|
+
"errors": {
|
|
73012
|
+
"set": 5
|
|
73013
|
+
},
|
|
73014
|
+
"metadata": {
|
|
73015
|
+
"purpose": "Resolve a contract from a numeric id (the direct fetch, tried first) or an exact value of its primary text field(s) (contractName — exact match only). Returns the Contract record with the numeric id for get/update/delete. Other identifier forms (e.g. an email address) are NOT tried by resolve — use the resource's dedicated lookup op where one exists (see autotask_catalog).",
|
|
73016
|
+
"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.",
|
|
73017
|
+
"preferredWhen": null,
|
|
73018
|
+
"related": [
|
|
73019
|
+
"contracts.get"
|
|
73020
|
+
],
|
|
73021
|
+
"untrustedFields": [
|
|
73022
|
+
"UDF1",
|
|
73023
|
+
"UDF10",
|
|
73024
|
+
"UDF11",
|
|
73025
|
+
"UDF12",
|
|
73026
|
+
"UDF13",
|
|
73027
|
+
"UDF14",
|
|
73028
|
+
"UDF15",
|
|
73029
|
+
"UDF16",
|
|
73030
|
+
"UDF17",
|
|
73031
|
+
"UDF18",
|
|
73032
|
+
"UDF19",
|
|
73033
|
+
"UDF2",
|
|
73034
|
+
"UDF20",
|
|
73035
|
+
"UDF3",
|
|
73036
|
+
"UDF4",
|
|
73037
|
+
"UDF5",
|
|
73038
|
+
"UDF6",
|
|
73039
|
+
"UDF7",
|
|
73040
|
+
"UDF8",
|
|
73041
|
+
"UDF9",
|
|
73042
|
+
"contactName",
|
|
73043
|
+
"contractName",
|
|
73044
|
+
"description"
|
|
73045
|
+
]
|
|
73046
|
+
},
|
|
73047
|
+
"compact": "ContractSummary",
|
|
73048
|
+
"status": "tested"
|
|
73049
|
+
},
|
|
73050
|
+
{
|
|
73051
|
+
"id": "contracts.search",
|
|
73052
|
+
"resource": "contracts",
|
|
73053
|
+
"udfCapable": true,
|
|
73054
|
+
"operation": "search",
|
|
73055
|
+
"kind": "helper",
|
|
73056
|
+
"endpoint": null,
|
|
73057
|
+
"effect": "read",
|
|
73058
|
+
"flags": [],
|
|
73059
|
+
"dryRun": false,
|
|
73060
|
+
"envelope": null,
|
|
73061
|
+
"inputSchema": {
|
|
73062
|
+
"query": {
|
|
73063
|
+
"type": "string",
|
|
73064
|
+
"required": true,
|
|
73065
|
+
"description": "The free text to match (contains) on the resource searchable fields."
|
|
73066
|
+
},
|
|
73067
|
+
"opts": {
|
|
73068
|
+
"type": "object",
|
|
73069
|
+
"required": false,
|
|
73070
|
+
"description": "SearchOpts — { limit?: number } (1-500, default 25).",
|
|
73071
|
+
"properties": [
|
|
73072
|
+
{
|
|
73073
|
+
"name": "limit",
|
|
73074
|
+
"type": "number",
|
|
73075
|
+
"optional": true
|
|
73076
|
+
}
|
|
73077
|
+
]
|
|
73078
|
+
}
|
|
73079
|
+
},
|
|
73080
|
+
"inputSchemaStrict": true,
|
|
73081
|
+
"outputSchema": {
|
|
73082
|
+
"type": "ContractSummary",
|
|
73083
|
+
"drops": []
|
|
73084
|
+
},
|
|
73085
|
+
"examples": [
|
|
73086
|
+
"await client.contracts.search('example')"
|
|
73087
|
+
],
|
|
73088
|
+
"permissions": "unknown",
|
|
73089
|
+
"pagination": {
|
|
73090
|
+
"mode": "none"
|
|
73091
|
+
},
|
|
73092
|
+
"resolution": {
|
|
73093
|
+
"basis": "server-filter",
|
|
73094
|
+
"maxScanRecords": 500,
|
|
73095
|
+
"maxScanPages": 4
|
|
73096
|
+
},
|
|
73097
|
+
"retry": {
|
|
73098
|
+
"preset": "retry-ffb3a9cb"
|
|
73099
|
+
},
|
|
73100
|
+
"errors": {
|
|
73101
|
+
"set": 5
|
|
73102
|
+
},
|
|
73103
|
+
"metadata": {
|
|
73104
|
+
"purpose": "Search contract records by text (contains on the searchable fields).",
|
|
73105
|
+
"usage": "Vendor exposes no free-text search; this is a bounded contains filter: contractName only (contains). limit defaults to 25, max 500.",
|
|
73106
|
+
"preferredWhen": null,
|
|
73107
|
+
"related": [
|
|
73108
|
+
"contracts.resolve",
|
|
73109
|
+
"contracts.query"
|
|
73110
|
+
],
|
|
73111
|
+
"untrustedFields": [
|
|
73112
|
+
"UDF1",
|
|
73113
|
+
"UDF10",
|
|
73114
|
+
"UDF11",
|
|
73115
|
+
"UDF12",
|
|
73116
|
+
"UDF13",
|
|
73117
|
+
"UDF14",
|
|
73118
|
+
"UDF15",
|
|
73119
|
+
"UDF16",
|
|
73120
|
+
"UDF17",
|
|
73121
|
+
"UDF18",
|
|
73122
|
+
"UDF19",
|
|
73123
|
+
"UDF2",
|
|
73124
|
+
"UDF20",
|
|
73125
|
+
"UDF3",
|
|
73126
|
+
"UDF4",
|
|
73127
|
+
"UDF5",
|
|
73128
|
+
"UDF6",
|
|
73129
|
+
"UDF7",
|
|
73130
|
+
"UDF8",
|
|
73131
|
+
"UDF9",
|
|
73132
|
+
"contactName",
|
|
73133
|
+
"contractName",
|
|
73134
|
+
"description"
|
|
73135
|
+
]
|
|
73136
|
+
},
|
|
73137
|
+
"compact": "ContractSummary",
|
|
73138
|
+
"status": "tested"
|
|
73139
|
+
},
|
|
73140
|
+
{
|
|
73141
|
+
"id": "contracts.update",
|
|
73142
|
+
"resource": "contracts",
|
|
73143
|
+
"udfCapable": true,
|
|
73144
|
+
"operation": "update",
|
|
73145
|
+
"kind": "primitive",
|
|
73146
|
+
"endpoint": "PUT|PATCH /V1.0/Contracts",
|
|
73147
|
+
"effect": "write",
|
|
73148
|
+
"flags": [
|
|
73149
|
+
"idempotent"
|
|
73150
|
+
],
|
|
73151
|
+
"dryRun": true,
|
|
73152
|
+
"envelope": "OperationResultModel",
|
|
73153
|
+
"inputSchema": {
|
|
73154
|
+
"id": {
|
|
73155
|
+
"type": "string | number",
|
|
73156
|
+
"required": true,
|
|
73157
|
+
"description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
|
|
73158
|
+
},
|
|
73159
|
+
"data": {
|
|
73160
|
+
"type": "object",
|
|
73161
|
+
"required": true,
|
|
73162
|
+
"description": "The record payload (vendor model fields)."
|
|
73163
|
+
}
|
|
73164
|
+
},
|
|
73165
|
+
"inputSchemaStrict": true,
|
|
73166
|
+
"outputSchema": {
|
|
73167
|
+
"type": "OperationResultModel",
|
|
73168
|
+
"drops": []
|
|
73169
|
+
},
|
|
73170
|
+
"examples": [
|
|
73171
|
+
"await client.contracts.update('example-value', { contractName: 'example' }, { dryRun: true })"
|
|
73172
|
+
],
|
|
73173
|
+
"permissions": "unknown",
|
|
73174
|
+
"pagination": {
|
|
73175
|
+
"mode": "none"
|
|
73176
|
+
},
|
|
73177
|
+
"resolution": null,
|
|
73178
|
+
"retry": {
|
|
73179
|
+
"preset": "retry-1849870d"
|
|
73180
|
+
},
|
|
73181
|
+
"errors": {
|
|
73182
|
+
"set": 1
|
|
73183
|
+
},
|
|
73184
|
+
"metadata": {
|
|
73185
|
+
"purpose": "Update a contract.",
|
|
73186
|
+
"usage": "Issues PUT (vendor tolerates PATCH for the same endpoint). Stale check via lastModifiedDate where present. The collection PUT validates the FULL model (vendor V2): a partial body is merged into the current record (one GET; when a stale-check field is configured, the same read also supplies that guard) before the PUT; explicit nulls send null, omitted fields keep the current value. Pass raw: true in the opts bag to send the body as-is (no merge).",
|
|
73187
|
+
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
73188
|
+
"related": [
|
|
73189
|
+
"contracts.get"
|
|
73190
|
+
],
|
|
73191
|
+
"collectionUpdate": true,
|
|
73192
|
+
"untrustedFields": [
|
|
73193
|
+
"UDF1",
|
|
73194
|
+
"UDF10",
|
|
73195
|
+
"UDF11",
|
|
73196
|
+
"UDF12",
|
|
73197
|
+
"UDF13",
|
|
73198
|
+
"UDF14",
|
|
73199
|
+
"UDF15",
|
|
73200
|
+
"UDF16",
|
|
73201
|
+
"UDF17",
|
|
73202
|
+
"UDF18",
|
|
73203
|
+
"UDF19",
|
|
73204
|
+
"UDF2",
|
|
73205
|
+
"UDF20",
|
|
73206
|
+
"UDF3",
|
|
73207
|
+
"UDF4",
|
|
73208
|
+
"UDF5",
|
|
73209
|
+
"UDF6",
|
|
73210
|
+
"UDF7",
|
|
73211
|
+
"UDF8",
|
|
73212
|
+
"UDF9",
|
|
73213
|
+
"contactName",
|
|
73214
|
+
"contractName",
|
|
73215
|
+
"description"
|
|
73216
|
+
],
|
|
73217
|
+
"writeQuirks": {
|
|
73218
|
+
"dateConventions": "date convention (verify against current field metadata): startDate and endDate are date-only at 00:00Z; tickets.dueDateTime is a true UTC instant."
|
|
73219
|
+
}
|
|
73220
|
+
},
|
|
73221
|
+
"compact": null,
|
|
73222
|
+
"status": "tested"
|
|
73223
|
+
},
|
|
73224
|
+
{
|
|
73225
|
+
"id": "inventory_items.count",
|
|
73226
|
+
"resource": "inventory_items",
|
|
73227
|
+
"udfCapable": false,
|
|
73228
|
+
"operation": "count",
|
|
73229
|
+
"kind": "primitive",
|
|
73230
|
+
"endpoint": "POST /V1.0/InventoryItems/query/count",
|
|
73231
|
+
"effect": "read",
|
|
73232
|
+
"flags": [],
|
|
73233
|
+
"dryRun": false,
|
|
73234
|
+
"envelope": "QueryCountResultModel",
|
|
73235
|
+
"inputSchema": {
|
|
73236
|
+
"params": {
|
|
73237
|
+
"type": "object",
|
|
73238
|
+
"required": false,
|
|
73239
|
+
"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. InventoryItems has no record UDFs. UDF-marked filters are refused even with fieldCheck: false.",
|
|
73240
|
+
"properties": [
|
|
73241
|
+
{
|
|
73242
|
+
"name": "filter",
|
|
73243
|
+
"type": "FilterCondition[]",
|
|
73244
|
+
"optional": true
|
|
73245
|
+
},
|
|
73246
|
+
{
|
|
73247
|
+
"name": "fieldCheck",
|
|
73248
|
+
"type": "boolean",
|
|
73249
|
+
"optional": true
|
|
73250
|
+
}
|
|
73251
|
+
]
|
|
73252
|
+
}
|
|
73253
|
+
},
|
|
73254
|
+
"inputSchemaStrict": true,
|
|
73255
|
+
"outputSchema": {
|
|
73256
|
+
"type": "QueryCountResultModel",
|
|
73257
|
+
"drops": []
|
|
73258
|
+
},
|
|
73259
|
+
"examples": [
|
|
73260
|
+
"await invoke(client, 'inventory_items.count', [{ filter: [{ field: 'productID', op: 'eq', value: 7 }] }])"
|
|
73261
|
+
],
|
|
73262
|
+
"permissions": "unknown",
|
|
73263
|
+
"pagination": {
|
|
73264
|
+
"mode": "none"
|
|
73265
|
+
},
|
|
73266
|
+
"resolution": null,
|
|
73267
|
+
"retry": {
|
|
73268
|
+
"preset": "retry-ffb3a9cb"
|
|
73269
|
+
},
|
|
73270
|
+
"errors": {
|
|
73271
|
+
"set": 6
|
|
73272
|
+
},
|
|
73273
|
+
"metadata": {
|
|
73274
|
+
"purpose": "Count inventory item records matching a JSON filter.",
|
|
73275
|
+
"usage": "Unwraps queryCount; returns a plain number. Inventory permissions and module access govern visibility and writes. Empty results do not establish tenant-wide absence. Records bind a product and an inventory location.",
|
|
73276
|
+
"preferredWhen": null,
|
|
73277
|
+
"related": [
|
|
73278
|
+
"inventory_items.query"
|
|
73279
|
+
],
|
|
73280
|
+
"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 / no UDFs / 8000 chars.",
|
|
73281
|
+
"untrustedFields": [
|
|
73282
|
+
"bin",
|
|
73283
|
+
"referenceNumber"
|
|
73284
|
+
]
|
|
73285
|
+
},
|
|
73286
|
+
"compact": null,
|
|
73287
|
+
"status": "tested"
|
|
73288
|
+
},
|
|
73289
|
+
{
|
|
73290
|
+
"id": "inventory_items.create",
|
|
73291
|
+
"resource": "inventory_items",
|
|
73292
|
+
"udfCapable": false,
|
|
73293
|
+
"operation": "create",
|
|
73294
|
+
"kind": "primitive",
|
|
73295
|
+
"endpoint": "POST /V1.0/InventoryItems",
|
|
73296
|
+
"effect": "write",
|
|
73297
|
+
"flags": [],
|
|
73298
|
+
"dryRun": true,
|
|
73299
|
+
"envelope": "OperationResultModel",
|
|
73300
|
+
"inputSchema": {
|
|
73301
|
+
"data": {
|
|
73302
|
+
"type": "object",
|
|
73303
|
+
"required": true,
|
|
73304
|
+
"description": "The record payload (vendor model fields)."
|
|
73305
|
+
}
|
|
73306
|
+
},
|
|
73307
|
+
"inputSchemaStrict": true,
|
|
73308
|
+
"outputSchema": {
|
|
73309
|
+
"type": "OperationResultModel",
|
|
73310
|
+
"drops": []
|
|
73311
|
+
},
|
|
73312
|
+
"examples": [
|
|
73313
|
+
"await client.inventoryItems.create({ productID: 3, inventoryLocationID: 7, quantityMinimum: 0, quantityMaximum: 10, quantityOnHand: 0 }, { dryRun: true })"
|
|
73314
|
+
],
|
|
73315
|
+
"permissions": "unknown",
|
|
73316
|
+
"pagination": {
|
|
73317
|
+
"mode": "none"
|
|
73318
|
+
},
|
|
73319
|
+
"resolution": null,
|
|
73320
|
+
"retry": {
|
|
73321
|
+
"preset": "retry-c5657094"
|
|
73322
|
+
},
|
|
73323
|
+
"errors": {
|
|
73324
|
+
"set": 17
|
|
73325
|
+
},
|
|
73326
|
+
"metadata": {
|
|
73327
|
+
"purpose": "Create a product-location inventory item.",
|
|
73328
|
+
"usage": "Inventory permissions and module access govern visibility and writes. Empty results do not establish tenant-wide absence. Records bind a product and an inventory location. Supply productID, inventoryLocationID, quantityMinimum, quantityMaximum and quantityOnHand. Product and location are verified before preview or apply. The location must be active and initial quantityOnHand must be nonnegative. Serialized products require zero on-hand. Autotask controls pair uniqueness and initializes read-only counters. No public DELETE exists. Preview first.",
|
|
73329
|
+
"preferredWhen": "Use for a new product-location pair after checking known inventory items.",
|
|
73330
|
+
"related": [
|
|
73331
|
+
"inventory_items.query",
|
|
73332
|
+
"inventory_locations.get",
|
|
73333
|
+
"products.get"
|
|
73334
|
+
],
|
|
73335
|
+
"deleteBoundary": {
|
|
73336
|
+
"resource": "inventory_items",
|
|
73337
|
+
"note": "The specification defines no public DELETE for InventoryItems. A created item cannot be removed through that API.",
|
|
73338
|
+
"proof": "spec-derived"
|
|
73339
|
+
},
|
|
73340
|
+
"untrustedFields": [
|
|
73341
|
+
"bin",
|
|
73342
|
+
"referenceNumber"
|
|
73343
|
+
],
|
|
73344
|
+
"accountWide": true,
|
|
73345
|
+
"createRequirements": {
|
|
73346
|
+
"requires": {
|
|
73347
|
+
"allOf": [
|
|
73348
|
+
"inventoryLocationID",
|
|
73349
|
+
"productID",
|
|
73350
|
+
"quantityMinimum",
|
|
73351
|
+
"quantityMaximum",
|
|
73352
|
+
"quantityOnHand"
|
|
73353
|
+
]
|
|
73354
|
+
}
|
|
73355
|
+
}
|
|
73356
|
+
},
|
|
73357
|
+
"compact": null,
|
|
73358
|
+
"status": "tested"
|
|
73359
|
+
},
|
|
73360
|
+
{
|
|
73361
|
+
"id": "inventory_items.get",
|
|
73362
|
+
"resource": "inventory_items",
|
|
73363
|
+
"udfCapable": false,
|
|
73364
|
+
"operation": "get",
|
|
73365
|
+
"kind": "primitive",
|
|
73366
|
+
"endpoint": "GET /V1.0/InventoryItems/{id}",
|
|
73367
|
+
"effect": "read",
|
|
73368
|
+
"flags": [],
|
|
73369
|
+
"dryRun": false,
|
|
73370
|
+
"envelope": "ItemQueryResultModel[InventoryItemModel,InventoryItem]",
|
|
73371
|
+
"inputSchema": {
|
|
73372
|
+
"id": {
|
|
73373
|
+
"type": "string | number",
|
|
73374
|
+
"required": true,
|
|
73375
|
+
"description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
|
|
73376
|
+
},
|
|
73377
|
+
"opts": {
|
|
73378
|
+
"type": "object",
|
|
73379
|
+
"required": false,
|
|
73380
|
+
"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.",
|
|
73381
|
+
"properties": [
|
|
73382
|
+
{
|
|
73383
|
+
"name": "fresh",
|
|
73384
|
+
"type": "boolean",
|
|
73385
|
+
"optional": true
|
|
73386
|
+
}
|
|
73387
|
+
]
|
|
73388
|
+
}
|
|
73389
|
+
},
|
|
73390
|
+
"inputSchemaStrict": true,
|
|
73391
|
+
"outputSchema": {
|
|
73392
|
+
"type": "ItemQueryResultModel[InventoryItemModel,InventoryItem]",
|
|
73393
|
+
"drops": []
|
|
73394
|
+
},
|
|
73395
|
+
"examples": [
|
|
73396
|
+
"await client.inventoryItems.get(7)"
|
|
73397
|
+
],
|
|
73398
|
+
"permissions": "unknown",
|
|
73399
|
+
"pagination": {
|
|
73400
|
+
"mode": "none"
|
|
73401
|
+
},
|
|
73402
|
+
"resolution": null,
|
|
73403
|
+
"retry": {
|
|
73404
|
+
"preset": "retry-ffb3a9cb"
|
|
73405
|
+
},
|
|
73406
|
+
"errors": {
|
|
73407
|
+
"set": 3
|
|
73408
|
+
},
|
|
73409
|
+
"metadata": {
|
|
73410
|
+
"purpose": "Get one InventoryItem by id.",
|
|
73411
|
+
"usage": "item: null on the 200 body maps to NotFoundError (vendor not-found signal). Inventory permissions and module access govern visibility and writes. Empty results do not establish tenant-wide absence. Records bind a product and an inventory location.",
|
|
73412
|
+
"preferredWhen": "Preferred when the numeric id is already known.",
|
|
73413
|
+
"related": [
|
|
73414
|
+
"inventory_items.query"
|
|
73415
|
+
],
|
|
73416
|
+
"args": "args[0] is the record id (safe integer or decimal string; use the string form above Number.MAX_SAFE_INTEGER). Item GET returns the FULL vendor model — the vendor documents no field selection on single-record reads. For a slim record use an inventory_items.query with includeFields.",
|
|
73417
|
+
"untrustedFields": [
|
|
73418
|
+
"bin",
|
|
73419
|
+
"referenceNumber"
|
|
73420
|
+
]
|
|
73421
|
+
},
|
|
73422
|
+
"compact": null,
|
|
73423
|
+
"status": "tested"
|
|
73424
|
+
},
|
|
73425
|
+
{
|
|
73426
|
+
"id": "inventory_items.getEntityInfo",
|
|
73427
|
+
"resource": "inventory_items",
|
|
73428
|
+
"udfCapable": false,
|
|
73429
|
+
"operation": "getEntityInfo",
|
|
73430
|
+
"kind": "primitive",
|
|
73431
|
+
"endpoint": "GET /V1.0/InventoryItems/entityInformation",
|
|
73432
|
+
"effect": "read",
|
|
73433
|
+
"flags": [],
|
|
73434
|
+
"dryRun": false,
|
|
73435
|
+
"envelope": "EntityInformationResultModel",
|
|
73436
|
+
"inputSchema": {},
|
|
73437
|
+
"inputSchemaStrict": true,
|
|
73438
|
+
"outputSchema": {
|
|
73439
|
+
"type": "EntityInformationResultModel",
|
|
73440
|
+
"drops": []
|
|
73441
|
+
},
|
|
73442
|
+
"examples": [
|
|
73443
|
+
"await client.inventoryItems.getEntityInfo()"
|
|
73444
|
+
],
|
|
73445
|
+
"permissions": "unknown",
|
|
73446
|
+
"pagination": {
|
|
73447
|
+
"mode": "none"
|
|
73448
|
+
},
|
|
73449
|
+
"resolution": null,
|
|
73450
|
+
"retry": {
|
|
73451
|
+
"preset": "retry-ffb3a9cb"
|
|
73452
|
+
},
|
|
73453
|
+
"errors": {
|
|
73454
|
+
"set": 6
|
|
73455
|
+
},
|
|
73456
|
+
"metadata": {
|
|
73457
|
+
"purpose": "Get the InventoryItem capability metadata (canCreate/canUpdate/hasUserDefinedFields/...).",
|
|
73458
|
+
"usage": "Unwraps info{}; drives client-side capability checks.",
|
|
73459
|
+
"preferredWhen": null,
|
|
73460
|
+
"related": [
|
|
73461
|
+
"inventory_items.getFieldInfo"
|
|
73462
|
+
],
|
|
73463
|
+
"untrustedFields": [
|
|
73464
|
+
"bin",
|
|
73465
|
+
"referenceNumber"
|
|
73466
|
+
]
|
|
73467
|
+
},
|
|
73468
|
+
"compact": null,
|
|
73469
|
+
"status": "tested"
|
|
73470
|
+
},
|
|
73471
|
+
{
|
|
73472
|
+
"id": "inventory_items.getFieldInfo",
|
|
73473
|
+
"resource": "inventory_items",
|
|
73474
|
+
"udfCapable": false,
|
|
73475
|
+
"operation": "getFieldInfo",
|
|
73476
|
+
"kind": "primitive",
|
|
73477
|
+
"endpoint": "GET /V1.0/InventoryItems/entityInformation/fields",
|
|
73478
|
+
"effect": "read",
|
|
73479
|
+
"flags": [],
|
|
73480
|
+
"dryRun": false,
|
|
73481
|
+
"envelope": "FieldInformationResultModel",
|
|
73482
|
+
"inputSchema": {},
|
|
73483
|
+
"inputSchemaStrict": true,
|
|
73484
|
+
"outputSchema": {
|
|
73485
|
+
"type": "FieldInformationResultModel",
|
|
73486
|
+
"drops": []
|
|
73487
|
+
},
|
|
73488
|
+
"examples": [
|
|
73489
|
+
"await client.inventoryItems.getFieldInfo()"
|
|
73490
|
+
],
|
|
73491
|
+
"permissions": "unknown",
|
|
73492
|
+
"pagination": {
|
|
73493
|
+
"mode": "none"
|
|
73494
|
+
},
|
|
73495
|
+
"resolution": null,
|
|
73496
|
+
"retry": {
|
|
73497
|
+
"preset": "retry-ffb3a9cb"
|
|
73498
|
+
},
|
|
73499
|
+
"errors": {
|
|
73500
|
+
"set": 6
|
|
73501
|
+
},
|
|
73502
|
+
"metadata": {
|
|
73503
|
+
"purpose": "Get the InventoryItem field catalog (types, picklists, required, maxLength) — the full raw field dump (the largest read of the info trio; compact discovery: operations.fieldCatalog).",
|
|
73504
|
+
"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.",
|
|
73505
|
+
"preferredWhen": null,
|
|
73506
|
+
"related": [
|
|
73507
|
+
"inventory_items.getEntityInfo",
|
|
73508
|
+
"inventory_items.getUdfInfo"
|
|
73509
|
+
],
|
|
73510
|
+
"untrustedFields": [
|
|
73511
|
+
"bin",
|
|
73512
|
+
"referenceNumber"
|
|
73513
|
+
]
|
|
73514
|
+
},
|
|
73515
|
+
"compact": null,
|
|
73516
|
+
"status": "tested"
|
|
73517
|
+
},
|
|
73518
|
+
{
|
|
73519
|
+
"id": "inventory_items.getUdfInfo",
|
|
73520
|
+
"resource": "inventory_items",
|
|
73521
|
+
"udfCapable": false,
|
|
73522
|
+
"operation": "getUdfInfo",
|
|
73523
|
+
"kind": "primitive",
|
|
73524
|
+
"endpoint": "GET /V1.0/InventoryItems/entityInformation/userDefinedFields",
|
|
73525
|
+
"effect": "read",
|
|
73526
|
+
"flags": [],
|
|
73527
|
+
"dryRun": false,
|
|
73528
|
+
"envelope": "UserDefinedFieldInformationResultModel",
|
|
73529
|
+
"inputSchema": {},
|
|
73530
|
+
"inputSchemaStrict": true,
|
|
73531
|
+
"outputSchema": {
|
|
73532
|
+
"type": "UserDefinedFieldInformationResultModel",
|
|
73533
|
+
"drops": []
|
|
73534
|
+
},
|
|
73535
|
+
"examples": [
|
|
73536
|
+
"await client.inventoryItems.getUdfInfo()"
|
|
73537
|
+
],
|
|
73538
|
+
"permissions": "unknown",
|
|
73539
|
+
"pagination": {
|
|
73540
|
+
"mode": "none"
|
|
73541
|
+
},
|
|
73542
|
+
"resolution": null,
|
|
73543
|
+
"retry": {
|
|
73544
|
+
"preset": "retry-ffb3a9cb"
|
|
73545
|
+
},
|
|
73546
|
+
"errors": {
|
|
73547
|
+
"set": 6
|
|
73548
|
+
},
|
|
73549
|
+
"metadata": {
|
|
73550
|
+
"purpose": "Get the InventoryItem user-defined-field catalog.",
|
|
73551
|
+
"usage": "Unwraps fields[]; only meaningful where the entity is UDF-capable. (entity is not UDF-capable; catalog is expected empty).",
|
|
73552
|
+
"preferredWhen": null,
|
|
73553
|
+
"related": [
|
|
73554
|
+
"inventory_items.getFieldInfo"
|
|
73555
|
+
],
|
|
73556
|
+
"untrustedFields": [
|
|
73557
|
+
"bin",
|
|
73558
|
+
"referenceNumber"
|
|
73559
|
+
]
|
|
73560
|
+
},
|
|
73561
|
+
"compact": null,
|
|
73562
|
+
"status": "tested"
|
|
73563
|
+
},
|
|
73564
|
+
{
|
|
73565
|
+
"id": "inventory_items.query",
|
|
73566
|
+
"resource": "inventory_items",
|
|
73567
|
+
"udfCapable": false,
|
|
73568
|
+
"operation": "query",
|
|
73569
|
+
"kind": "primitive",
|
|
73570
|
+
"endpoint": "GET|POST /V1.0/InventoryItems/query",
|
|
73571
|
+
"effect": "read",
|
|
73572
|
+
"flags": [],
|
|
73573
|
+
"dryRun": false,
|
|
73574
|
+
"envelope": "QueryActionResult[<Model>,<Entity>]",
|
|
73575
|
+
"inputSchema": {
|
|
73576
|
+
"params": {
|
|
73577
|
+
"type": "object",
|
|
73578
|
+
"required": false,
|
|
73579
|
+
"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); 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 + a capped number of cold name reads per call (several ids of one table share one batched read); 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/productID/vendorID (a company)/configurationItemCategoryID/*ResourceID (contractIDName, productIDName, assignedResourceIDName) — null, never missing, when the field is keyed with a null value, a 0 id (except companyID/vendorID 0, which name the tenant owner's own company) 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 uncached name-read cap, an id a batched name read did not return, 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 / no UDFs / 8000 chars. InventoryItems has no record UDFs. UDF-marked filters are refused even with fieldCheck: false.",
|
|
73580
|
+
"properties": [
|
|
73581
|
+
{
|
|
73582
|
+
"name": "filter",
|
|
73583
|
+
"type": "FilterCondition[]",
|
|
73584
|
+
"optional": true
|
|
73585
|
+
},
|
|
73586
|
+
{
|
|
73587
|
+
"name": "limit",
|
|
73588
|
+
"type": "number",
|
|
73589
|
+
"optional": true,
|
|
73590
|
+
"default": 500
|
|
73591
|
+
},
|
|
73592
|
+
{
|
|
73593
|
+
"name": "latest",
|
|
73594
|
+
"type": "number",
|
|
73595
|
+
"optional": true
|
|
73596
|
+
},
|
|
73597
|
+
{
|
|
73598
|
+
"name": "noteChars",
|
|
73599
|
+
"type": "number",
|
|
73600
|
+
"optional": true
|
|
73601
|
+
},
|
|
73602
|
+
{
|
|
73603
|
+
"name": "includeFields",
|
|
73604
|
+
"type": "string[]",
|
|
73605
|
+
"optional": true
|
|
73606
|
+
},
|
|
73607
|
+
{
|
|
73608
|
+
"name": "fieldCheck",
|
|
73609
|
+
"type": "boolean",
|
|
73610
|
+
"optional": true,
|
|
73611
|
+
"default": true
|
|
73612
|
+
},
|
|
73613
|
+
{
|
|
73614
|
+
"name": "names",
|
|
73615
|
+
"type": "boolean",
|
|
73616
|
+
"optional": true
|
|
73617
|
+
},
|
|
73618
|
+
{
|
|
73619
|
+
"name": "via",
|
|
73620
|
+
"type": "\"post\" | \"get\"",
|
|
73621
|
+
"optional": true
|
|
73622
|
+
},
|
|
73623
|
+
{
|
|
73624
|
+
"name": "acknowledgeUnscoped",
|
|
73625
|
+
"type": "boolean",
|
|
73626
|
+
"optional": true
|
|
73627
|
+
},
|
|
73628
|
+
{
|
|
73629
|
+
"name": "walk",
|
|
73630
|
+
"type": "object",
|
|
73631
|
+
"optional": true
|
|
73632
|
+
}
|
|
73633
|
+
]
|
|
73634
|
+
}
|
|
73635
|
+
},
|
|
73636
|
+
"inputSchemaStrict": true,
|
|
73637
|
+
"outputSchema": {
|
|
73638
|
+
"type": "QueryActionResult[<Model>,<Entity>]",
|
|
73639
|
+
"drops": []
|
|
73640
|
+
},
|
|
73641
|
+
"examples": [
|
|
73642
|
+
"await invoke(client, 'inventory_items.query', [{ filter: [{ field: 'productID', op: 'eq', value: 7 }], limit: 25 }])"
|
|
72063
73643
|
],
|
|
72064
73644
|
"permissions": "unknown",
|
|
72065
73645
|
"pagination": {
|
|
@@ -72077,235 +73657,33 @@ const CAPABILITY_DATA = {
|
|
|
72077
73657
|
"preset": "retry-ffb3a9cb"
|
|
72078
73658
|
},
|
|
72079
73659
|
"errors": {
|
|
72080
|
-
"set":
|
|
73660
|
+
"set": 18
|
|
72081
73661
|
},
|
|
72082
73662
|
"metadata": {
|
|
72083
|
-
"purpose": "Query
|
|
72084
|
-
"usage": "Server-side pagination: one call walks the vendor cursor
|
|
73663
|
+
"purpose": "Query InventoryItem records with a JSON filter.",
|
|
73664
|
+
"usage": "Server-side pagination: one call walks the vendor cursor until the limit, end, or 1000-page guard. POST is the default and carries the same QueryModel on continuation. GET mode carries the original search JSON on each GET continuation. 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). 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. Inventory permissions and module access govern visibility and writes. Empty results do not establish tenant-wide absence. Records bind a product and an inventory location. Continuation cursors stay on this collection. An empty page can still have a next cursor.",
|
|
72085
73665
|
"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).",
|
|
72086
73666
|
"related": [
|
|
72087
|
-
"
|
|
73667
|
+
"inventory_items.get"
|
|
72088
73668
|
],
|
|
72089
|
-
"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 /
|
|
73669
|
+
"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 / no UDFs / 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.",
|
|
72090
73670
|
"untrustedFields": [
|
|
72091
|
-
"
|
|
72092
|
-
"
|
|
72093
|
-
"UDF11",
|
|
72094
|
-
"UDF12",
|
|
72095
|
-
"UDF13",
|
|
72096
|
-
"UDF14",
|
|
72097
|
-
"UDF15",
|
|
72098
|
-
"UDF16",
|
|
72099
|
-
"UDF17",
|
|
72100
|
-
"UDF18",
|
|
72101
|
-
"UDF19",
|
|
72102
|
-
"UDF2",
|
|
72103
|
-
"UDF20",
|
|
72104
|
-
"UDF3",
|
|
72105
|
-
"UDF4",
|
|
72106
|
-
"UDF5",
|
|
72107
|
-
"UDF6",
|
|
72108
|
-
"UDF7",
|
|
72109
|
-
"UDF8",
|
|
72110
|
-
"UDF9",
|
|
72111
|
-
"contactName",
|
|
72112
|
-
"contractName",
|
|
72113
|
-
"description"
|
|
73671
|
+
"bin",
|
|
73672
|
+
"referenceNumber"
|
|
72114
73673
|
]
|
|
72115
73674
|
},
|
|
72116
73675
|
"compact": null,
|
|
72117
73676
|
"status": "tested"
|
|
72118
73677
|
},
|
|
72119
73678
|
{
|
|
72120
|
-
"id": "
|
|
72121
|
-
"resource": "
|
|
72122
|
-
"udfCapable":
|
|
72123
|
-
"operation": "resolve",
|
|
72124
|
-
"kind": "helper",
|
|
72125
|
-
"endpoint": null,
|
|
72126
|
-
"effect": "read",
|
|
72127
|
-
"flags": [],
|
|
72128
|
-
"dryRun": false,
|
|
72129
|
-
"envelope": null,
|
|
72130
|
-
"inputSchema": {
|
|
72131
|
-
"identifier": {
|
|
72132
|
-
"type": "string | number",
|
|
72133
|
-
"required": true,
|
|
72134
|
-
"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)."
|
|
72135
|
-
},
|
|
72136
|
-
"opts": {
|
|
72137
|
-
"type": "object",
|
|
72138
|
-
"required": false,
|
|
72139
|
-
"description": "ResolutionOpts — { expand?: boolean } (return the full record; a no-op where the Summary is a structural alias).",
|
|
72140
|
-
"properties": [
|
|
72141
|
-
{
|
|
72142
|
-
"name": "expand",
|
|
72143
|
-
"type": "boolean",
|
|
72144
|
-
"optional": true
|
|
72145
|
-
}
|
|
72146
|
-
]
|
|
72147
|
-
}
|
|
72148
|
-
},
|
|
72149
|
-
"inputSchemaStrict": true,
|
|
72150
|
-
"outputSchema": {
|
|
72151
|
-
"type": "ContractSummary",
|
|
72152
|
-
"drops": []
|
|
72153
|
-
},
|
|
72154
|
-
"examples": [
|
|
72155
|
-
"await client.contracts.resolve('example-value')"
|
|
72156
|
-
],
|
|
72157
|
-
"permissions": "unknown",
|
|
72158
|
-
"pagination": {
|
|
72159
|
-
"mode": "none"
|
|
72160
|
-
},
|
|
72161
|
-
"resolution": {
|
|
72162
|
-
"basis": "server-filter",
|
|
72163
|
-
"maxScanRecords": 500,
|
|
72164
|
-
"maxScanPages": 4
|
|
72165
|
-
},
|
|
72166
|
-
"retry": {
|
|
72167
|
-
"preset": "retry-ffb3a9cb"
|
|
72168
|
-
},
|
|
72169
|
-
"errors": {
|
|
72170
|
-
"set": 5
|
|
72171
|
-
},
|
|
72172
|
-
"metadata": {
|
|
72173
|
-
"purpose": "Resolve a contract from a numeric id (the direct fetch, tried first) or an exact value of its primary text field(s) (contractName — exact match only). Returns the Contract record with the numeric id for get/update/delete. Other identifier forms (e.g. an email address) are NOT tried by resolve — use the resource's dedicated lookup op where one exists (see autotask_catalog).",
|
|
72174
|
-
"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.",
|
|
72175
|
-
"preferredWhen": null,
|
|
72176
|
-
"related": [
|
|
72177
|
-
"contracts.get"
|
|
72178
|
-
],
|
|
72179
|
-
"untrustedFields": [
|
|
72180
|
-
"UDF1",
|
|
72181
|
-
"UDF10",
|
|
72182
|
-
"UDF11",
|
|
72183
|
-
"UDF12",
|
|
72184
|
-
"UDF13",
|
|
72185
|
-
"UDF14",
|
|
72186
|
-
"UDF15",
|
|
72187
|
-
"UDF16",
|
|
72188
|
-
"UDF17",
|
|
72189
|
-
"UDF18",
|
|
72190
|
-
"UDF19",
|
|
72191
|
-
"UDF2",
|
|
72192
|
-
"UDF20",
|
|
72193
|
-
"UDF3",
|
|
72194
|
-
"UDF4",
|
|
72195
|
-
"UDF5",
|
|
72196
|
-
"UDF6",
|
|
72197
|
-
"UDF7",
|
|
72198
|
-
"UDF8",
|
|
72199
|
-
"UDF9",
|
|
72200
|
-
"contactName",
|
|
72201
|
-
"contractName",
|
|
72202
|
-
"description"
|
|
72203
|
-
]
|
|
72204
|
-
},
|
|
72205
|
-
"compact": "ContractSummary",
|
|
72206
|
-
"status": "tested"
|
|
72207
|
-
},
|
|
72208
|
-
{
|
|
72209
|
-
"id": "contracts.search",
|
|
72210
|
-
"resource": "contracts",
|
|
72211
|
-
"udfCapable": true,
|
|
72212
|
-
"operation": "search",
|
|
72213
|
-
"kind": "helper",
|
|
72214
|
-
"endpoint": null,
|
|
72215
|
-
"effect": "read",
|
|
72216
|
-
"flags": [],
|
|
72217
|
-
"dryRun": false,
|
|
72218
|
-
"envelope": null,
|
|
72219
|
-
"inputSchema": {
|
|
72220
|
-
"query": {
|
|
72221
|
-
"type": "string",
|
|
72222
|
-
"required": true,
|
|
72223
|
-
"description": "The free text to match (contains) on the resource searchable fields."
|
|
72224
|
-
},
|
|
72225
|
-
"opts": {
|
|
72226
|
-
"type": "object",
|
|
72227
|
-
"required": false,
|
|
72228
|
-
"description": "SearchOpts — { limit?: number } (1-500, default 25).",
|
|
72229
|
-
"properties": [
|
|
72230
|
-
{
|
|
72231
|
-
"name": "limit",
|
|
72232
|
-
"type": "number",
|
|
72233
|
-
"optional": true
|
|
72234
|
-
}
|
|
72235
|
-
]
|
|
72236
|
-
}
|
|
72237
|
-
},
|
|
72238
|
-
"inputSchemaStrict": true,
|
|
72239
|
-
"outputSchema": {
|
|
72240
|
-
"type": "ContractSummary",
|
|
72241
|
-
"drops": []
|
|
72242
|
-
},
|
|
72243
|
-
"examples": [
|
|
72244
|
-
"await client.contracts.search('example')"
|
|
72245
|
-
],
|
|
72246
|
-
"permissions": "unknown",
|
|
72247
|
-
"pagination": {
|
|
72248
|
-
"mode": "none"
|
|
72249
|
-
},
|
|
72250
|
-
"resolution": {
|
|
72251
|
-
"basis": "server-filter",
|
|
72252
|
-
"maxScanRecords": 500,
|
|
72253
|
-
"maxScanPages": 4
|
|
72254
|
-
},
|
|
72255
|
-
"retry": {
|
|
72256
|
-
"preset": "retry-ffb3a9cb"
|
|
72257
|
-
},
|
|
72258
|
-
"errors": {
|
|
72259
|
-
"set": 5
|
|
72260
|
-
},
|
|
72261
|
-
"metadata": {
|
|
72262
|
-
"purpose": "Search contract records by text (contains on the searchable fields).",
|
|
72263
|
-
"usage": "Vendor exposes no free-text search; this is a bounded contains filter: contractName only (contains). limit defaults to 25, max 500.",
|
|
72264
|
-
"preferredWhen": null,
|
|
72265
|
-
"related": [
|
|
72266
|
-
"contracts.resolve",
|
|
72267
|
-
"contracts.query"
|
|
72268
|
-
],
|
|
72269
|
-
"untrustedFields": [
|
|
72270
|
-
"UDF1",
|
|
72271
|
-
"UDF10",
|
|
72272
|
-
"UDF11",
|
|
72273
|
-
"UDF12",
|
|
72274
|
-
"UDF13",
|
|
72275
|
-
"UDF14",
|
|
72276
|
-
"UDF15",
|
|
72277
|
-
"UDF16",
|
|
72278
|
-
"UDF17",
|
|
72279
|
-
"UDF18",
|
|
72280
|
-
"UDF19",
|
|
72281
|
-
"UDF2",
|
|
72282
|
-
"UDF20",
|
|
72283
|
-
"UDF3",
|
|
72284
|
-
"UDF4",
|
|
72285
|
-
"UDF5",
|
|
72286
|
-
"UDF6",
|
|
72287
|
-
"UDF7",
|
|
72288
|
-
"UDF8",
|
|
72289
|
-
"UDF9",
|
|
72290
|
-
"contactName",
|
|
72291
|
-
"contractName",
|
|
72292
|
-
"description"
|
|
72293
|
-
]
|
|
72294
|
-
},
|
|
72295
|
-
"compact": "ContractSummary",
|
|
72296
|
-
"status": "tested"
|
|
72297
|
-
},
|
|
72298
|
-
{
|
|
72299
|
-
"id": "contracts.update",
|
|
72300
|
-
"resource": "contracts",
|
|
72301
|
-
"udfCapable": true,
|
|
73679
|
+
"id": "inventory_items.update",
|
|
73680
|
+
"resource": "inventory_items",
|
|
73681
|
+
"udfCapable": false,
|
|
72302
73682
|
"operation": "update",
|
|
72303
73683
|
"kind": "primitive",
|
|
72304
|
-
"endpoint": "
|
|
73684
|
+
"endpoint": "PATCH /V1.0/InventoryItems",
|
|
72305
73685
|
"effect": "write",
|
|
72306
|
-
"flags": [
|
|
72307
|
-
"idempotent"
|
|
72308
|
-
],
|
|
73686
|
+
"flags": [],
|
|
72309
73687
|
"dryRun": true,
|
|
72310
73688
|
"envelope": "OperationResultModel",
|
|
72311
73689
|
"inputSchema": {
|
|
@@ -72326,7 +73704,7 @@ const CAPABILITY_DATA = {
|
|
|
72326
73704
|
"drops": []
|
|
72327
73705
|
},
|
|
72328
73706
|
"examples": [
|
|
72329
|
-
"await client.
|
|
73707
|
+
"await client.inventoryItems.update(7, { bin: 'A1' }, { dryRun: true })"
|
|
72330
73708
|
],
|
|
72331
73709
|
"permissions": "unknown",
|
|
72332
73710
|
"pagination": {
|
|
@@ -72334,47 +73712,24 @@ const CAPABILITY_DATA = {
|
|
|
72334
73712
|
},
|
|
72335
73713
|
"resolution": null,
|
|
72336
73714
|
"retry": {
|
|
72337
|
-
"preset": "retry-
|
|
73715
|
+
"preset": "retry-c5657094"
|
|
72338
73716
|
},
|
|
72339
73717
|
"errors": {
|
|
72340
|
-
"set":
|
|
73718
|
+
"set": 17
|
|
72341
73719
|
},
|
|
72342
73720
|
"metadata": {
|
|
72343
|
-
"purpose": "Update
|
|
72344
|
-
"usage": "
|
|
72345
|
-
"preferredWhen": "
|
|
73721
|
+
"purpose": "Update writable inventory item fields with collection PATCH.",
|
|
73722
|
+
"usage": "Inventory permissions and module access govern visibility and writes. Empty results do not establish tenant-wide absence. Records bind a product and an inventory location. The ID is supplied separately and travels in the PATCH body. Product and location are immutable. Min/max changes use fresh current bounds. On-hand changes require known picked and reserved counters and a fresh nonserialized product. A fresh preflight is not atomic and no timestamp is documented. No replacing PUT fallback or maintenance replay is issued.",
|
|
73723
|
+
"preferredWhen": "Use with a known item ID and only the writable fields that should change.",
|
|
72346
73724
|
"related": [
|
|
72347
|
-
"
|
|
73725
|
+
"inventory_items.get",
|
|
73726
|
+
"products.get"
|
|
72348
73727
|
],
|
|
72349
|
-
"collectionUpdate": true,
|
|
72350
73728
|
"untrustedFields": [
|
|
72351
|
-
"
|
|
72352
|
-
"
|
|
72353
|
-
"UDF11",
|
|
72354
|
-
"UDF12",
|
|
72355
|
-
"UDF13",
|
|
72356
|
-
"UDF14",
|
|
72357
|
-
"UDF15",
|
|
72358
|
-
"UDF16",
|
|
72359
|
-
"UDF17",
|
|
72360
|
-
"UDF18",
|
|
72361
|
-
"UDF19",
|
|
72362
|
-
"UDF2",
|
|
72363
|
-
"UDF20",
|
|
72364
|
-
"UDF3",
|
|
72365
|
-
"UDF4",
|
|
72366
|
-
"UDF5",
|
|
72367
|
-
"UDF6",
|
|
72368
|
-
"UDF7",
|
|
72369
|
-
"UDF8",
|
|
72370
|
-
"UDF9",
|
|
72371
|
-
"contactName",
|
|
72372
|
-
"contractName",
|
|
72373
|
-
"description"
|
|
73729
|
+
"bin",
|
|
73730
|
+
"referenceNumber"
|
|
72374
73731
|
],
|
|
72375
|
-
"
|
|
72376
|
-
"dateConventions": "date convention (verify against current field metadata): startDate and endDate are date-only at 00:00Z; tickets.dueDateTime is a true UTC instant."
|
|
72377
|
-
}
|
|
73732
|
+
"accountWide": true
|
|
72378
73733
|
},
|
|
72379
73734
|
"compact": null,
|
|
72380
73735
|
"status": "tested"
|
|
@@ -72478,7 +73833,7 @@ const CAPABILITY_DATA = {
|
|
|
72478
73833
|
"preset": "retry-c5657094"
|
|
72479
73834
|
},
|
|
72480
73835
|
"errors": {
|
|
72481
|
-
"set":
|
|
73836
|
+
"set": 19
|
|
72482
73837
|
},
|
|
72483
73838
|
"metadata": {
|
|
72484
73839
|
"purpose": "Create an inventory location.",
|
|
@@ -72804,7 +74159,7 @@ const CAPABILITY_DATA = {
|
|
|
72804
74159
|
"preset": "retry-ffb3a9cb"
|
|
72805
74160
|
},
|
|
72806
74161
|
"errors": {
|
|
72807
|
-
"set":
|
|
74162
|
+
"set": 20
|
|
72808
74163
|
},
|
|
72809
74164
|
"metadata": {
|
|
72810
74165
|
"purpose": "Query InventoryLocation records with a JSON filter.",
|
|
@@ -72863,7 +74218,7 @@ const CAPABILITY_DATA = {
|
|
|
72863
74218
|
"preset": "retry-c5657094"
|
|
72864
74219
|
},
|
|
72865
74220
|
"errors": {
|
|
72866
|
-
"set":
|
|
74221
|
+
"set": 21
|
|
72867
74222
|
},
|
|
72868
74223
|
"metadata": {
|
|
72869
74224
|
"purpose": "Update an inventory location.",
|
|
@@ -78133,7 +79488,7 @@ const CAPABILITY_DATA = {
|
|
|
78133
79488
|
"preset": "retry-ffb3a9cb"
|
|
78134
79489
|
},
|
|
78135
79490
|
"errors": {
|
|
78136
|
-
"set":
|
|
79491
|
+
"set": 15
|
|
78137
79492
|
},
|
|
78138
79493
|
"metadata": {
|
|
78139
79494
|
"purpose": "Get a project with its primary context records in one call.",
|
|
@@ -80740,7 +82095,7 @@ const CAPABILITY_DATA = {
|
|
|
80740
82095
|
"preset": "retry-ffb3a9cb"
|
|
80741
82096
|
},
|
|
80742
82097
|
"errors": {
|
|
80743
|
-
"set":
|
|
82098
|
+
"set": 12
|
|
80744
82099
|
},
|
|
80745
82100
|
"metadata": {
|
|
80746
82101
|
"purpose": "Get a quote with its line items in a single call — the items part is the bounded quoteID-filtered query.",
|
|
@@ -81684,7 +83039,7 @@ const CAPABILITY_DATA = {
|
|
|
81684
83039
|
"preset": "retry-c5657094"
|
|
81685
83040
|
},
|
|
81686
83041
|
"errors": {
|
|
81687
|
-
"set":
|
|
83042
|
+
"set": 19
|
|
81688
83043
|
},
|
|
81689
83044
|
"metadata": {
|
|
81690
83045
|
"purpose": "Create an attachment under a task.",
|
|
@@ -81756,7 +83111,7 @@ const CAPABILITY_DATA = {
|
|
|
81756
83111
|
"preset": "retry-1849870d"
|
|
81757
83112
|
},
|
|
81758
83113
|
"errors": {
|
|
81759
|
-
"set":
|
|
83114
|
+
"set": 22
|
|
81760
83115
|
},
|
|
81761
83116
|
"metadata": {
|
|
81762
83117
|
"purpose": "Delete an attachment under a task.",
|
|
@@ -82027,7 +83382,7 @@ const CAPABILITY_DATA = {
|
|
|
82027
83382
|
"preset": "retry-ffb3a9cb"
|
|
82028
83383
|
},
|
|
82029
83384
|
"errors": {
|
|
82030
|
-
"set":
|
|
83385
|
+
"set": 20
|
|
82031
83386
|
},
|
|
82032
83387
|
"metadata": {
|
|
82033
83388
|
"purpose": "Query TaskAttachment records with a JSON filter.",
|
|
@@ -90795,7 +92150,7 @@ const CAPABILITY_DATA = {
|
|
|
90795
92150
|
"preset": "retry-6980a375"
|
|
90796
92151
|
},
|
|
90797
92152
|
"errors": {
|
|
90798
|
-
"set":
|
|
92153
|
+
"set": 23
|
|
90799
92154
|
},
|
|
90800
92155
|
"metadata": {
|
|
90801
92156
|
"purpose": "Move a ticket to a target status in ONE op — the node validates targetStatus against the tenant's LIVE status picklist (entity metadata; vendor rejection is the fallback when the metadata is unavailable) + the live-discovered per-status required-field map and fills the proven-safe defaults itself (the vendor 500s when a target status has unsatisfied field requirements; the MCP LLM has no way to know the map).",
|
|
@@ -91200,7 +92555,7 @@ const CAPABILITY_DATA = {
|
|
|
91200
92555
|
"preset": "retry-ffb3a9cb"
|
|
91201
92556
|
},
|
|
91202
92557
|
"errors": {
|
|
91203
|
-
"set":
|
|
92558
|
+
"set": 24
|
|
91204
92559
|
},
|
|
91205
92560
|
"metadata": {
|
|
91206
92561
|
"purpose": "List the tickets a resource is assigned to — as primary owner, as a secondary resource, or both — de-duplicated, with the four reconciling counts and an optional open-only filter that uses the tenant's own closed-status set.",
|
|
@@ -91331,7 +92686,7 @@ const CAPABILITY_DATA = {
|
|
|
91331
92686
|
"preset": "retry-ffb3a9cb"
|
|
91332
92687
|
},
|
|
91333
92688
|
"errors": {
|
|
91334
|
-
"set":
|
|
92689
|
+
"set": 16
|
|
91335
92690
|
},
|
|
91336
92691
|
"metadata": {
|
|
91337
92692
|
"purpose": "Get the full context of one ticket in a single call: the ticket, its company, contact, assigned resource and project, plus its notes, time entries, attachment metadata and (opt-in) histories — every part separately reported.",
|
|
@@ -91536,7 +92891,7 @@ const CAPABILITY_DATA = {
|
|
|
91536
92891
|
"preset": "retry-ffb3a9cb"
|
|
91537
92892
|
},
|
|
91538
92893
|
"errors": {
|
|
91539
|
-
"set":
|
|
92894
|
+
"set": 15
|
|
91540
92895
|
},
|
|
91541
92896
|
"metadata": {
|
|
91542
92897
|
"purpose": "Get a ticket with its primary context records in one call.",
|
|
@@ -91855,7 +93210,7 @@ const CAPABILITY_DATA = {
|
|
|
91855
93210
|
"preset": "retry-ffb3a9cb"
|
|
91856
93211
|
},
|
|
91857
93212
|
"errors": {
|
|
91858
|
-
"set":
|
|
93213
|
+
"set": 16
|
|
91859
93214
|
},
|
|
91860
93215
|
"metadata": {
|
|
91861
93216
|
"purpose": "Get the full Line of Business chain for one ticket in a single call: the association, the OrganizationalLevel2 (the customizable 'Line of Business' label) and the OrganizationalLevel1 (the division).",
|
|
@@ -92293,7 +93648,7 @@ const CAPABILITY_DATA = {
|
|
|
92293
93648
|
"preset": "retry-ffb3a9cb"
|
|
92294
93649
|
},
|
|
92295
93650
|
"errors": {
|
|
92296
|
-
"set":
|
|
93651
|
+
"set": 15
|
|
92297
93652
|
},
|
|
92298
93653
|
"metadata": {
|
|
92299
93654
|
"purpose": "Run the SLA health check for a ticket (numeric ticket id).",
|
|
@@ -92390,7 +93745,7 @@ const CAPABILITY_DATA = {
|
|
|
92390
93745
|
"preset": "retry-ffb3a9cb"
|
|
92391
93746
|
},
|
|
92392
93747
|
"errors": {
|
|
92393
|
-
"set":
|
|
93748
|
+
"set": 25
|
|
92394
93749
|
},
|
|
92395
93750
|
"metadata": {
|
|
92396
93751
|
"purpose": "Report the ticket status picklist and the ids this SDK treats as CLOSED for the caller's tenant, with the provenance of that set (read from the tenant's picklist, or the documented assumed fallback).",
|
|
@@ -92488,7 +93843,7 @@ const CAPABILITY_DATA = {
|
|
|
92488
93843
|
"preset": "retry-ffb3a9cb"
|
|
92489
93844
|
},
|
|
92490
93845
|
"errors": {
|
|
92491
|
-
"set":
|
|
93846
|
+
"set": 15
|
|
92492
93847
|
},
|
|
92493
93848
|
"metadata": {
|
|
92494
93849
|
"purpose": "Get a one-call summary of a ticket (numeric ticket id).",
|
|
@@ -92598,7 +93953,7 @@ const CAPABILITY_DATA = {
|
|
|
92598
93953
|
"preset": "retry-ffb3a9cb"
|
|
92599
93954
|
},
|
|
92600
93955
|
"errors": {
|
|
92601
|
-
"set":
|
|
93956
|
+
"set": 15
|
|
92602
93957
|
},
|
|
92603
93958
|
"metadata": {
|
|
92604
93959
|
"purpose": "Get the event timeline of a ticket (numeric ticket id).",
|
|
@@ -92749,8 +94104,8 @@ const CAPABILITY_DATA = {
|
|
|
92749
94104
|
]
|
|
92750
94105
|
},
|
|
92751
94106
|
"operations": {
|
|
92752
|
-
"planHash": "
|
|
92753
|
-
"builtAt": "2026-11-
|
|
94107
|
+
"planHash": "21e75d0f8bf9986b21c6b7996dfb1fec78b3aaa9afa86f50f5351c54c733d4ac",
|
|
94108
|
+
"builtAt": "2026-11-21T07:49:35.531Z",
|
|
92754
94109
|
"records": [
|
|
92755
94110
|
{
|
|
92756
94111
|
"id": "operations.aggregate",
|
|
@@ -92833,7 +94188,7 @@ const CAPABILITY_DATA = {
|
|
|
92833
94188
|
"preset": "retry-ffb3a9cb"
|
|
92834
94189
|
},
|
|
92835
94190
|
"errors": {
|
|
92836
|
-
"set":
|
|
94191
|
+
"set": 26
|
|
92837
94192
|
},
|
|
92838
94193
|
"metadata": {
|
|
92839
94194
|
"purpose": "Fold any query surface into groups/sums/totals in one bounded call — or count it with the vendor count endpoint when no folding is needed — with blind-surface and truncation honesty (caps documented: the walk scans at most 2500 rows and top keeps at most 100 groups — a truncated aggregate is a PARTIAL answer, never a tenant-wide total); date fields bucket via the closed groupBy suffix <field>@month | @week | @year (ISO labels, UTC-anchored). Use it for totals, sums, counts and hours per ticket, resource, company, contract or month (group by any field), e.g. time entries hours grouped by ticket and resource",
|
|
@@ -92867,6 +94222,7 @@ const CAPABILITY_DATA = {
|
|
|
92867
94222
|
"UDF8",
|
|
92868
94223
|
"UDF9",
|
|
92869
94224
|
"action",
|
|
94225
|
+
"additionalAddressInfo",
|
|
92870
94226
|
"additionalBillToAddressInformation",
|
|
92871
94227
|
"additionalShipToAddressInformation",
|
|
92872
94228
|
"alertText",
|
|
@@ -92887,6 +94243,7 @@ const CAPABILITY_DATA = {
|
|
|
92887
94243
|
"contactName",
|
|
92888
94244
|
"contractName",
|
|
92889
94245
|
"costType",
|
|
94246
|
+
"country",
|
|
92890
94247
|
"coveredByBlockRetainerContractLabel",
|
|
92891
94248
|
"coveredByRecurringServiceFixedPricePerTicketContractLabel",
|
|
92892
94249
|
"data",
|
|
@@ -92965,6 +94322,7 @@ const CAPABILITY_DATA = {
|
|
|
92965
94322
|
"templateName",
|
|
92966
94323
|
"ticketTitle",
|
|
92967
94324
|
"timeFormat",
|
|
94325
|
+
"timeZone",
|
|
92968
94326
|
"title",
|
|
92969
94327
|
"travelAvailabilityPct",
|
|
92970
94328
|
"userName",
|
|
@@ -93041,7 +94399,7 @@ const CAPABILITY_DATA = {
|
|
|
93041
94399
|
"preset": "retry-ffb3a9cb"
|
|
93042
94400
|
},
|
|
93043
94401
|
"errors": {
|
|
93044
|
-
"set":
|
|
94402
|
+
"set": 27
|
|
93045
94403
|
},
|
|
93046
94404
|
"metadata": {
|
|
93047
94405
|
"purpose": "Accounts-receivable aging at a point in time, in one budgeted call: open invoices per company bucketed by days past due (current, 1-30, 31-60, 61-90, over 90, no due date), with totals per currency.",
|
|
@@ -93107,7 +94465,7 @@ const CAPABILITY_DATA = {
|
|
|
93107
94465
|
"preset": "retry-ffb3a9cb"
|
|
93108
94466
|
},
|
|
93109
94467
|
"errors": {
|
|
93110
|
-
"set":
|
|
94468
|
+
"set": 28
|
|
93111
94469
|
},
|
|
93112
94470
|
"metadata": {
|
|
93113
94471
|
"purpose": "Read static creation requirements, prior validation findings and unproven input guidance. This is not a live test of current-tenant capability, inventory or permissions.",
|
|
@@ -93158,7 +94516,7 @@ const CAPABILITY_DATA = {
|
|
|
93158
94516
|
"preset": "retry-ffb3a9cb"
|
|
93159
94517
|
},
|
|
93160
94518
|
"errors": {
|
|
93161
|
-
"set":
|
|
94519
|
+
"set": 16
|
|
93162
94520
|
},
|
|
93163
94521
|
"metadata": {
|
|
93164
94522
|
"purpose": "Resolve resource ids to display names in one opt-in call: per-id resources.get reads (never an id-in query) with blind-marked rows for ids the API user cannot resolve served from the read cache (each distinct id fetched at most once per cache lifetime).",
|
|
@@ -93210,7 +94568,7 @@ const CAPABILITY_DATA = {
|
|
|
93210
94568
|
"preset": "retry-ffb3a9cb"
|
|
93211
94569
|
},
|
|
93212
94570
|
"errors": {
|
|
93213
|
-
"set":
|
|
94571
|
+
"set": 16
|
|
93214
94572
|
},
|
|
93215
94573
|
"metadata": {
|
|
93216
94574
|
"purpose": "Fetch up to 500 single records by id across mixed resources in one call (query-first chunked id-in reads with a per-id get fallback), with per-item typed results.",
|
|
@@ -93244,6 +94602,7 @@ const CAPABILITY_DATA = {
|
|
|
93244
94602
|
"UDF8",
|
|
93245
94603
|
"UDF9",
|
|
93246
94604
|
"action",
|
|
94605
|
+
"additionalAddressInfo",
|
|
93247
94606
|
"additionalBillToAddressInformation",
|
|
93248
94607
|
"additionalShipToAddressInformation",
|
|
93249
94608
|
"alertText",
|
|
@@ -93264,6 +94623,7 @@ const CAPABILITY_DATA = {
|
|
|
93264
94623
|
"contactName",
|
|
93265
94624
|
"contractName",
|
|
93266
94625
|
"costType",
|
|
94626
|
+
"country",
|
|
93267
94627
|
"coveredByBlockRetainerContractLabel",
|
|
93268
94628
|
"coveredByRecurringServiceFixedPricePerTicketContractLabel",
|
|
93269
94629
|
"data",
|
|
@@ -93342,6 +94702,7 @@ const CAPABILITY_DATA = {
|
|
|
93342
94702
|
"templateName",
|
|
93343
94703
|
"ticketTitle",
|
|
93344
94704
|
"timeFormat",
|
|
94705
|
+
"timeZone",
|
|
93345
94706
|
"title",
|
|
93346
94707
|
"travelAvailabilityPct",
|
|
93347
94708
|
"userName",
|
|
@@ -93430,7 +94791,7 @@ const CAPABILITY_DATA = {
|
|
|
93430
94791
|
"preset": "retry-ffb3a9cb"
|
|
93431
94792
|
},
|
|
93432
94793
|
"errors": {
|
|
93433
|
-
"set":
|
|
94794
|
+
"set": 29
|
|
93434
94795
|
},
|
|
93435
94796
|
"metadata": {
|
|
93436
94797
|
"purpose": "Fetch the LIVE vendor field catalog for the named resources in one bounded read call: which fields exist, which are required, types, maxLength, read-only, queryable, picklist-ness — the on-demand refresh for the point-in-time pins (operations.createGuidance, the zoneFacts) when the vendor has moved since they were verified. The wire cost (resources × include) is refused pre-request above the cap, never truncated; with the opt-in fieldCache configured, repeat reads inside the TTL cost no wire. It reports picklist-ness as a flag (isPickList) and picklist field NAMES (picklistFields); with the opt-in labels: true the projected picklist rows carry the vendor's exposed picklist VALUES (labels next to each value), and without it the op serves no VALUES. A picklist VALUE the vendor does not expose to this API user is not resolvable from this catalog.",
|
|
@@ -93527,7 +94888,7 @@ const CAPABILITY_DATA = {
|
|
|
93527
94888
|
"preset": "retry-ffb3a9cb"
|
|
93528
94889
|
},
|
|
93529
94890
|
"errors": {
|
|
93530
|
-
"set":
|
|
94891
|
+
"set": 27
|
|
93531
94892
|
},
|
|
93532
94893
|
"metadata": {
|
|
93533
94894
|
"purpose": "Non-chargeable work in one budgeted call: non-billable and contract-covered billing items (value, labour hours, lines) per company, contract or contract type, posted or invoiced or not.",
|
|
@@ -93644,7 +95005,7 @@ const CAPABILITY_DATA = {
|
|
|
93644
95005
|
"preset": "retry-ffb3a9cb"
|
|
93645
95006
|
},
|
|
93646
95007
|
"errors": {
|
|
93647
|
-
"set":
|
|
95008
|
+
"set": 30
|
|
93648
95009
|
},
|
|
93649
95010
|
"metadata": {
|
|
93650
95011
|
"purpose": "Contract profit and margin grouped by contract, company, contract type, vertical or month over a window, in one budgeted call: a contracts.profitability fan-out with totals and per-contract coverage gaps.",
|
|
@@ -93734,7 +95095,7 @@ const CAPABILITY_DATA = {
|
|
|
93734
95095
|
"preset": "retry-ffb3a9cb"
|
|
93735
95096
|
},
|
|
93736
95097
|
"errors": {
|
|
93737
|
-
"set":
|
|
95098
|
+
"set": 27
|
|
93738
95099
|
},
|
|
93739
95100
|
"metadata": {
|
|
93740
95101
|
"purpose": "Monthly recurring revenue at a point in time per company, in one budgeted call: contract services, subscriptions and the month's contract charges (usage billing, counted as recurring revenue) reported apart, plus the contracts ending soon.",
|
|
@@ -93789,7 +95150,7 @@ const CAPABILITY_DATA = {
|
|
|
93789
95150
|
"preset": "retry-ffb3a9cb"
|
|
93790
95151
|
},
|
|
93791
95152
|
"errors": {
|
|
93792
|
-
"set":
|
|
95153
|
+
"set": 28
|
|
93793
95154
|
},
|
|
93794
95155
|
"metadata": {
|
|
93795
95156
|
"purpose": "Describe a resource’s SDK-covered parent/child operations, lookup keys and static create guidance without a vendor call. Current-user visibility and tenant inventory require live reads.",
|
|
@@ -93897,6 +95258,7 @@ const CAPABILITY_DATA = {
|
|
|
93897
95258
|
"UDF8",
|
|
93898
95259
|
"UDF9",
|
|
93899
95260
|
"action",
|
|
95261
|
+
"additionalAddressInfo",
|
|
93900
95262
|
"additionalBillToAddressInformation",
|
|
93901
95263
|
"additionalShipToAddressInformation",
|
|
93902
95264
|
"alertText",
|
|
@@ -93917,6 +95279,7 @@ const CAPABILITY_DATA = {
|
|
|
93917
95279
|
"contactName",
|
|
93918
95280
|
"contractName",
|
|
93919
95281
|
"costType",
|
|
95282
|
+
"country",
|
|
93920
95283
|
"coveredByBlockRetainerContractLabel",
|
|
93921
95284
|
"coveredByRecurringServiceFixedPricePerTicketContractLabel",
|
|
93922
95285
|
"data",
|
|
@@ -93995,6 +95358,7 @@ const CAPABILITY_DATA = {
|
|
|
93995
95358
|
"templateName",
|
|
93996
95359
|
"ticketTitle",
|
|
93997
95360
|
"timeFormat",
|
|
95361
|
+
"timeZone",
|
|
93998
95362
|
"title",
|
|
93999
95363
|
"travelAvailabilityPct",
|
|
94000
95364
|
"userName",
|
|
@@ -94206,7 +95570,7 @@ const CAPABILITY_DATA = {
|
|
|
94206
95570
|
"preset": "retry-ffb3a9cb"
|
|
94207
95571
|
},
|
|
94208
95572
|
"errors": {
|
|
94209
|
-
"set":
|
|
95573
|
+
"set": 27
|
|
94210
95574
|
},
|
|
94211
95575
|
"metadata": {
|
|
94212
95576
|
"purpose": "Total revenue grouped by account vertical, contract type, company, contract, month or line of business over an invoice-date window, in one budgeted call with totals, excluded buckets, a reconciliation and optional non-chargeable work.",
|
|
@@ -94266,7 +95630,7 @@ const CAPABILITY_DATA = {
|
|
|
94266
95630
|
"preset": "retry-ffb3a9cb"
|
|
94267
95631
|
},
|
|
94268
95632
|
"errors": {
|
|
94269
|
-
"set":
|
|
95633
|
+
"set": 31
|
|
94270
95634
|
},
|
|
94271
95635
|
"metadata": {
|
|
94272
95636
|
"purpose": "Fence the vendor free text of a raw SDK read result in the untrusted-content markers, using the operation's own registry record as the field authority.",
|
|
@@ -94373,6 +95737,7 @@ const CAPABILITY_DATA = {
|
|
|
94373
95737
|
"UDF8",
|
|
94374
95738
|
"UDF9",
|
|
94375
95739
|
"action",
|
|
95740
|
+
"additionalAddressInfo",
|
|
94376
95741
|
"additionalBillToAddressInformation",
|
|
94377
95742
|
"additionalShipToAddressInformation",
|
|
94378
95743
|
"alertText",
|
|
@@ -94393,6 +95758,7 @@ const CAPABILITY_DATA = {
|
|
|
94393
95758
|
"contactName",
|
|
94394
95759
|
"contractName",
|
|
94395
95760
|
"costType",
|
|
95761
|
+
"country",
|
|
94396
95762
|
"coveredByBlockRetainerContractLabel",
|
|
94397
95763
|
"coveredByRecurringServiceFixedPricePerTicketContractLabel",
|
|
94398
95764
|
"data",
|
|
@@ -94471,6 +95837,7 @@ const CAPABILITY_DATA = {
|
|
|
94471
95837
|
"templateName",
|
|
94472
95838
|
"ticketTitle",
|
|
94473
95839
|
"timeFormat",
|
|
95840
|
+
"timeZone",
|
|
94474
95841
|
"title",
|
|
94475
95842
|
"travelAvailabilityPct",
|
|
94476
95843
|
"userName",
|
|
@@ -94539,7 +95906,7 @@ const CAPABILITY_DATA = {
|
|
|
94539
95906
|
"preset": "retry-ffb3a9cb"
|
|
94540
95907
|
},
|
|
94541
95908
|
"errors": {
|
|
94542
|
-
"set":
|
|
95909
|
+
"set": 31
|
|
94543
95910
|
},
|
|
94544
95911
|
"metadata": {
|
|
94545
95912
|
"purpose": "Build a clickable Autotask UI deep link for a record in one ZERO-wire call, e.g. for the time entry or ticket a response is about.",
|
|
@@ -94630,7 +95997,7 @@ const CAPABILITY_DATA = {
|
|
|
94630
95997
|
"preset": "retry-ffb3a9cb"
|
|
94631
95998
|
},
|
|
94632
95999
|
"errors": {
|
|
94633
|
-
"set":
|
|
96000
|
+
"set": 32
|
|
94634
96001
|
},
|
|
94635
96002
|
"metadata": {
|
|
94636
96003
|
"purpose": "Work in progress in one budgeted call: billable time entries no billing item references yet (unposted), in hours, per company, resource or contract type, split approved / unapproved where the tenant records approval.",
|