node-autotask 0.81.0 → 0.83.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +12 -0
- package/MCP_TOOL_CATALOG.json +393 -9
- package/README.md +1 -1
- package/capabilities.json +1663 -235
- package/dist/capabilities-data.js +1662 -234
- package/dist/capabilities.cjs +4 -4
- package/dist/capabilities.js +1 -1
- package/dist/{chunk-6HMGV3MY.cjs → chunk-5AHEJCSP.cjs} +33 -30
- package/dist/{chunk-MR5TGVHR.cjs → chunk-C2AFRW5M.cjs} +453 -10
- package/dist/{chunk-ACF32I5D.js → chunk-CV56RIGS.js} +448 -5
- package/dist/{chunk-5MJZ554M.js → chunk-DBEAS3IR.js} +3 -3
- package/dist/{chunk-X7G4W5DF.js → chunk-HQJLIRXW.js} +5 -2
- package/dist/{chunk-PLERXELA.cjs → chunk-QCA5R7QF.cjs} +3 -3
- package/dist/{chunk-KKUBJRO3.cjs → chunk-QEMBBAF5.cjs} +199 -199
- package/dist/{chunk-LCUUFTYD.js → chunk-ZKAJVHHZ.js} +2 -2
- package/dist/{index-lj8ocwxy.d.cts → index-8Hg6dytT.d.cts} +131 -1
- package/dist/{index-lj8ocwxy.d.ts → index-8Hg6dytT.d.ts} +131 -1
- package/dist/{index-BxPqypDD.d.cts → index-DxESlIIg.d.cts} +5 -2
- package/dist/{index-DswDMDNH.d.ts → index-nXhYAQOf.d.ts} +5 -2
- package/dist/index.cjs +84 -84
- package/dist/index.d.cts +3 -3
- package/dist/index.d.ts +3 -3
- package/dist/index.js +5 -5
- package/dist/operations/index.cjs +51 -51
- package/dist/operations/index.d.cts +4 -4
- package/dist/operations/index.d.ts +4 -4
- package/dist/operations/index.js +2 -2
- package/dist/pool.cjs +12 -12
- package/dist/pool.d.cts +1 -1
- package/dist/pool.d.ts +1 -1
- package/dist/pool.js +4 -4
- package/dist/resources/index.cjs +27 -27
- package/dist/resources/index.d.cts +2 -2
- package/dist/resources/index.d.ts +2 -2
- package/dist/resources/index.js +3 -3
- package/dist/types/index.d.cts +1 -1
- package/dist/types/index.d.ts +1 -1
- package/docs/API.md +5 -2
- package/package.json +1 -1
package/capabilities.json
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
{
|
|
2
|
-
"generatedAt": "2026-11-
|
|
2
|
+
"generatedAt": "2026-11-19T12:16:58.744Z",
|
|
3
3
|
"groups": {
|
|
4
4
|
"B": {
|
|
5
|
-
"planHash": "
|
|
6
|
-
"builtAt": "2026-11-
|
|
5
|
+
"planHash": "d758816a699191e3da784f70f8ebe1f37ea9458aaf528241770f7bac94ba6ede",
|
|
6
|
+
"builtAt": "2026-11-19T12:16:58.731Z",
|
|
7
7
|
"records": [
|
|
8
8
|
{
|
|
9
9
|
"id": "appointments.count",
|
|
@@ -13121,6 +13121,482 @@
|
|
|
13121
13121
|
"compact": null,
|
|
13122
13122
|
"status": "tested"
|
|
13123
13123
|
},
|
|
13124
|
+
{
|
|
13125
|
+
"id": "expense_report_attachments.count",
|
|
13126
|
+
"resource": "expense_report_attachments",
|
|
13127
|
+
"udfCapable": false,
|
|
13128
|
+
"operation": "count",
|
|
13129
|
+
"kind": "primitive",
|
|
13130
|
+
"endpoint": "GET|POST /V1.0/ExpenseReportAttachments/query/count",
|
|
13131
|
+
"effect": "read",
|
|
13132
|
+
"flags": [],
|
|
13133
|
+
"dryRun": false,
|
|
13134
|
+
"envelope": "QueryCountResultModel",
|
|
13135
|
+
"inputSchema": {
|
|
13136
|
+
"params": {
|
|
13137
|
+
"type": "object",
|
|
13138
|
+
"required": false,
|
|
13139
|
+
"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.",
|
|
13140
|
+
"properties": [
|
|
13141
|
+
{
|
|
13142
|
+
"name": "filter",
|
|
13143
|
+
"type": "FilterCondition[]",
|
|
13144
|
+
"optional": true
|
|
13145
|
+
},
|
|
13146
|
+
{
|
|
13147
|
+
"name": "fieldCheck",
|
|
13148
|
+
"type": "boolean",
|
|
13149
|
+
"optional": true
|
|
13150
|
+
}
|
|
13151
|
+
]
|
|
13152
|
+
}
|
|
13153
|
+
},
|
|
13154
|
+
"inputSchemaStrict": true,
|
|
13155
|
+
"outputSchema": {
|
|
13156
|
+
"type": "QueryCountResultModel",
|
|
13157
|
+
"drops": []
|
|
13158
|
+
},
|
|
13159
|
+
"examples": [
|
|
13160
|
+
"await invoke(client, 'expense_report_attachments.count', [{ filter: [{ field: 'expenseReportID', op: 'eq', value: 7 }] }])"
|
|
13161
|
+
],
|
|
13162
|
+
"permissions": "unknown",
|
|
13163
|
+
"pagination": {
|
|
13164
|
+
"mode": "none"
|
|
13165
|
+
},
|
|
13166
|
+
"resolution": null,
|
|
13167
|
+
"retry": {
|
|
13168
|
+
"preset": "retry-ffb3a9cb"
|
|
13169
|
+
},
|
|
13170
|
+
"errors": {
|
|
13171
|
+
"set": 0
|
|
13172
|
+
},
|
|
13173
|
+
"metadata": {
|
|
13174
|
+
"purpose": "Count expense report attachment records matching a JSON filter. Use expenseReportID for parent scope.",
|
|
13175
|
+
"usage": "Unwraps queryCount; returns a plain number. Include an object-specific expenseReportID filter. expenseReportID identifies the expense report parent, not the attachment author. creatorType, data and fileSize are not queryable. Report queries include attachments parented to ExpenseItems under the report; expenseItemID is a read-only child association, not a writable attachment target. A child item cannot establish company ownership of the whole report. Exact direct-parent deduplication and scoped/global list parity are unproven; an empty result is conditional on API-user permissions and visibility.",
|
|
13176
|
+
"preferredWhen": null,
|
|
13177
|
+
"related": [
|
|
13178
|
+
"expense_report_attachments.query"
|
|
13179
|
+
],
|
|
13180
|
+
"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.",
|
|
13181
|
+
"untrustedFields": [
|
|
13182
|
+
"title"
|
|
13183
|
+
]
|
|
13184
|
+
},
|
|
13185
|
+
"compact": null,
|
|
13186
|
+
"status": "tested"
|
|
13187
|
+
},
|
|
13188
|
+
{
|
|
13189
|
+
"id": "expense_report_attachments.create",
|
|
13190
|
+
"resource": "expense_report_attachments",
|
|
13191
|
+
"udfCapable": false,
|
|
13192
|
+
"operation": "create",
|
|
13193
|
+
"kind": "primitive",
|
|
13194
|
+
"endpoint": "POST /V1.0/ExpenseReports/{parentId}/Attachments",
|
|
13195
|
+
"effect": "write",
|
|
13196
|
+
"flags": [],
|
|
13197
|
+
"dryRun": true,
|
|
13198
|
+
"envelope": "OperationResultModel",
|
|
13199
|
+
"inputSchema": {
|
|
13200
|
+
"parentId": {
|
|
13201
|
+
"type": "string | number",
|
|
13202
|
+
"required": true,
|
|
13203
|
+
"description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
|
|
13204
|
+
},
|
|
13205
|
+
"data": {
|
|
13206
|
+
"type": "object",
|
|
13207
|
+
"required": true,
|
|
13208
|
+
"description": "The record payload (vendor model fields)."
|
|
13209
|
+
}
|
|
13210
|
+
},
|
|
13211
|
+
"inputSchemaStrict": true,
|
|
13212
|
+
"outputSchema": {
|
|
13213
|
+
"type": "OperationResultModel",
|
|
13214
|
+
"drops": []
|
|
13215
|
+
},
|
|
13216
|
+
"examples": [
|
|
13217
|
+
"const fields = await client.expenseReportAttachments.getFieldInfo();\nconst values = fields.find(field => field.name === 'publish')?.picklistValues?.filter(value => value.isActive === true && /^-?\\d+$/.test(value.value) && Number.isSafeInteger(Number(value.value)));\nif (!values?.length) throw new Error('No active numeric publish value is exposed');\nawait client.expenseReportAttachments.create(7, { attachmentType: 'FILE_ATTACHMENT', fullPath: 'note.txt', title: 'Supporting note', publish: Number(values[0].value), data: 'bm90ZQ==' }, { dryRun: true });"
|
|
13218
|
+
],
|
|
13219
|
+
"permissions": "unknown",
|
|
13220
|
+
"pagination": {
|
|
13221
|
+
"mode": "none"
|
|
13222
|
+
},
|
|
13223
|
+
"resolution": null,
|
|
13224
|
+
"retry": {
|
|
13225
|
+
"preset": "retry-c5657094"
|
|
13226
|
+
},
|
|
13227
|
+
"errors": {
|
|
13228
|
+
"set": 1
|
|
13229
|
+
},
|
|
13230
|
+
"metadata": {
|
|
13231
|
+
"purpose": "Create a file attachment under an expense report.",
|
|
13232
|
+
"usage": "Create a file under ExpenseReports/{parentId}/Attachments; parentId is the expense report ID. Required: explicit FILE_ATTACHMENT, title/fullPath (at most 255 characters), numeric publish from current metadata and base64 data. Existing attachments cannot be updated. expenseReportID and audit fields are response associations, not writable links. Vendor file/type limits and permissions apply: individual file limit 6–7 MB, 10,000,000 bytes per five minutes and a five-minute creation pause when exceeded. Contact author override and nested attachment creation are unsupported for this parent. Resource impersonation uses the configured header. Exact-parent deduplication is unproven; createIfNotExists is unsupported. No live create is claimed.",
|
|
13233
|
+
"preferredWhen": "Add a new attachment; existing attachments cannot be updated. Replace through separately governed delete and create actions.",
|
|
13234
|
+
"related": [
|
|
13235
|
+
"expense_report_attachments.get"
|
|
13236
|
+
],
|
|
13237
|
+
"argNotes": {
|
|
13238
|
+
"data": "File uploads only: attachmentType, data, fullPath, publish and title. expenseReportID/expenseItemID, contact/resource author and audit fields, contentType and fileSize are not create inputs. No parentAttachmentID, nested attachment or UDF writes. This is a supported FILE_ATTACHMENT subset; permissions and other vendor validation remain authoritative."
|
|
13239
|
+
},
|
|
13240
|
+
"untrustedFields": [
|
|
13241
|
+
"title"
|
|
13242
|
+
],
|
|
13243
|
+
"createRequirements": {
|
|
13244
|
+
"requires": {
|
|
13245
|
+
"allOf": [
|
|
13246
|
+
"attachmentType",
|
|
13247
|
+
"fullPath",
|
|
13248
|
+
"title",
|
|
13249
|
+
"publish",
|
|
13250
|
+
"data"
|
|
13251
|
+
]
|
|
13252
|
+
},
|
|
13253
|
+
"requiresByValue": [
|
|
13254
|
+
{
|
|
13255
|
+
"field": "attachmentType",
|
|
13256
|
+
"value": "FILE_ATTACHMENT",
|
|
13257
|
+
"requires": {
|
|
13258
|
+
"allOf": [
|
|
13259
|
+
"data"
|
|
13260
|
+
]
|
|
13261
|
+
}
|
|
13262
|
+
}
|
|
13263
|
+
]
|
|
13264
|
+
}
|
|
13265
|
+
},
|
|
13266
|
+
"compact": null,
|
|
13267
|
+
"status": "tested"
|
|
13268
|
+
},
|
|
13269
|
+
{
|
|
13270
|
+
"id": "expense_report_attachments.delete",
|
|
13271
|
+
"resource": "expense_report_attachments",
|
|
13272
|
+
"udfCapable": false,
|
|
13273
|
+
"operation": "delete",
|
|
13274
|
+
"kind": "primitive",
|
|
13275
|
+
"endpoint": "DELETE /V1.0/ExpenseReports/{parentId}/Attachments/{id}",
|
|
13276
|
+
"effect": "destructive",
|
|
13277
|
+
"flags": [
|
|
13278
|
+
"idempotent",
|
|
13279
|
+
"requiresApproval"
|
|
13280
|
+
],
|
|
13281
|
+
"dryRun": true,
|
|
13282
|
+
"envelope": "OperationResultModel (attachment entities: the deleted attachment model is returned, not OperationResultModel)",
|
|
13283
|
+
"inputSchema": {
|
|
13284
|
+
"parentId": {
|
|
13285
|
+
"type": "string | number",
|
|
13286
|
+
"required": true,
|
|
13287
|
+
"description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
|
|
13288
|
+
},
|
|
13289
|
+
"id": {
|
|
13290
|
+
"type": "string | number",
|
|
13291
|
+
"required": true,
|
|
13292
|
+
"description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
|
|
13293
|
+
}
|
|
13294
|
+
},
|
|
13295
|
+
"inputSchemaStrict": true,
|
|
13296
|
+
"outputSchema": {
|
|
13297
|
+
"type": "OperationResultModel (attachment entities: the deleted attachment model is returned, not OperationResultModel)",
|
|
13298
|
+
"drops": []
|
|
13299
|
+
},
|
|
13300
|
+
"examples": [
|
|
13301
|
+
"await invoke(client, 'expense_report_attachments.delete', [7, 3], { confirm: 'expense_report_attachments.delete' })"
|
|
13302
|
+
],
|
|
13303
|
+
"permissions": "unknown",
|
|
13304
|
+
"pagination": {
|
|
13305
|
+
"mode": "none"
|
|
13306
|
+
},
|
|
13307
|
+
"resolution": null,
|
|
13308
|
+
"retry": {
|
|
13309
|
+
"preset": "retry-1849870d"
|
|
13310
|
+
},
|
|
13311
|
+
"errors": {
|
|
13312
|
+
"set": 2
|
|
13313
|
+
},
|
|
13314
|
+
"metadata": {
|
|
13315
|
+
"purpose": "Delete an attachment under an expense report.",
|
|
13316
|
+
"usage": "Irreversible; dry-run validates the target id first. Parent-scoped: parentId + id.",
|
|
13317
|
+
"preferredWhen": null,
|
|
13318
|
+
"related": [
|
|
13319
|
+
"expense_report_attachments.get"
|
|
13320
|
+
],
|
|
13321
|
+
"untrustedFields": [
|
|
13322
|
+
"title"
|
|
13323
|
+
]
|
|
13324
|
+
},
|
|
13325
|
+
"compact": null,
|
|
13326
|
+
"status": "tested"
|
|
13327
|
+
},
|
|
13328
|
+
{
|
|
13329
|
+
"id": "expense_report_attachments.get",
|
|
13330
|
+
"resource": "expense_report_attachments",
|
|
13331
|
+
"udfCapable": false,
|
|
13332
|
+
"operation": "get",
|
|
13333
|
+
"kind": "primitive",
|
|
13334
|
+
"endpoint": "GET /V1.0/ExpenseReports/{parentId}/Attachments/{id}",
|
|
13335
|
+
"effect": "read",
|
|
13336
|
+
"flags": [],
|
|
13337
|
+
"dryRun": false,
|
|
13338
|
+
"envelope": "ExpenseReportAttachmentModel",
|
|
13339
|
+
"inputSchema": {
|
|
13340
|
+
"parentId": {
|
|
13341
|
+
"type": "string | number",
|
|
13342
|
+
"required": true,
|
|
13343
|
+
"description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
|
|
13344
|
+
},
|
|
13345
|
+
"id": {
|
|
13346
|
+
"type": "string | number",
|
|
13347
|
+
"required": true,
|
|
13348
|
+
"description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
|
|
13349
|
+
},
|
|
13350
|
+
"opts": {
|
|
13351
|
+
"type": "object",
|
|
13352
|
+
"required": false,
|
|
13353
|
+
"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.",
|
|
13354
|
+
"properties": [
|
|
13355
|
+
{
|
|
13356
|
+
"name": "fresh",
|
|
13357
|
+
"type": "boolean",
|
|
13358
|
+
"optional": true
|
|
13359
|
+
}
|
|
13360
|
+
]
|
|
13361
|
+
}
|
|
13362
|
+
},
|
|
13363
|
+
"inputSchemaStrict": true,
|
|
13364
|
+
"outputSchema": {
|
|
13365
|
+
"type": "ExpenseReportAttachmentModel",
|
|
13366
|
+
"drops": []
|
|
13367
|
+
},
|
|
13368
|
+
"examples": [
|
|
13369
|
+
"await client.expenseReportAttachments.get(7, 3)"
|
|
13370
|
+
],
|
|
13371
|
+
"permissions": "unknown",
|
|
13372
|
+
"pagination": {
|
|
13373
|
+
"mode": "none"
|
|
13374
|
+
},
|
|
13375
|
+
"resolution": null,
|
|
13376
|
+
"retry": {
|
|
13377
|
+
"preset": "retry-ffb3a9cb"
|
|
13378
|
+
},
|
|
13379
|
+
"errors": {
|
|
13380
|
+
"set": 3
|
|
13381
|
+
},
|
|
13382
|
+
"metadata": {
|
|
13383
|
+
"purpose": "Get one ExpenseReportAttachment by id.",
|
|
13384
|
+
"usage": "Returns the attachment model directly; item: null or an empty model is a typed not-found. Parent-scoped: parentId is the expense report id, followed by the attachment id.",
|
|
13385
|
+
"preferredWhen": "Use a known attachment id; query the scoped collection to discover ids.",
|
|
13386
|
+
"related": [
|
|
13387
|
+
"expense_report_attachments.query"
|
|
13388
|
+
],
|
|
13389
|
+
"args": "args are (parentId: number, id: number) Item GET returns the FULL vendor model — the vendor documents no field selection on single-record reads. For a slim record use an expense_report_attachments.query with includeFields.",
|
|
13390
|
+
"untrustedFields": [
|
|
13391
|
+
"title"
|
|
13392
|
+
]
|
|
13393
|
+
},
|
|
13394
|
+
"compact": null,
|
|
13395
|
+
"status": "tested"
|
|
13396
|
+
},
|
|
13397
|
+
{
|
|
13398
|
+
"id": "expense_report_attachments.getEntityInfo",
|
|
13399
|
+
"resource": "expense_report_attachments",
|
|
13400
|
+
"udfCapable": false,
|
|
13401
|
+
"operation": "getEntityInfo",
|
|
13402
|
+
"kind": "primitive",
|
|
13403
|
+
"endpoint": "GET /V1.0/ExpenseReportAttachments/entityInformation",
|
|
13404
|
+
"effect": "read",
|
|
13405
|
+
"flags": [],
|
|
13406
|
+
"dryRun": false,
|
|
13407
|
+
"envelope": "EntityInformationResultModel",
|
|
13408
|
+
"inputSchema": {},
|
|
13409
|
+
"inputSchemaStrict": true,
|
|
13410
|
+
"outputSchema": {
|
|
13411
|
+
"type": "EntityInformationResultModel",
|
|
13412
|
+
"drops": []
|
|
13413
|
+
},
|
|
13414
|
+
"examples": [
|
|
13415
|
+
"await client.expenseReportAttachments.getEntityInfo()"
|
|
13416
|
+
],
|
|
13417
|
+
"permissions": "unknown",
|
|
13418
|
+
"pagination": {
|
|
13419
|
+
"mode": "none"
|
|
13420
|
+
},
|
|
13421
|
+
"resolution": null,
|
|
13422
|
+
"retry": {
|
|
13423
|
+
"preset": "retry-ffb3a9cb"
|
|
13424
|
+
},
|
|
13425
|
+
"errors": {
|
|
13426
|
+
"set": 0
|
|
13427
|
+
},
|
|
13428
|
+
"metadata": {
|
|
13429
|
+
"purpose": "Get the ExpenseReportAttachment capability metadata (canCreate/canUpdate/hasUserDefinedFields/...).",
|
|
13430
|
+
"usage": "Unwraps info{}; drives client-side capability checks.",
|
|
13431
|
+
"preferredWhen": null,
|
|
13432
|
+
"related": [
|
|
13433
|
+
"expense_report_attachments.getFieldInfo"
|
|
13434
|
+
],
|
|
13435
|
+
"untrustedFields": [
|
|
13436
|
+
"title"
|
|
13437
|
+
]
|
|
13438
|
+
},
|
|
13439
|
+
"compact": null,
|
|
13440
|
+
"status": "tested"
|
|
13441
|
+
},
|
|
13442
|
+
{
|
|
13443
|
+
"id": "expense_report_attachments.getFieldInfo",
|
|
13444
|
+
"resource": "expense_report_attachments",
|
|
13445
|
+
"udfCapable": false,
|
|
13446
|
+
"operation": "getFieldInfo",
|
|
13447
|
+
"kind": "primitive",
|
|
13448
|
+
"endpoint": "GET /V1.0/ExpenseReportAttachments/entityInformation/fields",
|
|
13449
|
+
"effect": "read",
|
|
13450
|
+
"flags": [],
|
|
13451
|
+
"dryRun": false,
|
|
13452
|
+
"envelope": "FieldInformationResultModel",
|
|
13453
|
+
"inputSchema": {},
|
|
13454
|
+
"inputSchemaStrict": true,
|
|
13455
|
+
"outputSchema": {
|
|
13456
|
+
"type": "FieldInformationResultModel",
|
|
13457
|
+
"drops": []
|
|
13458
|
+
},
|
|
13459
|
+
"examples": [
|
|
13460
|
+
"await client.expenseReportAttachments.getFieldInfo()"
|
|
13461
|
+
],
|
|
13462
|
+
"permissions": "unknown",
|
|
13463
|
+
"pagination": {
|
|
13464
|
+
"mode": "none"
|
|
13465
|
+
},
|
|
13466
|
+
"resolution": null,
|
|
13467
|
+
"retry": {
|
|
13468
|
+
"preset": "retry-ffb3a9cb"
|
|
13469
|
+
},
|
|
13470
|
+
"errors": {
|
|
13471
|
+
"set": 0
|
|
13472
|
+
},
|
|
13473
|
+
"metadata": {
|
|
13474
|
+
"purpose": "Get the ExpenseReportAttachment field catalog (types, picklists, required, maxLength) — the full raw field dump (the largest read of the info trio; compact discovery: operations.fieldCatalog).",
|
|
13475
|
+
"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.",
|
|
13476
|
+
"preferredWhen": null,
|
|
13477
|
+
"related": [
|
|
13478
|
+
"expense_report_attachments.getEntityInfo"
|
|
13479
|
+
],
|
|
13480
|
+
"untrustedFields": [
|
|
13481
|
+
"title"
|
|
13482
|
+
]
|
|
13483
|
+
},
|
|
13484
|
+
"compact": null,
|
|
13485
|
+
"status": "tested"
|
|
13486
|
+
},
|
|
13487
|
+
{
|
|
13488
|
+
"id": "expense_report_attachments.query",
|
|
13489
|
+
"resource": "expense_report_attachments",
|
|
13490
|
+
"udfCapable": false,
|
|
13491
|
+
"operation": "query",
|
|
13492
|
+
"kind": "primitive",
|
|
13493
|
+
"endpoint": "GET|POST /V1.0/ExpenseReportAttachments/query",
|
|
13494
|
+
"effect": "read",
|
|
13495
|
+
"flags": [],
|
|
13496
|
+
"dryRun": false,
|
|
13497
|
+
"envelope": "QueryActionResult[<Model>,<Entity>]",
|
|
13498
|
+
"inputSchema": {
|
|
13499
|
+
"params": {
|
|
13500
|
+
"type": "object",
|
|
13501
|
+
"required": false,
|
|
13502
|
+
"description": "The query params object (CLOSED — unknown keys are refused pre-request with a typed error naming the key + the valid keys): { filter?: FilterCondition[], limit?: number (total cap, default 500, max 2500 — NOT a page size), latest?: number (1-2500; the N highest-id rows — the vendor has no sort; count-probe + id-threshold semantics, see docs/API.md §4; the same-process latest-walk count probes are briefly cached per client — a 30 s TTL, cleared on a write through this client (a probe in flight across the write is discarded by the cache's invalidation epoch); the plain count op and aggregate stay fresh; limit and latest may coexist only when limit >= latest), noteChars?: number (integer >= 1; opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result), includeFields?: string[], fieldCheck?: boolean (default true: every includeFields NAME and every filter condition FIELD NAME is checked pre-request against the live field set (the vendored spec when that read faults — the resource's plan-pinned live-only fields, metadata.liveOnlyFields, are exempt from the vendored refusal: the live entity carries them and the vendor model omits them (e.g. time_entries postedDate/postedOnTime) — a truly unknown name is still refused); a refusal costs zero QUERY wire — the query POST and the count probe that anchors latest are never issued, a COLD fieldCache performs one authority metadata GET first (zero on a warm one); the one udf:true condition per query is exempt (a tenant UDF name is absent from the vendored spec by definition); false disables both name checks, never the shape/grammar checks; the count verb's bag is name-checked the same way and carries the same fieldCheck opt-out; a direct queryBounded/queryAll call is not checked (no bag contract there)), names?: boolean (absent = the client's labels option — OFF by default (the label pass costs a field-catalog read + up to 20 cold name reads per call; the MCP server (iit-mcp-autotask) enables the client labels option when it re-pins to this version (downstream)); true adds the row label siblings: picklist <field>Label (statusLabel), <fk>Name for companyID/contractID/ticketID/roleID/billingCodeID/*ResourceID (contractIDName, assignedResourceIDName) — null, never missing, when the field is keyed with a null value, a 0 id or an unresolved value (a picklist 0 is labelled when the picklist defines it); a names summary appears only when something was left unlabelled (the 20 uncached name-read cap or an unresolved picklist value); false = raw ids, ~30% smaller on a full tickets row), via?: \"post\" | \"get\" (vendor GET has a 2048-char cap), acknowledgeUnscoped?: boolean (query verb only; a walk expected to read over 500 rows with no id scope in the filter is guarded — one pre-flight <resource>.count, and a count over 500 refuses with the typed SCOPE_REQUIRED before the walk; true walks the unscoped set anyway; a count that fails or is blind lets the walk run and the result's scopeNote says so), walk?: object (walk.maxRows: positive integer — (D6): the walk's TOTAL row cap — serves at most maxRows rows in total; the page size stays min(500, limit), so one vendor page may fetch more rows than maxRows and the surplus is sliced off (fetched, not served); the result's truncated flag — false only when the cursor is exhausted, true iff more rows exist past the cap (so an exact-multiple count with a live next page reports true); not combinable with latest) }. Filter grammar: 13 operators (eq, noteq, gt, gte, lt, lte, beginsWith, endsWith, contains, exist, notExist, in, notIn; in/notIn: array or \"1,2,3\") + and/or grouping (no not-group); field names in vendor API casing (via operations.fieldCatalog); caps: 500 OR-conditions / 1 UDF / 8000 chars.",
|
|
13503
|
+
"properties": [
|
|
13504
|
+
{
|
|
13505
|
+
"name": "filter",
|
|
13506
|
+
"type": "FilterCondition[]",
|
|
13507
|
+
"optional": true
|
|
13508
|
+
},
|
|
13509
|
+
{
|
|
13510
|
+
"name": "limit",
|
|
13511
|
+
"type": "number",
|
|
13512
|
+
"optional": true,
|
|
13513
|
+
"default": 500
|
|
13514
|
+
},
|
|
13515
|
+
{
|
|
13516
|
+
"name": "latest",
|
|
13517
|
+
"type": "number",
|
|
13518
|
+
"optional": true
|
|
13519
|
+
},
|
|
13520
|
+
{
|
|
13521
|
+
"name": "noteChars",
|
|
13522
|
+
"type": "number",
|
|
13523
|
+
"optional": true
|
|
13524
|
+
},
|
|
13525
|
+
{
|
|
13526
|
+
"name": "includeFields",
|
|
13527
|
+
"type": "string[]",
|
|
13528
|
+
"optional": true
|
|
13529
|
+
},
|
|
13530
|
+
{
|
|
13531
|
+
"name": "fieldCheck",
|
|
13532
|
+
"type": "boolean",
|
|
13533
|
+
"optional": true,
|
|
13534
|
+
"default": true
|
|
13535
|
+
},
|
|
13536
|
+
{
|
|
13537
|
+
"name": "names",
|
|
13538
|
+
"type": "boolean",
|
|
13539
|
+
"optional": true
|
|
13540
|
+
},
|
|
13541
|
+
{
|
|
13542
|
+
"name": "via",
|
|
13543
|
+
"type": "\"post\" | \"get\"",
|
|
13544
|
+
"optional": true
|
|
13545
|
+
},
|
|
13546
|
+
{
|
|
13547
|
+
"name": "acknowledgeUnscoped",
|
|
13548
|
+
"type": "boolean",
|
|
13549
|
+
"optional": true
|
|
13550
|
+
},
|
|
13551
|
+
{
|
|
13552
|
+
"name": "walk",
|
|
13553
|
+
"type": "object",
|
|
13554
|
+
"optional": true
|
|
13555
|
+
}
|
|
13556
|
+
]
|
|
13557
|
+
}
|
|
13558
|
+
},
|
|
13559
|
+
"inputSchemaStrict": true,
|
|
13560
|
+
"outputSchema": {
|
|
13561
|
+
"type": "QueryActionResult[<Model>,<Entity>]",
|
|
13562
|
+
"drops": []
|
|
13563
|
+
},
|
|
13564
|
+
"examples": [
|
|
13565
|
+
"await invoke(client, 'expense_report_attachments.query', [{ filter: [{ field: 'expenseReportID', op: 'eq', value: 7 }], limit: 25 }])"
|
|
13566
|
+
],
|
|
13567
|
+
"permissions": "unknown",
|
|
13568
|
+
"pagination": {
|
|
13569
|
+
"mode": "cursor",
|
|
13570
|
+
"vendorDefault": 10,
|
|
13571
|
+
"vendorMax": 500,
|
|
13572
|
+
"pageGuard": 1000,
|
|
13573
|
+
"queryBounded": {
|
|
13574
|
+
"default": 500,
|
|
13575
|
+
"max": 2500
|
|
13576
|
+
}
|
|
13577
|
+
},
|
|
13578
|
+
"resolution": null,
|
|
13579
|
+
"retry": {
|
|
13580
|
+
"preset": "retry-ffb3a9cb"
|
|
13581
|
+
},
|
|
13582
|
+
"errors": {
|
|
13583
|
+
"set": 4
|
|
13584
|
+
},
|
|
13585
|
+
"metadata": {
|
|
13586
|
+
"purpose": "Query ExpenseReportAttachment records with a JSON filter.",
|
|
13587
|
+
"usage": "Server-side pagination: one call walks the vendor cursor internally (page 1 POSTs the QueryModel body with MaxRecords = the walk's internal page size (at most 500; the default POST path — `via: 'get'` issues a GET on page 1); later pages POST the SAME body — IncludeFields, MaxRecords and the preserved filter — to the absolute vendor cursor, rebased to the client base URL; the vendor honours IncludeFields on a continuation and ignores MaxRecords there, so a later page carries the vendor's own page size) until the limit is met or the cursor is null; 1000-page guard (hasMore stays true at the guard). queryAll is the unbounded raw walk — only when you need the ENTIRE set and accept a large payload; default to the bounded query op. noteChars: N (integer >= 1) is an opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose — the same set the server wraps): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result (zero wire — response-side only). latest: N returns the N highest-id rows (id-descending): the vendor has no sort parameter — this is the only ordering channel, and a date window in `filter` narrows the cost; count-anchored — C ≤ 2500 → one count + a ≤6-page walk of the matching set, C > 2500 → count probes + an id-threshold window (≤64 probes; LATEST_THRESHOLD_UNRESOLVED on budget exhaustion), a blind count → a bounded walk with the blind-surface stamp (LATEST_WINDOW_INCOMPLETE on a truncated walk). Parent-scoped entity: the query stays global (filter with expenseReportID eq <parentId> where the parent is known). Explicit walk.maxRows independently sets the TOTAL returned-row cap (including export-sized walks); the ordinary limit is still validated in 1..2500 and only bounds the internal page size for this form. hasMore and truncated remain true at the page guard or while a cursor or unserved fetched rows remain. Self-resource prefixes are accepted in filter fields and includeFields; dotted UDF names are always refused before metadata or vendor requests, never rewritten to another tenant UDF. Include an object-specific expenseReportID filter. expenseReportID identifies the expense report parent, not the attachment author. creatorType, data and fileSize are not queryable. Report queries include attachments parented to ExpenseItems under the report; expenseItemID is a read-only child association, not a writable attachment target. A child item cannot establish company ownership of the whole report. Exact direct-parent deduplication and scoped/global list parity are unproven; an empty result is conditional on API-user permissions and visibility. The Swagger query response names an attachment model, while this collection uses the existing SDK attachment query contract { items, pageDetails }; a bare-model response is rejected as INVALID_RESPONSE rather than guessed into a collection.",
|
|
13588
|
+
"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).",
|
|
13589
|
+
"related": [
|
|
13590
|
+
"expense_report_attachments.get"
|
|
13591
|
+
],
|
|
13592
|
+
"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.",
|
|
13593
|
+
"untrustedFields": [
|
|
13594
|
+
"title"
|
|
13595
|
+
]
|
|
13596
|
+
},
|
|
13597
|
+
"compact": null,
|
|
13598
|
+
"status": "tested"
|
|
13599
|
+
},
|
|
13124
13600
|
{
|
|
13125
13601
|
"id": "expense_reports.count",
|
|
13126
13602
|
"resource": "expense_reports",
|
|
@@ -23034,12 +23510,12 @@
|
|
|
23034
23510
|
"status": "tested"
|
|
23035
23511
|
},
|
|
23036
23512
|
{
|
|
23037
|
-
"id": "
|
|
23038
|
-
"resource": "
|
|
23513
|
+
"id": "resource_attachments.count",
|
|
23514
|
+
"resource": "resource_attachments",
|
|
23039
23515
|
"udfCapable": false,
|
|
23040
23516
|
"operation": "count",
|
|
23041
23517
|
"kind": "primitive",
|
|
23042
|
-
"endpoint": "GET|POST /V1.0/
|
|
23518
|
+
"endpoint": "GET|POST /V1.0/ResourceAttachments/query/count",
|
|
23043
23519
|
"effect": "read",
|
|
23044
23520
|
"flags": [],
|
|
23045
23521
|
"dryRun": false,
|
|
@@ -23069,7 +23545,7 @@
|
|
|
23069
23545
|
"drops": []
|
|
23070
23546
|
},
|
|
23071
23547
|
"examples": [
|
|
23072
|
-
"await client.
|
|
23548
|
+
"await invoke(client, 'resource_attachments.count', [{ filter: [{ field: 'resourceID', op: 'eq', value: 7 }] }])"
|
|
23073
23549
|
],
|
|
23074
23550
|
"permissions": "unknown",
|
|
23075
23551
|
"pagination": {
|
|
@@ -23083,24 +23559,27 @@
|
|
|
23083
23559
|
"set": 0
|
|
23084
23560
|
},
|
|
23085
23561
|
"metadata": {
|
|
23086
|
-
"purpose": "Count resource
|
|
23087
|
-
"usage": "Unwraps queryCount; returns a plain number.",
|
|
23562
|
+
"purpose": "Count resource attachment records matching a JSON filter. Use resourceID for parent scope.",
|
|
23563
|
+
"usage": "Unwraps queryCount; returns a plain number. Include an object-specific resourceID filter. resourceID identifies the resource parent, not the attachment author. creatorType, data and fileSize are not queryable. opportunityID and creator fields are read-only associations; neither establishes company ownership of the resource. No child-inclusion or exact-parent uniqueness guarantee is established. Exact direct-parent deduplication and scoped/global list parity are unproven; an empty result is conditional on API-user permissions and visibility.",
|
|
23088
23564
|
"preferredWhen": null,
|
|
23089
23565
|
"related": [
|
|
23090
|
-
"
|
|
23566
|
+
"resource_attachments.query"
|
|
23091
23567
|
],
|
|
23092
|
-
"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."
|
|
23568
|
+
"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.",
|
|
23569
|
+
"untrustedFields": [
|
|
23570
|
+
"title"
|
|
23571
|
+
]
|
|
23093
23572
|
},
|
|
23094
23573
|
"compact": null,
|
|
23095
23574
|
"status": "tested"
|
|
23096
23575
|
},
|
|
23097
23576
|
{
|
|
23098
|
-
"id": "
|
|
23099
|
-
"resource": "
|
|
23577
|
+
"id": "resource_attachments.create",
|
|
23578
|
+
"resource": "resource_attachments",
|
|
23100
23579
|
"udfCapable": false,
|
|
23101
23580
|
"operation": "create",
|
|
23102
23581
|
"kind": "primitive",
|
|
23103
|
-
"endpoint": "POST /V1.0/Resources/{parentId}/
|
|
23582
|
+
"endpoint": "POST /V1.0/Resources/{parentId}/Attachments",
|
|
23104
23583
|
"effect": "write",
|
|
23105
23584
|
"flags": [],
|
|
23106
23585
|
"dryRun": true,
|
|
@@ -23123,7 +23602,7 @@
|
|
|
23123
23602
|
"drops": []
|
|
23124
23603
|
},
|
|
23125
23604
|
"examples": [
|
|
23126
|
-
"await client.
|
|
23605
|
+
"const fields = await client.resourceAttachments.getFieldInfo();\nconst values = fields.find(field => field.name === 'publish')?.picklistValues?.filter(value => value.isActive === true && /^-?\\d+$/.test(value.value) && Number.isSafeInteger(Number(value.value)));\nif (!values?.length) throw new Error('No active numeric publish value is exposed');\nawait client.resourceAttachments.create(7, { attachmentType: 'FILE_ATTACHMENT', fullPath: 'note.txt', title: 'Supporting note', publish: Number(values[0].value), data: 'bm90ZQ==' }, { dryRun: true });"
|
|
23127
23606
|
],
|
|
23128
23607
|
"permissions": "unknown",
|
|
23129
23608
|
"pagination": {
|
|
@@ -23137,33 +23616,58 @@
|
|
|
23137
23616
|
"set": 1
|
|
23138
23617
|
},
|
|
23139
23618
|
"metadata": {
|
|
23140
|
-
"purpose": "Create a
|
|
23141
|
-
"usage": "
|
|
23142
|
-
"preferredWhen": "
|
|
23619
|
+
"purpose": "Create a file attachment under a resource.",
|
|
23620
|
+
"usage": "Create a file under Resources/{parentId}/Attachments; parentId is the resource ID. Required: explicit FILE_ATTACHMENT, title/fullPath (at most 255 characters), numeric publish from current metadata and base64 data. Existing attachments cannot be updated. resourceID and audit fields are response associations, not writable links. Vendor file/type limits and permissions apply: individual file limit 6–7 MB, 10,000,000 bytes per five minutes and a five-minute creation pause when exceeded. Contact author override and nested attachment creation are unsupported for this parent. Resource impersonation uses the configured header. Exact-parent deduplication is unproven; createIfNotExists is unsupported. No live create is claimed.",
|
|
23621
|
+
"preferredWhen": "Add a new attachment; existing attachments cannot be updated. Replace through separately governed delete and create actions.",
|
|
23143
23622
|
"related": [
|
|
23144
|
-
"
|
|
23623
|
+
"resource_attachments.get"
|
|
23145
23624
|
],
|
|
23146
|
-
"
|
|
23147
|
-
"
|
|
23148
|
-
"note": "the vendor defines no DELETE for resource_role_queues (spec-derived: the vendored api-docs.json defines no DELETE on the entity's paths) — a create cannot be undone through the API; cleanup is UI-only.",
|
|
23149
|
-
"proof": "spec-derived"
|
|
23625
|
+
"argNotes": {
|
|
23626
|
+
"data": "File uploads only: attachmentType, data, fullPath, publish and title. resourceID/opportunityID, contact/resource author and audit fields, contentType and fileSize are not create inputs. No parentAttachmentID, nested attachment or UDF writes. This is a supported FILE_ATTACHMENT subset; permissions and other vendor validation remain authoritative."
|
|
23150
23627
|
},
|
|
23151
|
-
"
|
|
23628
|
+
"untrustedFields": [
|
|
23629
|
+
"title"
|
|
23630
|
+
],
|
|
23631
|
+
"createRequirements": {
|
|
23632
|
+
"requires": {
|
|
23633
|
+
"allOf": [
|
|
23634
|
+
"attachmentType",
|
|
23635
|
+
"fullPath",
|
|
23636
|
+
"title",
|
|
23637
|
+
"publish",
|
|
23638
|
+
"data"
|
|
23639
|
+
]
|
|
23640
|
+
},
|
|
23641
|
+
"requiresByValue": [
|
|
23642
|
+
{
|
|
23643
|
+
"field": "attachmentType",
|
|
23644
|
+
"value": "FILE_ATTACHMENT",
|
|
23645
|
+
"requires": {
|
|
23646
|
+
"allOf": [
|
|
23647
|
+
"data"
|
|
23648
|
+
]
|
|
23649
|
+
}
|
|
23650
|
+
}
|
|
23651
|
+
]
|
|
23652
|
+
}
|
|
23152
23653
|
},
|
|
23153
23654
|
"compact": null,
|
|
23154
23655
|
"status": "tested"
|
|
23155
23656
|
},
|
|
23156
23657
|
{
|
|
23157
|
-
"id": "
|
|
23158
|
-
"resource": "
|
|
23658
|
+
"id": "resource_attachments.delete",
|
|
23659
|
+
"resource": "resource_attachments",
|
|
23159
23660
|
"udfCapable": false,
|
|
23160
|
-
"operation": "
|
|
23661
|
+
"operation": "delete",
|
|
23161
23662
|
"kind": "primitive",
|
|
23162
|
-
"endpoint": "
|
|
23163
|
-
"effect": "
|
|
23164
|
-
"flags": [
|
|
23165
|
-
|
|
23166
|
-
|
|
23663
|
+
"endpoint": "DELETE /V1.0/Resources/{parentId}/Attachments/{id}",
|
|
23664
|
+
"effect": "destructive",
|
|
23665
|
+
"flags": [
|
|
23666
|
+
"idempotent",
|
|
23667
|
+
"requiresApproval"
|
|
23668
|
+
],
|
|
23669
|
+
"dryRun": true,
|
|
23670
|
+
"envelope": "OperationResultModel (attachment entities: the deleted attachment model is returned, not OperationResultModel)",
|
|
23167
23671
|
"inputSchema": {
|
|
23168
23672
|
"parentId": {
|
|
23169
23673
|
"type": "string | number",
|
|
@@ -23174,27 +23678,15 @@
|
|
|
23174
23678
|
"type": "string | number",
|
|
23175
23679
|
"required": true,
|
|
23176
23680
|
"description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
|
|
23177
|
-
},
|
|
23178
|
-
"opts": {
|
|
23179
|
-
"type": "object",
|
|
23180
|
-
"required": false,
|
|
23181
|
-
"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.",
|
|
23182
|
-
"properties": [
|
|
23183
|
-
{
|
|
23184
|
-
"name": "fresh",
|
|
23185
|
-
"type": "boolean",
|
|
23186
|
-
"optional": true
|
|
23187
|
-
}
|
|
23188
|
-
]
|
|
23189
23681
|
}
|
|
23190
23682
|
},
|
|
23191
23683
|
"inputSchemaStrict": true,
|
|
23192
23684
|
"outputSchema": {
|
|
23193
|
-
"type": "
|
|
23685
|
+
"type": "OperationResultModel (attachment entities: the deleted attachment model is returned, not OperationResultModel)",
|
|
23194
23686
|
"drops": []
|
|
23195
23687
|
},
|
|
23196
23688
|
"examples": [
|
|
23197
|
-
"await client.
|
|
23689
|
+
"await invoke(client, 'resource_attachments.delete', [7, 3], { confirm: 'resource_attachments.delete' })"
|
|
23198
23690
|
],
|
|
23199
23691
|
"permissions": "unknown",
|
|
23200
23692
|
"pagination": {
|
|
@@ -23202,42 +23694,67 @@
|
|
|
23202
23694
|
},
|
|
23203
23695
|
"resolution": null,
|
|
23204
23696
|
"retry": {
|
|
23205
|
-
"preset": "retry-
|
|
23697
|
+
"preset": "retry-1849870d"
|
|
23206
23698
|
},
|
|
23207
23699
|
"errors": {
|
|
23208
|
-
"set":
|
|
23700
|
+
"set": 2
|
|
23209
23701
|
},
|
|
23210
23702
|
"metadata": {
|
|
23211
|
-
"purpose": "
|
|
23212
|
-
"usage": "
|
|
23213
|
-
"preferredWhen":
|
|
23703
|
+
"purpose": "Delete an attachment under a resource.",
|
|
23704
|
+
"usage": "Irreversible; dry-run validates the target id first. Parent-scoped: parentId + id.",
|
|
23705
|
+
"preferredWhen": null,
|
|
23214
23706
|
"related": [
|
|
23215
|
-
"
|
|
23707
|
+
"resource_attachments.get"
|
|
23216
23708
|
],
|
|
23217
|
-
"
|
|
23709
|
+
"untrustedFields": [
|
|
23710
|
+
"title"
|
|
23711
|
+
]
|
|
23218
23712
|
},
|
|
23219
23713
|
"compact": null,
|
|
23220
23714
|
"status": "tested"
|
|
23221
23715
|
},
|
|
23222
23716
|
{
|
|
23223
|
-
"id": "
|
|
23224
|
-
"resource": "
|
|
23717
|
+
"id": "resource_attachments.get",
|
|
23718
|
+
"resource": "resource_attachments",
|
|
23225
23719
|
"udfCapable": false,
|
|
23226
|
-
"operation": "
|
|
23720
|
+
"operation": "get",
|
|
23227
23721
|
"kind": "primitive",
|
|
23228
|
-
"endpoint": "GET /V1.0/
|
|
23722
|
+
"endpoint": "GET /V1.0/Resources/{parentId}/Attachments/{id}",
|
|
23229
23723
|
"effect": "read",
|
|
23230
23724
|
"flags": [],
|
|
23231
23725
|
"dryRun": false,
|
|
23232
|
-
"envelope": "
|
|
23233
|
-
"inputSchema": {
|
|
23726
|
+
"envelope": "ResourceAttachmentModel",
|
|
23727
|
+
"inputSchema": {
|
|
23728
|
+
"parentId": {
|
|
23729
|
+
"type": "string | number",
|
|
23730
|
+
"required": true,
|
|
23731
|
+
"description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
|
|
23732
|
+
},
|
|
23733
|
+
"id": {
|
|
23734
|
+
"type": "string | number",
|
|
23735
|
+
"required": true,
|
|
23736
|
+
"description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
|
|
23737
|
+
},
|
|
23738
|
+
"opts": {
|
|
23739
|
+
"type": "object",
|
|
23740
|
+
"required": false,
|
|
23741
|
+
"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.",
|
|
23742
|
+
"properties": [
|
|
23743
|
+
{
|
|
23744
|
+
"name": "fresh",
|
|
23745
|
+
"type": "boolean",
|
|
23746
|
+
"optional": true
|
|
23747
|
+
}
|
|
23748
|
+
]
|
|
23749
|
+
}
|
|
23750
|
+
},
|
|
23234
23751
|
"inputSchemaStrict": true,
|
|
23235
23752
|
"outputSchema": {
|
|
23236
|
-
"type": "
|
|
23753
|
+
"type": "ResourceAttachmentModel",
|
|
23237
23754
|
"drops": []
|
|
23238
23755
|
},
|
|
23239
23756
|
"examples": [
|
|
23240
|
-
"await client.
|
|
23757
|
+
"await client.resourceAttachments.get(7, 3)"
|
|
23241
23758
|
],
|
|
23242
23759
|
"permissions": "unknown",
|
|
23243
23760
|
"pagination": {
|
|
@@ -23248,38 +23765,42 @@
|
|
|
23248
23765
|
"preset": "retry-ffb3a9cb"
|
|
23249
23766
|
},
|
|
23250
23767
|
"errors": {
|
|
23251
|
-
"set":
|
|
23768
|
+
"set": 3
|
|
23252
23769
|
},
|
|
23253
23770
|
"metadata": {
|
|
23254
|
-
"purpose": "Get
|
|
23255
|
-
"usage": "
|
|
23256
|
-
"preferredWhen":
|
|
23771
|
+
"purpose": "Get one ResourceAttachment by id.",
|
|
23772
|
+
"usage": "Returns the attachment model directly; item: null or an empty model is a typed not-found. Parent-scoped: parentId is the resource id, followed by the attachment id.",
|
|
23773
|
+
"preferredWhen": "Use a known attachment id; query the scoped collection to discover ids.",
|
|
23257
23774
|
"related": [
|
|
23258
|
-
"
|
|
23775
|
+
"resource_attachments.query"
|
|
23776
|
+
],
|
|
23777
|
+
"args": "args are (parentId: number, id: number) Item GET returns the FULL vendor model — the vendor documents no field selection on single-record reads. For a slim record use a resource_attachments.query with includeFields.",
|
|
23778
|
+
"untrustedFields": [
|
|
23779
|
+
"title"
|
|
23259
23780
|
]
|
|
23260
23781
|
},
|
|
23261
23782
|
"compact": null,
|
|
23262
23783
|
"status": "tested"
|
|
23263
23784
|
},
|
|
23264
23785
|
{
|
|
23265
|
-
"id": "
|
|
23266
|
-
"resource": "
|
|
23786
|
+
"id": "resource_attachments.getEntityInfo",
|
|
23787
|
+
"resource": "resource_attachments",
|
|
23267
23788
|
"udfCapable": false,
|
|
23268
|
-
"operation": "
|
|
23789
|
+
"operation": "getEntityInfo",
|
|
23269
23790
|
"kind": "primitive",
|
|
23270
|
-
"endpoint": "GET /V1.0/
|
|
23791
|
+
"endpoint": "GET /V1.0/ResourceAttachments/entityInformation",
|
|
23271
23792
|
"effect": "read",
|
|
23272
23793
|
"flags": [],
|
|
23273
23794
|
"dryRun": false,
|
|
23274
|
-
"envelope": "
|
|
23795
|
+
"envelope": "EntityInformationResultModel",
|
|
23275
23796
|
"inputSchema": {},
|
|
23276
23797
|
"inputSchemaStrict": true,
|
|
23277
23798
|
"outputSchema": {
|
|
23278
|
-
"type": "
|
|
23799
|
+
"type": "EntityInformationResultModel",
|
|
23279
23800
|
"drops": []
|
|
23280
23801
|
},
|
|
23281
23802
|
"examples": [
|
|
23282
|
-
"await client.
|
|
23803
|
+
"await client.resourceAttachments.getEntityInfo()"
|
|
23283
23804
|
],
|
|
23284
23805
|
"permissions": "unknown",
|
|
23285
23806
|
"pagination": {
|
|
@@ -23293,36 +23814,38 @@
|
|
|
23293
23814
|
"set": 0
|
|
23294
23815
|
},
|
|
23295
23816
|
"metadata": {
|
|
23296
|
-
"purpose": "Get the
|
|
23297
|
-
"usage": "Unwraps
|
|
23817
|
+
"purpose": "Get the ResourceAttachment capability metadata (canCreate/canUpdate/hasUserDefinedFields/...).",
|
|
23818
|
+
"usage": "Unwraps info{}; drives client-side capability checks.",
|
|
23298
23819
|
"preferredWhen": null,
|
|
23299
23820
|
"related": [
|
|
23300
|
-
"
|
|
23301
|
-
|
|
23821
|
+
"resource_attachments.getFieldInfo"
|
|
23822
|
+
],
|
|
23823
|
+
"untrustedFields": [
|
|
23824
|
+
"title"
|
|
23302
23825
|
]
|
|
23303
23826
|
},
|
|
23304
23827
|
"compact": null,
|
|
23305
23828
|
"status": "tested"
|
|
23306
23829
|
},
|
|
23307
23830
|
{
|
|
23308
|
-
"id": "
|
|
23309
|
-
"resource": "
|
|
23831
|
+
"id": "resource_attachments.getFieldInfo",
|
|
23832
|
+
"resource": "resource_attachments",
|
|
23310
23833
|
"udfCapable": false,
|
|
23311
|
-
"operation": "
|
|
23834
|
+
"operation": "getFieldInfo",
|
|
23312
23835
|
"kind": "primitive",
|
|
23313
|
-
"endpoint": "GET /V1.0/
|
|
23836
|
+
"endpoint": "GET /V1.0/ResourceAttachments/entityInformation/fields",
|
|
23314
23837
|
"effect": "read",
|
|
23315
23838
|
"flags": [],
|
|
23316
23839
|
"dryRun": false,
|
|
23317
|
-
"envelope": "
|
|
23840
|
+
"envelope": "FieldInformationResultModel",
|
|
23318
23841
|
"inputSchema": {},
|
|
23319
23842
|
"inputSchemaStrict": true,
|
|
23320
23843
|
"outputSchema": {
|
|
23321
|
-
"type": "
|
|
23844
|
+
"type": "FieldInformationResultModel",
|
|
23322
23845
|
"drops": []
|
|
23323
23846
|
},
|
|
23324
23847
|
"examples": [
|
|
23325
|
-
"await client.
|
|
23848
|
+
"await client.resourceAttachments.getFieldInfo()"
|
|
23326
23849
|
],
|
|
23327
23850
|
"permissions": "unknown",
|
|
23328
23851
|
"pagination": {
|
|
@@ -23336,23 +23859,26 @@
|
|
|
23336
23859
|
"set": 0
|
|
23337
23860
|
},
|
|
23338
23861
|
"metadata": {
|
|
23339
|
-
"purpose": "Get the
|
|
23340
|
-
"usage": "Unwraps fields[];
|
|
23862
|
+
"purpose": "Get the ResourceAttachment field catalog (types, picklists, required, maxLength) — the full raw field dump (the largest read of the info trio; compact discovery: operations.fieldCatalog).",
|
|
23863
|
+
"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.",
|
|
23341
23864
|
"preferredWhen": null,
|
|
23342
23865
|
"related": [
|
|
23343
|
-
"
|
|
23866
|
+
"resource_attachments.getEntityInfo"
|
|
23867
|
+
],
|
|
23868
|
+
"untrustedFields": [
|
|
23869
|
+
"title"
|
|
23344
23870
|
]
|
|
23345
23871
|
},
|
|
23346
23872
|
"compact": null,
|
|
23347
23873
|
"status": "tested"
|
|
23348
23874
|
},
|
|
23349
23875
|
{
|
|
23350
|
-
"id": "
|
|
23351
|
-
"resource": "
|
|
23876
|
+
"id": "resource_attachments.query",
|
|
23877
|
+
"resource": "resource_attachments",
|
|
23352
23878
|
"udfCapable": false,
|
|
23353
23879
|
"operation": "query",
|
|
23354
23880
|
"kind": "primitive",
|
|
23355
|
-
"endpoint": "GET|POST /V1.0/
|
|
23881
|
+
"endpoint": "GET|POST /V1.0/ResourceAttachments/query",
|
|
23356
23882
|
"effect": "read",
|
|
23357
23883
|
"flags": [],
|
|
23358
23884
|
"dryRun": false,
|
|
@@ -23424,7 +23950,7 @@
|
|
|
23424
23950
|
"drops": []
|
|
23425
23951
|
},
|
|
23426
23952
|
"examples": [
|
|
23427
|
-
"await client.
|
|
23953
|
+
"await invoke(client, 'resource_attachments.query', [{ filter: [{ field: 'resourceID', op: 'eq', value: 7 }], limit: 25 }])"
|
|
23428
23954
|
],
|
|
23429
23955
|
"permissions": "unknown",
|
|
23430
23956
|
"pagination": {
|
|
@@ -23445,41 +23971,44 @@
|
|
|
23445
23971
|
"set": 4
|
|
23446
23972
|
},
|
|
23447
23973
|
"metadata": {
|
|
23448
|
-
"purpose": "Query
|
|
23449
|
-
"usage": "Server-side pagination: one call walks the vendor cursor internally (page 1 POSTs the QueryModel body with MaxRecords = the walk's internal page size (at most 500; the default POST path — `via: 'get'` issues a GET on page 1); later pages POST the SAME body — IncludeFields, MaxRecords and the preserved filter — to the absolute vendor cursor, rebased to the client base URL; the vendor honours IncludeFields on a continuation and ignores MaxRecords there, so a later page carries the vendor's own page size) until the limit is met or the cursor is null; 1000-page guard (hasMore stays true at the guard). queryAll is the unbounded raw walk — only when you need the ENTIRE set and accept a large payload; default to the bounded query op. noteChars: N (integer >= 1) is an opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose — the same set the server wraps): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result (zero wire — response-side only). latest: N returns the N highest-id rows (id-descending): the vendor has no sort parameter — this is the only ordering channel, and a date window in `filter` narrows the cost; count-anchored — C ≤ 2500 → one count + a ≤6-page walk of the matching set, C > 2500 → count probes + an id-threshold window (≤64 probes; LATEST_THRESHOLD_UNRESOLVED on budget exhaustion), a blind count → a bounded walk with the blind-surface stamp (LATEST_WINDOW_INCOMPLETE on a truncated walk). Parent-scoped entity: the query stays global (filter with resourceID eq <parentId> where the parent is known). Explicit walk.maxRows independently sets the TOTAL returned-row cap (including export-sized walks); the ordinary limit is still validated in 1..2500 and only bounds the internal page size for this form. hasMore and truncated remain true at the page guard or while a cursor or unserved fetched rows remain. Self-resource prefixes are accepted in filter fields and includeFields; dotted UDF names are always refused before metadata or vendor requests, never rewritten to another tenant UDF.",
|
|
23974
|
+
"purpose": "Query ResourceAttachment records with a JSON filter.",
|
|
23975
|
+
"usage": "Server-side pagination: one call walks the vendor cursor internally (page 1 POSTs the QueryModel body with MaxRecords = the walk's internal page size (at most 500; the default POST path — `via: 'get'` issues a GET on page 1); later pages POST the SAME body — IncludeFields, MaxRecords and the preserved filter — to the absolute vendor cursor, rebased to the client base URL; the vendor honours IncludeFields on a continuation and ignores MaxRecords there, so a later page carries the vendor's own page size) until the limit is met or the cursor is null; 1000-page guard (hasMore stays true at the guard). queryAll is the unbounded raw walk — only when you need the ENTIRE set and accept a large payload; default to the bounded query op. noteChars: N (integer >= 1) is an opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose — the same set the server wraps): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result (zero wire — response-side only). latest: N returns the N highest-id rows (id-descending): the vendor has no sort parameter — this is the only ordering channel, and a date window in `filter` narrows the cost; count-anchored — C ≤ 2500 → one count + a ≤6-page walk of the matching set, C > 2500 → count probes + an id-threshold window (≤64 probes; LATEST_THRESHOLD_UNRESOLVED on budget exhaustion), a blind count → a bounded walk with the blind-surface stamp (LATEST_WINDOW_INCOMPLETE on a truncated walk). Parent-scoped entity: the query stays global (filter with resourceID eq <parentId> where the parent is known). Explicit walk.maxRows independently sets the TOTAL returned-row cap (including export-sized walks); the ordinary limit is still validated in 1..2500 and only bounds the internal page size for this form. hasMore and truncated remain true at the page guard or while a cursor or unserved fetched rows remain. Self-resource prefixes are accepted in filter fields and includeFields; dotted UDF names are always refused before metadata or vendor requests, never rewritten to another tenant UDF. Include an object-specific resourceID filter. resourceID identifies the resource parent, not the attachment author. creatorType, data and fileSize are not queryable. opportunityID and creator fields are read-only associations; neither establishes company ownership of the resource. No child-inclusion or exact-parent uniqueness guarantee is established. Exact direct-parent deduplication and scoped/global list parity are unproven; an empty result is conditional on API-user permissions and visibility. The Swagger query response names an attachment model, while this collection uses the existing SDK attachment query contract { items, pageDetails }; a bare-model response is rejected as INVALID_RESPONSE rather than guessed into a collection.",
|
|
23450
23976
|
"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).",
|
|
23451
23977
|
"related": [
|
|
23452
|
-
"
|
|
23978
|
+
"resource_attachments.get"
|
|
23453
23979
|
],
|
|
23454
|
-
"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."
|
|
23980
|
+
"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.",
|
|
23981
|
+
"untrustedFields": [
|
|
23982
|
+
"title"
|
|
23983
|
+
]
|
|
23455
23984
|
},
|
|
23456
23985
|
"compact": null,
|
|
23457
23986
|
"status": "tested"
|
|
23458
23987
|
},
|
|
23459
23988
|
{
|
|
23460
|
-
"id": "resource_role_queues.
|
|
23989
|
+
"id": "resource_role_queues.count",
|
|
23461
23990
|
"resource": "resource_role_queues",
|
|
23462
23991
|
"udfCapable": false,
|
|
23463
|
-
"operation": "
|
|
23464
|
-
"kind": "
|
|
23465
|
-
"endpoint":
|
|
23992
|
+
"operation": "count",
|
|
23993
|
+
"kind": "primitive",
|
|
23994
|
+
"endpoint": "GET|POST /V1.0/ResourceRoleQueues/query/count",
|
|
23466
23995
|
"effect": "read",
|
|
23467
23996
|
"flags": [],
|
|
23468
23997
|
"dryRun": false,
|
|
23469
|
-
"envelope":
|
|
23998
|
+
"envelope": "QueryCountResultModel",
|
|
23470
23999
|
"inputSchema": {
|
|
23471
|
-
"
|
|
23472
|
-
"type": "string | number",
|
|
23473
|
-
"required": true,
|
|
23474
|
-
"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)."
|
|
23475
|
-
},
|
|
23476
|
-
"opts": {
|
|
24000
|
+
"params": {
|
|
23477
24001
|
"type": "object",
|
|
23478
24002
|
"required": false,
|
|
23479
|
-
"description": "
|
|
24003
|
+
"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.",
|
|
23480
24004
|
"properties": [
|
|
23481
24005
|
{
|
|
23482
|
-
"name": "
|
|
24006
|
+
"name": "filter",
|
|
24007
|
+
"type": "FilterCondition[]",
|
|
24008
|
+
"optional": true
|
|
24009
|
+
},
|
|
24010
|
+
{
|
|
24011
|
+
"name": "fieldCheck",
|
|
23483
24012
|
"type": "boolean",
|
|
23484
24013
|
"optional": true
|
|
23485
24014
|
}
|
|
@@ -23488,49 +24017,44 @@
|
|
|
23488
24017
|
},
|
|
23489
24018
|
"inputSchemaStrict": true,
|
|
23490
24019
|
"outputSchema": {
|
|
23491
|
-
"type": "
|
|
24020
|
+
"type": "QueryCountResultModel",
|
|
23492
24021
|
"drops": []
|
|
23493
24022
|
},
|
|
23494
24023
|
"examples": [
|
|
23495
|
-
"await client.resourceRoleQueues.
|
|
24024
|
+
"await client.resourceRoleQueues.count({ filter: [{ field: 'name', op: 'eq', value: 'example' }] })"
|
|
23496
24025
|
],
|
|
23497
24026
|
"permissions": "unknown",
|
|
23498
24027
|
"pagination": {
|
|
23499
24028
|
"mode": "none"
|
|
23500
24029
|
},
|
|
23501
|
-
"resolution":
|
|
23502
|
-
"basis": "server-filter",
|
|
23503
|
-
"maxScanRecords": 500,
|
|
23504
|
-
"maxScanPages": 4
|
|
23505
|
-
},
|
|
24030
|
+
"resolution": null,
|
|
23506
24031
|
"retry": {
|
|
23507
24032
|
"preset": "retry-ffb3a9cb"
|
|
23508
24033
|
},
|
|
23509
24034
|
"errors": {
|
|
23510
|
-
"set":
|
|
24035
|
+
"set": 0
|
|
23511
24036
|
},
|
|
23512
24037
|
"metadata": {
|
|
23513
|
-
"purpose": "
|
|
23514
|
-
"usage": "
|
|
24038
|
+
"purpose": "Count resource role queue records matching a JSON filter.",
|
|
24039
|
+
"usage": "Unwraps queryCount; returns a plain number.",
|
|
23515
24040
|
"preferredWhen": null,
|
|
23516
24041
|
"related": [
|
|
23517
|
-
"resource_role_queues.
|
|
23518
|
-
]
|
|
24042
|
+
"resource_role_queues.query"
|
|
24043
|
+
],
|
|
24044
|
+
"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."
|
|
23519
24045
|
},
|
|
23520
|
-
"compact":
|
|
24046
|
+
"compact": null,
|
|
23521
24047
|
"status": "tested"
|
|
23522
24048
|
},
|
|
23523
24049
|
{
|
|
23524
|
-
"id": "resource_role_queues.
|
|
24050
|
+
"id": "resource_role_queues.create",
|
|
23525
24051
|
"resource": "resource_role_queues",
|
|
23526
24052
|
"udfCapable": false,
|
|
23527
|
-
"operation": "
|
|
24053
|
+
"operation": "create",
|
|
23528
24054
|
"kind": "primitive",
|
|
23529
|
-
"endpoint": "
|
|
24055
|
+
"endpoint": "POST /V1.0/Resources/{parentId}/RoleQueues",
|
|
23530
24056
|
"effect": "write",
|
|
23531
|
-
"flags": [
|
|
23532
|
-
"idempotent"
|
|
23533
|
-
],
|
|
24057
|
+
"flags": [],
|
|
23534
24058
|
"dryRun": true,
|
|
23535
24059
|
"envelope": "OperationResultModel",
|
|
23536
24060
|
"inputSchema": {
|
|
@@ -23539,11 +24063,6 @@
|
|
|
23539
24063
|
"required": true,
|
|
23540
24064
|
"description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
|
|
23541
24065
|
},
|
|
23542
|
-
"id": {
|
|
23543
|
-
"type": "string | number",
|
|
23544
|
-
"required": true,
|
|
23545
|
-
"description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
|
|
23546
|
-
},
|
|
23547
24066
|
"data": {
|
|
23548
24067
|
"type": "object",
|
|
23549
24068
|
"required": true,
|
|
@@ -23556,7 +24075,7 @@
|
|
|
23556
24075
|
"drops": []
|
|
23557
24076
|
},
|
|
23558
24077
|
"examples": [
|
|
23559
|
-
"await client.resourceRoleQueues.
|
|
24078
|
+
"await client.resourceRoleQueues.create('example-value', { name: 'example' }, { dryRun: true })"
|
|
23560
24079
|
],
|
|
23561
24080
|
"permissions": "unknown",
|
|
23562
24081
|
"pagination": {
|
|
@@ -23564,95 +24083,39 @@
|
|
|
23564
24083
|
},
|
|
23565
24084
|
"resolution": null,
|
|
23566
24085
|
"retry": {
|
|
23567
|
-
"preset": "retry-
|
|
24086
|
+
"preset": "retry-c5657094"
|
|
23568
24087
|
},
|
|
23569
24088
|
"errors": {
|
|
23570
24089
|
"set": 1
|
|
23571
24090
|
},
|
|
23572
24091
|
"metadata": {
|
|
23573
|
-
"purpose": "
|
|
23574
|
-
"usage": "
|
|
23575
|
-
"preferredWhen": "
|
|
24092
|
+
"purpose": "Create a resource role queue.",
|
|
24093
|
+
"usage": "Returns OperationResultModel.itemId (the new id); the full record is not returned — follow up with get where needed. Parent-scoped: parentId is a path parameter.",
|
|
24094
|
+
"preferredWhen": "Only for a record that does not exist yet; prefer update for an id you already have.",
|
|
23576
24095
|
"related": [
|
|
23577
|
-
"resource_role_queues.
|
|
24096
|
+
"resource_role_queues.update"
|
|
23578
24097
|
],
|
|
24098
|
+
"deleteBoundary": {
|
|
24099
|
+
"resource": "resource_role_queues",
|
|
24100
|
+
"note": "the vendor defines no DELETE for resource_role_queues (spec-derived: the vendored api-docs.json defines no DELETE on the entity's paths) — a create cannot be undone through the API; cleanup is UI-only.",
|
|
24101
|
+
"proof": "spec-derived"
|
|
24102
|
+
},
|
|
23579
24103
|
"accountWide": true
|
|
23580
24104
|
},
|
|
23581
24105
|
"compact": null,
|
|
23582
24106
|
"status": "tested"
|
|
23583
24107
|
},
|
|
23584
24108
|
{
|
|
23585
|
-
"id": "
|
|
23586
|
-
"resource": "
|
|
23587
|
-
"udfCapable": false,
|
|
23588
|
-
"operation": "count",
|
|
23589
|
-
"kind": "primitive",
|
|
23590
|
-
"endpoint": "GET|POST /V1.0/ResourceRoles/query/count",
|
|
23591
|
-
"effect": "read",
|
|
23592
|
-
"flags": [],
|
|
23593
|
-
"dryRun": false,
|
|
23594
|
-
"envelope": "QueryCountResultModel",
|
|
23595
|
-
"inputSchema": {
|
|
23596
|
-
"params": {
|
|
23597
|
-
"type": "object",
|
|
23598
|
-
"required": false,
|
|
23599
|
-
"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.",
|
|
23600
|
-
"properties": [
|
|
23601
|
-
{
|
|
23602
|
-
"name": "filter",
|
|
23603
|
-
"type": "FilterCondition[]",
|
|
23604
|
-
"optional": true
|
|
23605
|
-
},
|
|
23606
|
-
{
|
|
23607
|
-
"name": "fieldCheck",
|
|
23608
|
-
"type": "boolean",
|
|
23609
|
-
"optional": true
|
|
23610
|
-
}
|
|
23611
|
-
]
|
|
23612
|
-
}
|
|
23613
|
-
},
|
|
23614
|
-
"inputSchemaStrict": true,
|
|
23615
|
-
"outputSchema": {
|
|
23616
|
-
"type": "QueryCountResultModel",
|
|
23617
|
-
"drops": []
|
|
23618
|
-
},
|
|
23619
|
-
"examples": [
|
|
23620
|
-
"await client.resourceRoles.count({ filter: [{ field: 'name', op: 'eq', value: 'example' }] })"
|
|
23621
|
-
],
|
|
23622
|
-
"permissions": "unknown",
|
|
23623
|
-
"pagination": {
|
|
23624
|
-
"mode": "none"
|
|
23625
|
-
},
|
|
23626
|
-
"resolution": null,
|
|
23627
|
-
"retry": {
|
|
23628
|
-
"preset": "retry-ffb3a9cb"
|
|
23629
|
-
},
|
|
23630
|
-
"errors": {
|
|
23631
|
-
"set": 0
|
|
23632
|
-
},
|
|
23633
|
-
"metadata": {
|
|
23634
|
-
"purpose": "Count resource role records matching a JSON filter.",
|
|
23635
|
-
"usage": "Unwraps queryCount; returns a plain number.",
|
|
23636
|
-
"preferredWhen": null,
|
|
23637
|
-
"related": [
|
|
23638
|
-
"resource_roles.query"
|
|
23639
|
-
],
|
|
23640
|
-
"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."
|
|
23641
|
-
},
|
|
23642
|
-
"compact": null,
|
|
23643
|
-
"status": "tested"
|
|
23644
|
-
},
|
|
23645
|
-
{
|
|
23646
|
-
"id": "resource_roles.get",
|
|
23647
|
-
"resource": "resource_roles",
|
|
24109
|
+
"id": "resource_role_queues.get",
|
|
24110
|
+
"resource": "resource_role_queues",
|
|
23648
24111
|
"udfCapable": false,
|
|
23649
24112
|
"operation": "get",
|
|
23650
24113
|
"kind": "primitive",
|
|
23651
|
-
"endpoint": "GET /V1.0/Resources/{parentId}/
|
|
24114
|
+
"endpoint": "GET /V1.0/Resources/{parentId}/RoleQueues/{id}",
|
|
23652
24115
|
"effect": "read",
|
|
23653
24116
|
"flags": [],
|
|
23654
24117
|
"dryRun": false,
|
|
23655
|
-
"envelope": "ItemQueryResultModel[
|
|
24118
|
+
"envelope": "ItemQueryResultModel[ResourceRoleQueueModel,ResourceRoleQueue]",
|
|
23656
24119
|
"inputSchema": {
|
|
23657
24120
|
"parentId": {
|
|
23658
24121
|
"type": "string | number",
|
|
@@ -23679,11 +24142,11 @@
|
|
|
23679
24142
|
},
|
|
23680
24143
|
"inputSchemaStrict": true,
|
|
23681
24144
|
"outputSchema": {
|
|
23682
|
-
"type": "ItemQueryResultModel[
|
|
24145
|
+
"type": "ItemQueryResultModel[ResourceRoleQueueModel,ResourceRoleQueue]",
|
|
23683
24146
|
"drops": []
|
|
23684
24147
|
},
|
|
23685
24148
|
"examples": [
|
|
23686
|
-
"await client.
|
|
24149
|
+
"await client.resourceRoleQueues.get('example-value', 'example-value')"
|
|
23687
24150
|
],
|
|
23688
24151
|
"permissions": "unknown",
|
|
23689
24152
|
"pagination": {
|
|
@@ -23697,24 +24160,24 @@
|
|
|
23697
24160
|
"set": 3
|
|
23698
24161
|
},
|
|
23699
24162
|
"metadata": {
|
|
23700
|
-
"purpose": "Get one
|
|
24163
|
+
"purpose": "Get one ResourceRoleQueue by id.",
|
|
23701
24164
|
"usage": "item: null on the 200 body maps to NotFoundError (vendor not-found signal). Parent-scoped: parentId + id.",
|
|
23702
|
-
"preferredWhen": "Preferred when the numeric id is already known;
|
|
24165
|
+
"preferredWhen": "Preferred when the numeric id is already known; resource_role_queues.resolve is for a field value.",
|
|
23703
24166
|
"related": [
|
|
23704
|
-
"
|
|
24167
|
+
"resource_role_queues.resolve"
|
|
23705
24168
|
],
|
|
23706
|
-
"args": "args are (parentId: number, id: number) Item GET returns the FULL vendor model — the vendor documents no field selection on single-record reads. For a slim record use a
|
|
24169
|
+
"args": "args are (parentId: number, id: number) Item GET returns the FULL vendor model — the vendor documents no field selection on single-record reads. For a slim record use a resource_role_queues.query with includeFields."
|
|
23707
24170
|
},
|
|
23708
24171
|
"compact": null,
|
|
23709
24172
|
"status": "tested"
|
|
23710
24173
|
},
|
|
23711
24174
|
{
|
|
23712
|
-
"id": "
|
|
23713
|
-
"resource": "
|
|
24175
|
+
"id": "resource_role_queues.getEntityInfo",
|
|
24176
|
+
"resource": "resource_role_queues",
|
|
23714
24177
|
"udfCapable": false,
|
|
23715
24178
|
"operation": "getEntityInfo",
|
|
23716
24179
|
"kind": "primitive",
|
|
23717
|
-
"endpoint": "GET /V1.0/
|
|
24180
|
+
"endpoint": "GET /V1.0/ResourceRoleQueues/entityInformation",
|
|
23718
24181
|
"effect": "read",
|
|
23719
24182
|
"flags": [],
|
|
23720
24183
|
"dryRun": false,
|
|
@@ -23726,7 +24189,7 @@
|
|
|
23726
24189
|
"drops": []
|
|
23727
24190
|
},
|
|
23728
24191
|
"examples": [
|
|
23729
|
-
"await client.
|
|
24192
|
+
"await client.resourceRoleQueues.getEntityInfo()"
|
|
23730
24193
|
],
|
|
23731
24194
|
"permissions": "unknown",
|
|
23732
24195
|
"pagination": {
|
|
@@ -23740,23 +24203,23 @@
|
|
|
23740
24203
|
"set": 0
|
|
23741
24204
|
},
|
|
23742
24205
|
"metadata": {
|
|
23743
|
-
"purpose": "Get the
|
|
24206
|
+
"purpose": "Get the ResourceRoleQueue capability metadata (canCreate/canUpdate/hasUserDefinedFields/...).",
|
|
23744
24207
|
"usage": "Unwraps info{}; drives client-side capability checks.",
|
|
23745
24208
|
"preferredWhen": null,
|
|
23746
24209
|
"related": [
|
|
23747
|
-
"
|
|
24210
|
+
"resource_role_queues.getFieldInfo"
|
|
23748
24211
|
]
|
|
23749
24212
|
},
|
|
23750
24213
|
"compact": null,
|
|
23751
24214
|
"status": "tested"
|
|
23752
24215
|
},
|
|
23753
24216
|
{
|
|
23754
|
-
"id": "
|
|
23755
|
-
"resource": "
|
|
24217
|
+
"id": "resource_role_queues.getFieldInfo",
|
|
24218
|
+
"resource": "resource_role_queues",
|
|
23756
24219
|
"udfCapable": false,
|
|
23757
24220
|
"operation": "getFieldInfo",
|
|
23758
24221
|
"kind": "primitive",
|
|
23759
|
-
"endpoint": "GET /V1.0/
|
|
24222
|
+
"endpoint": "GET /V1.0/ResourceRoleQueues/entityInformation/fields",
|
|
23760
24223
|
"effect": "read",
|
|
23761
24224
|
"flags": [],
|
|
23762
24225
|
"dryRun": false,
|
|
@@ -23768,7 +24231,7 @@
|
|
|
23768
24231
|
"drops": []
|
|
23769
24232
|
},
|
|
23770
24233
|
"examples": [
|
|
23771
|
-
"await client.
|
|
24234
|
+
"await client.resourceRoleQueues.getFieldInfo()"
|
|
23772
24235
|
],
|
|
23773
24236
|
"permissions": "unknown",
|
|
23774
24237
|
"pagination": {
|
|
@@ -23782,24 +24245,24 @@
|
|
|
23782
24245
|
"set": 0
|
|
23783
24246
|
},
|
|
23784
24247
|
"metadata": {
|
|
23785
|
-
"purpose": "Get the
|
|
24248
|
+
"purpose": "Get the ResourceRoleQueue field catalog (types, picklists, required, maxLength) — the full raw field dump (the largest read of the info trio; compact discovery: operations.fieldCatalog).",
|
|
23786
24249
|
"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.",
|
|
23787
24250
|
"preferredWhen": null,
|
|
23788
24251
|
"related": [
|
|
23789
|
-
"
|
|
23790
|
-
"
|
|
24252
|
+
"resource_role_queues.getEntityInfo",
|
|
24253
|
+
"resource_role_queues.getUdfInfo"
|
|
23791
24254
|
]
|
|
23792
24255
|
},
|
|
23793
24256
|
"compact": null,
|
|
23794
24257
|
"status": "tested"
|
|
23795
24258
|
},
|
|
23796
24259
|
{
|
|
23797
|
-
"id": "
|
|
23798
|
-
"resource": "
|
|
24260
|
+
"id": "resource_role_queues.getUdfInfo",
|
|
24261
|
+
"resource": "resource_role_queues",
|
|
23799
24262
|
"udfCapable": false,
|
|
23800
24263
|
"operation": "getUdfInfo",
|
|
23801
24264
|
"kind": "primitive",
|
|
23802
|
-
"endpoint": "GET /V1.0/
|
|
24265
|
+
"endpoint": "GET /V1.0/ResourceRoleQueues/entityInformation/userDefinedFields",
|
|
23803
24266
|
"effect": "read",
|
|
23804
24267
|
"flags": [],
|
|
23805
24268
|
"dryRun": false,
|
|
@@ -23811,7 +24274,7 @@
|
|
|
23811
24274
|
"drops": []
|
|
23812
24275
|
},
|
|
23813
24276
|
"examples": [
|
|
23814
|
-
"await client.
|
|
24277
|
+
"await client.resourceRoleQueues.getUdfInfo()"
|
|
23815
24278
|
],
|
|
23816
24279
|
"permissions": "unknown",
|
|
23817
24280
|
"pagination": {
|
|
@@ -23825,23 +24288,512 @@
|
|
|
23825
24288
|
"set": 0
|
|
23826
24289
|
},
|
|
23827
24290
|
"metadata": {
|
|
23828
|
-
"purpose": "Get the
|
|
24291
|
+
"purpose": "Get the ResourceRoleQueue user-defined-field catalog.",
|
|
23829
24292
|
"usage": "Unwraps fields[]; only meaningful where the entity is UDF-capable. (entity is not UDF-capable; catalog is expected empty).",
|
|
23830
24293
|
"preferredWhen": null,
|
|
23831
24294
|
"related": [
|
|
23832
|
-
"
|
|
24295
|
+
"resource_role_queues.getFieldInfo"
|
|
23833
24296
|
]
|
|
23834
24297
|
},
|
|
23835
24298
|
"compact": null,
|
|
23836
24299
|
"status": "tested"
|
|
23837
24300
|
},
|
|
23838
24301
|
{
|
|
23839
|
-
"id": "
|
|
23840
|
-
"resource": "
|
|
24302
|
+
"id": "resource_role_queues.query",
|
|
24303
|
+
"resource": "resource_role_queues",
|
|
23841
24304
|
"udfCapable": false,
|
|
23842
24305
|
"operation": "query",
|
|
23843
24306
|
"kind": "primitive",
|
|
23844
|
-
"endpoint": "GET|POST /V1.0/
|
|
24307
|
+
"endpoint": "GET|POST /V1.0/ResourceRoleQueues/query",
|
|
24308
|
+
"effect": "read",
|
|
24309
|
+
"flags": [],
|
|
24310
|
+
"dryRun": false,
|
|
24311
|
+
"envelope": "QueryActionResult[<Model>,<Entity>]",
|
|
24312
|
+
"inputSchema": {
|
|
24313
|
+
"params": {
|
|
24314
|
+
"type": "object",
|
|
24315
|
+
"required": false,
|
|
24316
|
+
"description": "The query params object (CLOSED — unknown keys are refused pre-request with a typed error naming the key + the valid keys): { filter?: FilterCondition[], limit?: number (total cap, default 500, max 2500 — NOT a page size), latest?: number (1-2500; the N highest-id rows — the vendor has no sort; count-probe + id-threshold semantics, see docs/API.md §4; the same-process latest-walk count probes are briefly cached per client — a 30 s TTL, cleared on a write through this client (a probe in flight across the write is discarded by the cache's invalidation epoch); the plain count op and aggregate stay fresh; limit and latest may coexist only when limit >= latest), noteChars?: number (integer >= 1; opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result), includeFields?: string[], fieldCheck?: boolean (default true: every includeFields NAME and every filter condition FIELD NAME is checked pre-request against the live field set (the vendored spec when that read faults — the resource's plan-pinned live-only fields, metadata.liveOnlyFields, are exempt from the vendored refusal: the live entity carries them and the vendor model omits them (e.g. time_entries postedDate/postedOnTime) — a truly unknown name is still refused); a refusal costs zero QUERY wire — the query POST and the count probe that anchors latest are never issued, a COLD fieldCache performs one authority metadata GET first (zero on a warm one); the one udf:true condition per query is exempt (a tenant UDF name is absent from the vendored spec by definition); false disables both name checks, never the shape/grammar checks; the count verb's bag is name-checked the same way and carries the same fieldCheck opt-out; a direct queryBounded/queryAll call is not checked (no bag contract there)), names?: boolean (absent = the client's labels option — OFF by default (the label pass costs a field-catalog read + up to 20 cold name reads per call; the MCP server (iit-mcp-autotask) enables the client labels option when it re-pins to this version (downstream)); true adds the row label siblings: picklist <field>Label (statusLabel), <fk>Name for companyID/contractID/ticketID/roleID/billingCodeID/*ResourceID (contractIDName, assignedResourceIDName) — null, never missing, when the field is keyed with a null value, a 0 id or an unresolved value (a picklist 0 is labelled when the picklist defines it); a names summary appears only when something was left unlabelled (the 20 uncached name-read cap or an unresolved picklist value); false = raw ids, ~30% smaller on a full tickets row), via?: \"post\" | \"get\" (vendor GET has a 2048-char cap), acknowledgeUnscoped?: boolean (query verb only; a walk expected to read over 500 rows with no id scope in the filter is guarded — one pre-flight <resource>.count, and a count over 500 refuses with the typed SCOPE_REQUIRED before the walk; true walks the unscoped set anyway; a count that fails or is blind lets the walk run and the result's scopeNote says so), walk?: object (walk.maxRows: positive integer — (D6): the walk's TOTAL row cap — serves at most maxRows rows in total; the page size stays min(500, limit), so one vendor page may fetch more rows than maxRows and the surplus is sliced off (fetched, not served); the result's truncated flag — false only when the cursor is exhausted, true iff more rows exist past the cap (so an exact-multiple count with a live next page reports true); not combinable with latest) }. Filter grammar: 13 operators (eq, noteq, gt, gte, lt, lte, beginsWith, endsWith, contains, exist, notExist, in, notIn; in/notIn: array or \"1,2,3\") + and/or grouping (no not-group); field names in vendor API casing (via operations.fieldCatalog); caps: 500 OR-conditions / 1 UDF / 8000 chars.",
|
|
24317
|
+
"properties": [
|
|
24318
|
+
{
|
|
24319
|
+
"name": "filter",
|
|
24320
|
+
"type": "FilterCondition[]",
|
|
24321
|
+
"optional": true
|
|
24322
|
+
},
|
|
24323
|
+
{
|
|
24324
|
+
"name": "limit",
|
|
24325
|
+
"type": "number",
|
|
24326
|
+
"optional": true,
|
|
24327
|
+
"default": 500
|
|
24328
|
+
},
|
|
24329
|
+
{
|
|
24330
|
+
"name": "latest",
|
|
24331
|
+
"type": "number",
|
|
24332
|
+
"optional": true
|
|
24333
|
+
},
|
|
24334
|
+
{
|
|
24335
|
+
"name": "noteChars",
|
|
24336
|
+
"type": "number",
|
|
24337
|
+
"optional": true
|
|
24338
|
+
},
|
|
24339
|
+
{
|
|
24340
|
+
"name": "includeFields",
|
|
24341
|
+
"type": "string[]",
|
|
24342
|
+
"optional": true
|
|
24343
|
+
},
|
|
24344
|
+
{
|
|
24345
|
+
"name": "fieldCheck",
|
|
24346
|
+
"type": "boolean",
|
|
24347
|
+
"optional": true,
|
|
24348
|
+
"default": true
|
|
24349
|
+
},
|
|
24350
|
+
{
|
|
24351
|
+
"name": "names",
|
|
24352
|
+
"type": "boolean",
|
|
24353
|
+
"optional": true
|
|
24354
|
+
},
|
|
24355
|
+
{
|
|
24356
|
+
"name": "via",
|
|
24357
|
+
"type": "\"post\" | \"get\"",
|
|
24358
|
+
"optional": true
|
|
24359
|
+
},
|
|
24360
|
+
{
|
|
24361
|
+
"name": "acknowledgeUnscoped",
|
|
24362
|
+
"type": "boolean",
|
|
24363
|
+
"optional": true
|
|
24364
|
+
},
|
|
24365
|
+
{
|
|
24366
|
+
"name": "walk",
|
|
24367
|
+
"type": "object",
|
|
24368
|
+
"optional": true
|
|
24369
|
+
}
|
|
24370
|
+
]
|
|
24371
|
+
}
|
|
24372
|
+
},
|
|
24373
|
+
"inputSchemaStrict": true,
|
|
24374
|
+
"outputSchema": {
|
|
24375
|
+
"type": "QueryActionResult[<Model>,<Entity>]",
|
|
24376
|
+
"drops": []
|
|
24377
|
+
},
|
|
24378
|
+
"examples": [
|
|
24379
|
+
"await client.resourceRoleQueues.query({ filter: [{ field: 'name', op: 'eq', value: 'example' }], limit: 500 })"
|
|
24380
|
+
],
|
|
24381
|
+
"permissions": "unknown",
|
|
24382
|
+
"pagination": {
|
|
24383
|
+
"mode": "cursor",
|
|
24384
|
+
"vendorDefault": 10,
|
|
24385
|
+
"vendorMax": 500,
|
|
24386
|
+
"pageGuard": 1000,
|
|
24387
|
+
"queryBounded": {
|
|
24388
|
+
"default": 500,
|
|
24389
|
+
"max": 2500
|
|
24390
|
+
}
|
|
24391
|
+
},
|
|
24392
|
+
"resolution": null,
|
|
24393
|
+
"retry": {
|
|
24394
|
+
"preset": "retry-ffb3a9cb"
|
|
24395
|
+
},
|
|
24396
|
+
"errors": {
|
|
24397
|
+
"set": 4
|
|
24398
|
+
},
|
|
24399
|
+
"metadata": {
|
|
24400
|
+
"purpose": "Query ResourceRoleQueue records with a JSON filter.",
|
|
24401
|
+
"usage": "Server-side pagination: one call walks the vendor cursor internally (page 1 POSTs the QueryModel body with MaxRecords = the walk's internal page size (at most 500; the default POST path — `via: 'get'` issues a GET on page 1); later pages POST the SAME body — IncludeFields, MaxRecords and the preserved filter — to the absolute vendor cursor, rebased to the client base URL; the vendor honours IncludeFields on a continuation and ignores MaxRecords there, so a later page carries the vendor's own page size) until the limit is met or the cursor is null; 1000-page guard (hasMore stays true at the guard). queryAll is the unbounded raw walk — only when you need the ENTIRE set and accept a large payload; default to the bounded query op. noteChars: N (integer >= 1) is an opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose — the same set the server wraps): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result (zero wire — response-side only). latest: N returns the N highest-id rows (id-descending): the vendor has no sort parameter — this is the only ordering channel, and a date window in `filter` narrows the cost; count-anchored — C ≤ 2500 → one count + a ≤6-page walk of the matching set, C > 2500 → count probes + an id-threshold window (≤64 probes; LATEST_THRESHOLD_UNRESOLVED on budget exhaustion), a blind count → a bounded walk with the blind-surface stamp (LATEST_WINDOW_INCOMPLETE on a truncated walk). Parent-scoped entity: the query stays global (filter with resourceID eq <parentId> where the parent is known). Explicit walk.maxRows independently sets the TOTAL returned-row cap (including export-sized walks); the ordinary limit is still validated in 1..2500 and only bounds the internal page size for this form. hasMore and truncated remain true at the page guard or while a cursor or unserved fetched rows remain. Self-resource prefixes are accepted in filter fields and includeFields; dotted UDF names are always refused before metadata or vendor requests, never rewritten to another tenant UDF.",
|
|
24402
|
+
"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).",
|
|
24403
|
+
"related": [
|
|
24404
|
+
"resource_role_queues.resolve"
|
|
24405
|
+
],
|
|
24406
|
+
"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."
|
|
24407
|
+
},
|
|
24408
|
+
"compact": null,
|
|
24409
|
+
"status": "tested"
|
|
24410
|
+
},
|
|
24411
|
+
{
|
|
24412
|
+
"id": "resource_role_queues.resolve",
|
|
24413
|
+
"resource": "resource_role_queues",
|
|
24414
|
+
"udfCapable": false,
|
|
24415
|
+
"operation": "resolve",
|
|
24416
|
+
"kind": "helper",
|
|
24417
|
+
"endpoint": null,
|
|
24418
|
+
"effect": "read",
|
|
24419
|
+
"flags": [],
|
|
24420
|
+
"dryRun": false,
|
|
24421
|
+
"envelope": null,
|
|
24422
|
+
"inputSchema": {
|
|
24423
|
+
"identifier": {
|
|
24424
|
+
"type": "string | number",
|
|
24425
|
+
"required": true,
|
|
24426
|
+
"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)."
|
|
24427
|
+
},
|
|
24428
|
+
"opts": {
|
|
24429
|
+
"type": "object",
|
|
24430
|
+
"required": false,
|
|
24431
|
+
"description": "ResolutionOpts — { expand?: boolean } (return the full record; a no-op where the Summary is a structural alias).",
|
|
24432
|
+
"properties": [
|
|
24433
|
+
{
|
|
24434
|
+
"name": "expand",
|
|
24435
|
+
"type": "boolean",
|
|
24436
|
+
"optional": true
|
|
24437
|
+
}
|
|
24438
|
+
]
|
|
24439
|
+
}
|
|
24440
|
+
},
|
|
24441
|
+
"inputSchemaStrict": true,
|
|
24442
|
+
"outputSchema": {
|
|
24443
|
+
"type": "ResourceRoleQueueSummary",
|
|
24444
|
+
"drops": []
|
|
24445
|
+
},
|
|
24446
|
+
"examples": [
|
|
24447
|
+
"await client.resourceRoleQueues.resolve('example-value')"
|
|
24448
|
+
],
|
|
24449
|
+
"permissions": "unknown",
|
|
24450
|
+
"pagination": {
|
|
24451
|
+
"mode": "none"
|
|
24452
|
+
},
|
|
24453
|
+
"resolution": {
|
|
24454
|
+
"basis": "server-filter",
|
|
24455
|
+
"maxScanRecords": 500,
|
|
24456
|
+
"maxScanPages": 4
|
|
24457
|
+
},
|
|
24458
|
+
"retry": {
|
|
24459
|
+
"preset": "retry-ffb3a9cb"
|
|
24460
|
+
},
|
|
24461
|
+
"errors": {
|
|
24462
|
+
"set": 5
|
|
24463
|
+
},
|
|
24464
|
+
"metadata": {
|
|
24465
|
+
"purpose": "Resolve a resource role queue from a numeric id (the direct fetch) only — this resource has no searchable text field, so a non-numeric identifier throws a config error.",
|
|
24466
|
+
"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.",
|
|
24467
|
+
"preferredWhen": null,
|
|
24468
|
+
"related": [
|
|
24469
|
+
"resource_role_queues.get"
|
|
24470
|
+
]
|
|
24471
|
+
},
|
|
24472
|
+
"compact": "ResourceRoleQueueSummary",
|
|
24473
|
+
"status": "tested"
|
|
24474
|
+
},
|
|
24475
|
+
{
|
|
24476
|
+
"id": "resource_role_queues.update",
|
|
24477
|
+
"resource": "resource_role_queues",
|
|
24478
|
+
"udfCapable": false,
|
|
24479
|
+
"operation": "update",
|
|
24480
|
+
"kind": "primitive",
|
|
24481
|
+
"endpoint": "PUT|PATCH /V1.0/Resources/{parentId}/RoleQueues",
|
|
24482
|
+
"effect": "write",
|
|
24483
|
+
"flags": [
|
|
24484
|
+
"idempotent"
|
|
24485
|
+
],
|
|
24486
|
+
"dryRun": true,
|
|
24487
|
+
"envelope": "OperationResultModel",
|
|
24488
|
+
"inputSchema": {
|
|
24489
|
+
"parentId": {
|
|
24490
|
+
"type": "string | number",
|
|
24491
|
+
"required": true,
|
|
24492
|
+
"description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
|
|
24493
|
+
},
|
|
24494
|
+
"id": {
|
|
24495
|
+
"type": "string | number",
|
|
24496
|
+
"required": true,
|
|
24497
|
+
"description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
|
|
24498
|
+
},
|
|
24499
|
+
"data": {
|
|
24500
|
+
"type": "object",
|
|
24501
|
+
"required": true,
|
|
24502
|
+
"description": "The record payload (vendor model fields)."
|
|
24503
|
+
}
|
|
24504
|
+
},
|
|
24505
|
+
"inputSchemaStrict": true,
|
|
24506
|
+
"outputSchema": {
|
|
24507
|
+
"type": "OperationResultModel",
|
|
24508
|
+
"drops": []
|
|
24509
|
+
},
|
|
24510
|
+
"examples": [
|
|
24511
|
+
"await client.resourceRoleQueues.update('example-value', 'example-value', { name: 'example' }, { dryRun: true })"
|
|
24512
|
+
],
|
|
24513
|
+
"permissions": "unknown",
|
|
24514
|
+
"pagination": {
|
|
24515
|
+
"mode": "none"
|
|
24516
|
+
},
|
|
24517
|
+
"resolution": null,
|
|
24518
|
+
"retry": {
|
|
24519
|
+
"preset": "retry-85897a3a"
|
|
24520
|
+
},
|
|
24521
|
+
"errors": {
|
|
24522
|
+
"set": 1
|
|
24523
|
+
},
|
|
24524
|
+
"metadata": {
|
|
24525
|
+
"purpose": "Update a resource role queue.",
|
|
24526
|
+
"usage": "Issues PATCH on the collection (swagger documents put+patch there; the node strips the id from the path and the vendor keys the record by the id in the body). Stale check via lastModifiedDate where present. Parent-scoped: parentId + id.",
|
|
24527
|
+
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
24528
|
+
"related": [
|
|
24529
|
+
"resource_role_queues.get"
|
|
24530
|
+
],
|
|
24531
|
+
"accountWide": true
|
|
24532
|
+
},
|
|
24533
|
+
"compact": null,
|
|
24534
|
+
"status": "tested"
|
|
24535
|
+
},
|
|
24536
|
+
{
|
|
24537
|
+
"id": "resource_roles.count",
|
|
24538
|
+
"resource": "resource_roles",
|
|
24539
|
+
"udfCapable": false,
|
|
24540
|
+
"operation": "count",
|
|
24541
|
+
"kind": "primitive",
|
|
24542
|
+
"endpoint": "GET|POST /V1.0/ResourceRoles/query/count",
|
|
24543
|
+
"effect": "read",
|
|
24544
|
+
"flags": [],
|
|
24545
|
+
"dryRun": false,
|
|
24546
|
+
"envelope": "QueryCountResultModel",
|
|
24547
|
+
"inputSchema": {
|
|
24548
|
+
"params": {
|
|
24549
|
+
"type": "object",
|
|
24550
|
+
"required": false,
|
|
24551
|
+
"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.",
|
|
24552
|
+
"properties": [
|
|
24553
|
+
{
|
|
24554
|
+
"name": "filter",
|
|
24555
|
+
"type": "FilterCondition[]",
|
|
24556
|
+
"optional": true
|
|
24557
|
+
},
|
|
24558
|
+
{
|
|
24559
|
+
"name": "fieldCheck",
|
|
24560
|
+
"type": "boolean",
|
|
24561
|
+
"optional": true
|
|
24562
|
+
}
|
|
24563
|
+
]
|
|
24564
|
+
}
|
|
24565
|
+
},
|
|
24566
|
+
"inputSchemaStrict": true,
|
|
24567
|
+
"outputSchema": {
|
|
24568
|
+
"type": "QueryCountResultModel",
|
|
24569
|
+
"drops": []
|
|
24570
|
+
},
|
|
24571
|
+
"examples": [
|
|
24572
|
+
"await client.resourceRoles.count({ filter: [{ field: 'name', op: 'eq', value: 'example' }] })"
|
|
24573
|
+
],
|
|
24574
|
+
"permissions": "unknown",
|
|
24575
|
+
"pagination": {
|
|
24576
|
+
"mode": "none"
|
|
24577
|
+
},
|
|
24578
|
+
"resolution": null,
|
|
24579
|
+
"retry": {
|
|
24580
|
+
"preset": "retry-ffb3a9cb"
|
|
24581
|
+
},
|
|
24582
|
+
"errors": {
|
|
24583
|
+
"set": 0
|
|
24584
|
+
},
|
|
24585
|
+
"metadata": {
|
|
24586
|
+
"purpose": "Count resource role records matching a JSON filter.",
|
|
24587
|
+
"usage": "Unwraps queryCount; returns a plain number.",
|
|
24588
|
+
"preferredWhen": null,
|
|
24589
|
+
"related": [
|
|
24590
|
+
"resource_roles.query"
|
|
24591
|
+
],
|
|
24592
|
+
"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."
|
|
24593
|
+
},
|
|
24594
|
+
"compact": null,
|
|
24595
|
+
"status": "tested"
|
|
24596
|
+
},
|
|
24597
|
+
{
|
|
24598
|
+
"id": "resource_roles.get",
|
|
24599
|
+
"resource": "resource_roles",
|
|
24600
|
+
"udfCapable": false,
|
|
24601
|
+
"operation": "get",
|
|
24602
|
+
"kind": "primitive",
|
|
24603
|
+
"endpoint": "GET /V1.0/Resources/{parentId}/Roles/{id}",
|
|
24604
|
+
"effect": "read",
|
|
24605
|
+
"flags": [],
|
|
24606
|
+
"dryRun": false,
|
|
24607
|
+
"envelope": "ItemQueryResultModel[ResourceRoleModel,ResourceRole]",
|
|
24608
|
+
"inputSchema": {
|
|
24609
|
+
"parentId": {
|
|
24610
|
+
"type": "string | number",
|
|
24611
|
+
"required": true,
|
|
24612
|
+
"description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
|
|
24613
|
+
},
|
|
24614
|
+
"id": {
|
|
24615
|
+
"type": "string | number",
|
|
24616
|
+
"required": true,
|
|
24617
|
+
"description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
|
|
24618
|
+
},
|
|
24619
|
+
"opts": {
|
|
24620
|
+
"type": "object",
|
|
24621
|
+
"required": false,
|
|
24622
|
+
"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.",
|
|
24623
|
+
"properties": [
|
|
24624
|
+
{
|
|
24625
|
+
"name": "fresh",
|
|
24626
|
+
"type": "boolean",
|
|
24627
|
+
"optional": true
|
|
24628
|
+
}
|
|
24629
|
+
]
|
|
24630
|
+
}
|
|
24631
|
+
},
|
|
24632
|
+
"inputSchemaStrict": true,
|
|
24633
|
+
"outputSchema": {
|
|
24634
|
+
"type": "ItemQueryResultModel[ResourceRoleModel,ResourceRole]",
|
|
24635
|
+
"drops": []
|
|
24636
|
+
},
|
|
24637
|
+
"examples": [
|
|
24638
|
+
"await client.resourceRoles.get('example-value', 'example-value')"
|
|
24639
|
+
],
|
|
24640
|
+
"permissions": "unknown",
|
|
24641
|
+
"pagination": {
|
|
24642
|
+
"mode": "none"
|
|
24643
|
+
},
|
|
24644
|
+
"resolution": null,
|
|
24645
|
+
"retry": {
|
|
24646
|
+
"preset": "retry-ffb3a9cb"
|
|
24647
|
+
},
|
|
24648
|
+
"errors": {
|
|
24649
|
+
"set": 3
|
|
24650
|
+
},
|
|
24651
|
+
"metadata": {
|
|
24652
|
+
"purpose": "Get one ResourceRole by id.",
|
|
24653
|
+
"usage": "item: null on the 200 body maps to NotFoundError (vendor not-found signal). Parent-scoped: parentId + id.",
|
|
24654
|
+
"preferredWhen": "Preferred when the numeric id is already known; resource_roles.resolve is for a field value.",
|
|
24655
|
+
"related": [
|
|
24656
|
+
"resource_roles.resolve"
|
|
24657
|
+
],
|
|
24658
|
+
"args": "args are (parentId: number, id: number) Item GET returns the FULL vendor model — the vendor documents no field selection on single-record reads. For a slim record use a resource_roles.query with includeFields."
|
|
24659
|
+
},
|
|
24660
|
+
"compact": null,
|
|
24661
|
+
"status": "tested"
|
|
24662
|
+
},
|
|
24663
|
+
{
|
|
24664
|
+
"id": "resource_roles.getEntityInfo",
|
|
24665
|
+
"resource": "resource_roles",
|
|
24666
|
+
"udfCapable": false,
|
|
24667
|
+
"operation": "getEntityInfo",
|
|
24668
|
+
"kind": "primitive",
|
|
24669
|
+
"endpoint": "GET /V1.0/ResourceRoles/entityInformation",
|
|
24670
|
+
"effect": "read",
|
|
24671
|
+
"flags": [],
|
|
24672
|
+
"dryRun": false,
|
|
24673
|
+
"envelope": "EntityInformationResultModel",
|
|
24674
|
+
"inputSchema": {},
|
|
24675
|
+
"inputSchemaStrict": true,
|
|
24676
|
+
"outputSchema": {
|
|
24677
|
+
"type": "EntityInformationResultModel",
|
|
24678
|
+
"drops": []
|
|
24679
|
+
},
|
|
24680
|
+
"examples": [
|
|
24681
|
+
"await client.resourceRoles.getEntityInfo()"
|
|
24682
|
+
],
|
|
24683
|
+
"permissions": "unknown",
|
|
24684
|
+
"pagination": {
|
|
24685
|
+
"mode": "none"
|
|
24686
|
+
},
|
|
24687
|
+
"resolution": null,
|
|
24688
|
+
"retry": {
|
|
24689
|
+
"preset": "retry-ffb3a9cb"
|
|
24690
|
+
},
|
|
24691
|
+
"errors": {
|
|
24692
|
+
"set": 0
|
|
24693
|
+
},
|
|
24694
|
+
"metadata": {
|
|
24695
|
+
"purpose": "Get the ResourceRole capability metadata (canCreate/canUpdate/hasUserDefinedFields/...).",
|
|
24696
|
+
"usage": "Unwraps info{}; drives client-side capability checks.",
|
|
24697
|
+
"preferredWhen": null,
|
|
24698
|
+
"related": [
|
|
24699
|
+
"resource_roles.getFieldInfo"
|
|
24700
|
+
]
|
|
24701
|
+
},
|
|
24702
|
+
"compact": null,
|
|
24703
|
+
"status": "tested"
|
|
24704
|
+
},
|
|
24705
|
+
{
|
|
24706
|
+
"id": "resource_roles.getFieldInfo",
|
|
24707
|
+
"resource": "resource_roles",
|
|
24708
|
+
"udfCapable": false,
|
|
24709
|
+
"operation": "getFieldInfo",
|
|
24710
|
+
"kind": "primitive",
|
|
24711
|
+
"endpoint": "GET /V1.0/ResourceRoles/entityInformation/fields",
|
|
24712
|
+
"effect": "read",
|
|
24713
|
+
"flags": [],
|
|
24714
|
+
"dryRun": false,
|
|
24715
|
+
"envelope": "FieldInformationResultModel",
|
|
24716
|
+
"inputSchema": {},
|
|
24717
|
+
"inputSchemaStrict": true,
|
|
24718
|
+
"outputSchema": {
|
|
24719
|
+
"type": "FieldInformationResultModel",
|
|
24720
|
+
"drops": []
|
|
24721
|
+
},
|
|
24722
|
+
"examples": [
|
|
24723
|
+
"await client.resourceRoles.getFieldInfo()"
|
|
24724
|
+
],
|
|
24725
|
+
"permissions": "unknown",
|
|
24726
|
+
"pagination": {
|
|
24727
|
+
"mode": "none"
|
|
24728
|
+
},
|
|
24729
|
+
"resolution": null,
|
|
24730
|
+
"retry": {
|
|
24731
|
+
"preset": "retry-ffb3a9cb"
|
|
24732
|
+
},
|
|
24733
|
+
"errors": {
|
|
24734
|
+
"set": 0
|
|
24735
|
+
},
|
|
24736
|
+
"metadata": {
|
|
24737
|
+
"purpose": "Get the ResourceRole field catalog (types, picklists, required, maxLength) — the full raw field dump (the largest read of the info trio; compact discovery: operations.fieldCatalog).",
|
|
24738
|
+
"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.",
|
|
24739
|
+
"preferredWhen": null,
|
|
24740
|
+
"related": [
|
|
24741
|
+
"resource_roles.getEntityInfo",
|
|
24742
|
+
"resource_roles.getUdfInfo"
|
|
24743
|
+
]
|
|
24744
|
+
},
|
|
24745
|
+
"compact": null,
|
|
24746
|
+
"status": "tested"
|
|
24747
|
+
},
|
|
24748
|
+
{
|
|
24749
|
+
"id": "resource_roles.getUdfInfo",
|
|
24750
|
+
"resource": "resource_roles",
|
|
24751
|
+
"udfCapable": false,
|
|
24752
|
+
"operation": "getUdfInfo",
|
|
24753
|
+
"kind": "primitive",
|
|
24754
|
+
"endpoint": "GET /V1.0/ResourceRoles/entityInformation/userDefinedFields",
|
|
24755
|
+
"effect": "read",
|
|
24756
|
+
"flags": [],
|
|
24757
|
+
"dryRun": false,
|
|
24758
|
+
"envelope": "UserDefinedFieldInformationResultModel",
|
|
24759
|
+
"inputSchema": {},
|
|
24760
|
+
"inputSchemaStrict": true,
|
|
24761
|
+
"outputSchema": {
|
|
24762
|
+
"type": "UserDefinedFieldInformationResultModel",
|
|
24763
|
+
"drops": []
|
|
24764
|
+
},
|
|
24765
|
+
"examples": [
|
|
24766
|
+
"await client.resourceRoles.getUdfInfo()"
|
|
24767
|
+
],
|
|
24768
|
+
"permissions": "unknown",
|
|
24769
|
+
"pagination": {
|
|
24770
|
+
"mode": "none"
|
|
24771
|
+
},
|
|
24772
|
+
"resolution": null,
|
|
24773
|
+
"retry": {
|
|
24774
|
+
"preset": "retry-ffb3a9cb"
|
|
24775
|
+
},
|
|
24776
|
+
"errors": {
|
|
24777
|
+
"set": 0
|
|
24778
|
+
},
|
|
24779
|
+
"metadata": {
|
|
24780
|
+
"purpose": "Get the ResourceRole user-defined-field catalog.",
|
|
24781
|
+
"usage": "Unwraps fields[]; only meaningful where the entity is UDF-capable. (entity is not UDF-capable; catalog is expected empty).",
|
|
24782
|
+
"preferredWhen": null,
|
|
24783
|
+
"related": [
|
|
24784
|
+
"resource_roles.getFieldInfo"
|
|
24785
|
+
]
|
|
24786
|
+
},
|
|
24787
|
+
"compact": null,
|
|
24788
|
+
"status": "tested"
|
|
24789
|
+
},
|
|
24790
|
+
{
|
|
24791
|
+
"id": "resource_roles.query",
|
|
24792
|
+
"resource": "resource_roles",
|
|
24793
|
+
"udfCapable": false,
|
|
24794
|
+
"operation": "query",
|
|
24795
|
+
"kind": "primitive",
|
|
24796
|
+
"endpoint": "GET|POST /V1.0/ResourceRoles/query",
|
|
23845
24797
|
"effect": "read",
|
|
23846
24798
|
"flags": [],
|
|
23847
24799
|
"dryRun": false,
|
|
@@ -27132,6 +28084,482 @@
|
|
|
27132
28084
|
"compact": null,
|
|
27133
28085
|
"status": "tested"
|
|
27134
28086
|
},
|
|
28087
|
+
{
|
|
28088
|
+
"id": "sales_order_attachments.count",
|
|
28089
|
+
"resource": "sales_order_attachments",
|
|
28090
|
+
"udfCapable": false,
|
|
28091
|
+
"operation": "count",
|
|
28092
|
+
"kind": "primitive",
|
|
28093
|
+
"endpoint": "GET|POST /V1.0/SalesOrderAttachments/query/count",
|
|
28094
|
+
"effect": "read",
|
|
28095
|
+
"flags": [],
|
|
28096
|
+
"dryRun": false,
|
|
28097
|
+
"envelope": "QueryCountResultModel",
|
|
28098
|
+
"inputSchema": {
|
|
28099
|
+
"params": {
|
|
28100
|
+
"type": "object",
|
|
28101
|
+
"required": false,
|
|
28102
|
+
"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.",
|
|
28103
|
+
"properties": [
|
|
28104
|
+
{
|
|
28105
|
+
"name": "filter",
|
|
28106
|
+
"type": "FilterCondition[]",
|
|
28107
|
+
"optional": true
|
|
28108
|
+
},
|
|
28109
|
+
{
|
|
28110
|
+
"name": "fieldCheck",
|
|
28111
|
+
"type": "boolean",
|
|
28112
|
+
"optional": true
|
|
28113
|
+
}
|
|
28114
|
+
]
|
|
28115
|
+
}
|
|
28116
|
+
},
|
|
28117
|
+
"inputSchemaStrict": true,
|
|
28118
|
+
"outputSchema": {
|
|
28119
|
+
"type": "QueryCountResultModel",
|
|
28120
|
+
"drops": []
|
|
28121
|
+
},
|
|
28122
|
+
"examples": [
|
|
28123
|
+
"await invoke(client, 'sales_order_attachments.count', [{ filter: [{ field: 'salesOrderID', op: 'eq', value: 7 }] }])"
|
|
28124
|
+
],
|
|
28125
|
+
"permissions": "unknown",
|
|
28126
|
+
"pagination": {
|
|
28127
|
+
"mode": "none"
|
|
28128
|
+
},
|
|
28129
|
+
"resolution": null,
|
|
28130
|
+
"retry": {
|
|
28131
|
+
"preset": "retry-ffb3a9cb"
|
|
28132
|
+
},
|
|
28133
|
+
"errors": {
|
|
28134
|
+
"set": 0
|
|
28135
|
+
},
|
|
28136
|
+
"metadata": {
|
|
28137
|
+
"purpose": "Count sales order attachment records matching a JSON filter. Use salesOrderID for sales-order scope.",
|
|
28138
|
+
"usage": "Unwraps queryCount; returns a plain number. Include an object-specific salesOrderID filter. opportunityID is the separate opportunity association; salesOrderID identifies the sales-order parent. Do not substitute the opportunity id for the sales-order id. creatorType, data and fileSize are not queryable. Object-specific filters do not establish exact direct-parent attachment membership; an empty result is conditional on API-user permissions and visibility.",
|
|
28139
|
+
"preferredWhen": null,
|
|
28140
|
+
"related": [
|
|
28141
|
+
"sales_order_attachments.query"
|
|
28142
|
+
],
|
|
28143
|
+
"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.",
|
|
28144
|
+
"untrustedFields": [
|
|
28145
|
+
"title"
|
|
28146
|
+
]
|
|
28147
|
+
},
|
|
28148
|
+
"compact": null,
|
|
28149
|
+
"status": "tested"
|
|
28150
|
+
},
|
|
28151
|
+
{
|
|
28152
|
+
"id": "sales_order_attachments.create",
|
|
28153
|
+
"resource": "sales_order_attachments",
|
|
28154
|
+
"udfCapable": false,
|
|
28155
|
+
"operation": "create",
|
|
28156
|
+
"kind": "primitive",
|
|
28157
|
+
"endpoint": "POST /V1.0/SalesOrders/{parentId}/Attachments",
|
|
28158
|
+
"effect": "write",
|
|
28159
|
+
"flags": [],
|
|
28160
|
+
"dryRun": true,
|
|
28161
|
+
"envelope": "OperationResultModel",
|
|
28162
|
+
"inputSchema": {
|
|
28163
|
+
"parentId": {
|
|
28164
|
+
"type": "string | number",
|
|
28165
|
+
"required": true,
|
|
28166
|
+
"description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
|
|
28167
|
+
},
|
|
28168
|
+
"data": {
|
|
28169
|
+
"type": "object",
|
|
28170
|
+
"required": true,
|
|
28171
|
+
"description": "The record payload (vendor model fields)."
|
|
28172
|
+
}
|
|
28173
|
+
},
|
|
28174
|
+
"inputSchemaStrict": true,
|
|
28175
|
+
"outputSchema": {
|
|
28176
|
+
"type": "OperationResultModel",
|
|
28177
|
+
"drops": []
|
|
28178
|
+
},
|
|
28179
|
+
"examples": [
|
|
28180
|
+
"const fields = await client.salesOrderAttachments.getFieldInfo();\nconst values = fields.find(field => field.name === 'publish')?.picklistValues?.filter(value => value.isActive === true && /^-?\\d+$/.test(value.value) && Number.isSafeInteger(Number(value.value)));\nif (!values?.length) throw new Error('No active numeric publish value is exposed');\nawait client.salesOrderAttachments.create(7, { attachmentType: 'FILE_ATTACHMENT', fullPath: 'order.txt', title: 'Supporting order', publish: Number(values[0].value), data: 'bm90ZQ==' }, { dryRun: true });"
|
|
28181
|
+
],
|
|
28182
|
+
"permissions": "unknown",
|
|
28183
|
+
"pagination": {
|
|
28184
|
+
"mode": "none"
|
|
28185
|
+
},
|
|
28186
|
+
"resolution": null,
|
|
28187
|
+
"retry": {
|
|
28188
|
+
"preset": "retry-c5657094"
|
|
28189
|
+
},
|
|
28190
|
+
"errors": {
|
|
28191
|
+
"set": 1
|
|
28192
|
+
},
|
|
28193
|
+
"metadata": {
|
|
28194
|
+
"purpose": "Create a file attachment under a sales order.",
|
|
28195
|
+
"usage": "Create a file under SalesOrders/{parentId}/Attachments; parentId is the sales-order ID, not opportunityID. Required: explicit FILE_ATTACHMENT, title/fullPath (at most 255 characters), numeric publish from current metadata and base64 data. Existing attachments cannot be updated. salesOrderID/opportunityID and audit fields are response associations, not writable links. Vendor file/type limits and permissions apply: individual file limit 6–7 MB, 10,000,000 bytes per five minutes and a five-minute creation pause when exceeded. Contact author override and nested attachment creation are unsupported for sales orders. Resource impersonation uses the configured header. Exact-parent deduplication is unproven; createIfNotExists is unsupported. No live create is claimed.",
|
|
28196
|
+
"preferredWhen": "Add a new attachment; existing attachments cannot be updated. Replace through separately governed delete and create actions.",
|
|
28197
|
+
"related": [
|
|
28198
|
+
"sales_order_attachments.get"
|
|
28199
|
+
],
|
|
28200
|
+
"argNotes": {
|
|
28201
|
+
"data": "File uploads only. Required fields are attachmentType, data, fullPath, publish and title. Read-only salesOrderID/opportunityID, contact/resource author fields, audit fields, contentType and fileSize are not create inputs. Sales orders cannot have nested attachments; parentAttachmentID is not supported. companyID/projectID are not fields on this attachment model. Other attachment types and UDF writes are unsupported."
|
|
28202
|
+
},
|
|
28203
|
+
"untrustedFields": [
|
|
28204
|
+
"title"
|
|
28205
|
+
],
|
|
28206
|
+
"createRequirements": {
|
|
28207
|
+
"requires": {
|
|
28208
|
+
"allOf": [
|
|
28209
|
+
"attachmentType",
|
|
28210
|
+
"fullPath",
|
|
28211
|
+
"title",
|
|
28212
|
+
"publish",
|
|
28213
|
+
"data"
|
|
28214
|
+
]
|
|
28215
|
+
},
|
|
28216
|
+
"requiresByValue": [
|
|
28217
|
+
{
|
|
28218
|
+
"field": "attachmentType",
|
|
28219
|
+
"value": "FILE_ATTACHMENT",
|
|
28220
|
+
"requires": {
|
|
28221
|
+
"allOf": [
|
|
28222
|
+
"data"
|
|
28223
|
+
]
|
|
28224
|
+
}
|
|
28225
|
+
}
|
|
28226
|
+
]
|
|
28227
|
+
}
|
|
28228
|
+
},
|
|
28229
|
+
"compact": null,
|
|
28230
|
+
"status": "tested"
|
|
28231
|
+
},
|
|
28232
|
+
{
|
|
28233
|
+
"id": "sales_order_attachments.delete",
|
|
28234
|
+
"resource": "sales_order_attachments",
|
|
28235
|
+
"udfCapable": false,
|
|
28236
|
+
"operation": "delete",
|
|
28237
|
+
"kind": "primitive",
|
|
28238
|
+
"endpoint": "DELETE /V1.0/SalesOrders/{parentId}/Attachments/{id}",
|
|
28239
|
+
"effect": "destructive",
|
|
28240
|
+
"flags": [
|
|
28241
|
+
"idempotent",
|
|
28242
|
+
"requiresApproval"
|
|
28243
|
+
],
|
|
28244
|
+
"dryRun": true,
|
|
28245
|
+
"envelope": "OperationResultModel (attachment entities: the deleted attachment model is returned, not OperationResultModel)",
|
|
28246
|
+
"inputSchema": {
|
|
28247
|
+
"parentId": {
|
|
28248
|
+
"type": "string | number",
|
|
28249
|
+
"required": true,
|
|
28250
|
+
"description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
|
|
28251
|
+
},
|
|
28252
|
+
"id": {
|
|
28253
|
+
"type": "string | number",
|
|
28254
|
+
"required": true,
|
|
28255
|
+
"description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
|
|
28256
|
+
}
|
|
28257
|
+
},
|
|
28258
|
+
"inputSchemaStrict": true,
|
|
28259
|
+
"outputSchema": {
|
|
28260
|
+
"type": "OperationResultModel (attachment entities: the deleted attachment model is returned, not OperationResultModel)",
|
|
28261
|
+
"drops": []
|
|
28262
|
+
},
|
|
28263
|
+
"examples": [
|
|
28264
|
+
"await invoke(client, 'sales_order_attachments.delete', [7, 3], { confirm: 'sales_order_attachments.delete' })"
|
|
28265
|
+
],
|
|
28266
|
+
"permissions": "unknown",
|
|
28267
|
+
"pagination": {
|
|
28268
|
+
"mode": "none"
|
|
28269
|
+
},
|
|
28270
|
+
"resolution": null,
|
|
28271
|
+
"retry": {
|
|
28272
|
+
"preset": "retry-1849870d"
|
|
28273
|
+
},
|
|
28274
|
+
"errors": {
|
|
28275
|
+
"set": 2
|
|
28276
|
+
},
|
|
28277
|
+
"metadata": {
|
|
28278
|
+
"purpose": "Delete an attachment under a sales order.",
|
|
28279
|
+
"usage": "Irreversible; dry-run validates the target id first. Parent-scoped: parentId + id.",
|
|
28280
|
+
"preferredWhen": null,
|
|
28281
|
+
"related": [
|
|
28282
|
+
"sales_order_attachments.get"
|
|
28283
|
+
],
|
|
28284
|
+
"untrustedFields": [
|
|
28285
|
+
"title"
|
|
28286
|
+
]
|
|
28287
|
+
},
|
|
28288
|
+
"compact": null,
|
|
28289
|
+
"status": "tested"
|
|
28290
|
+
},
|
|
28291
|
+
{
|
|
28292
|
+
"id": "sales_order_attachments.get",
|
|
28293
|
+
"resource": "sales_order_attachments",
|
|
28294
|
+
"udfCapable": false,
|
|
28295
|
+
"operation": "get",
|
|
28296
|
+
"kind": "primitive",
|
|
28297
|
+
"endpoint": "GET /V1.0/SalesOrders/{parentId}/Attachments/{id}",
|
|
28298
|
+
"effect": "read",
|
|
28299
|
+
"flags": [],
|
|
28300
|
+
"dryRun": false,
|
|
28301
|
+
"envelope": "SalesOrderAttachmentModel",
|
|
28302
|
+
"inputSchema": {
|
|
28303
|
+
"parentId": {
|
|
28304
|
+
"type": "string | number",
|
|
28305
|
+
"required": true,
|
|
28306
|
+
"description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
|
|
28307
|
+
},
|
|
28308
|
+
"id": {
|
|
28309
|
+
"type": "string | number",
|
|
28310
|
+
"required": true,
|
|
28311
|
+
"description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
|
|
28312
|
+
},
|
|
28313
|
+
"opts": {
|
|
28314
|
+
"type": "object",
|
|
28315
|
+
"required": false,
|
|
28316
|
+
"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.",
|
|
28317
|
+
"properties": [
|
|
28318
|
+
{
|
|
28319
|
+
"name": "fresh",
|
|
28320
|
+
"type": "boolean",
|
|
28321
|
+
"optional": true
|
|
28322
|
+
}
|
|
28323
|
+
]
|
|
28324
|
+
}
|
|
28325
|
+
},
|
|
28326
|
+
"inputSchemaStrict": true,
|
|
28327
|
+
"outputSchema": {
|
|
28328
|
+
"type": "SalesOrderAttachmentModel",
|
|
28329
|
+
"drops": []
|
|
28330
|
+
},
|
|
28331
|
+
"examples": [
|
|
28332
|
+
"await client.salesOrderAttachments.get(7, 3)"
|
|
28333
|
+
],
|
|
28334
|
+
"permissions": "unknown",
|
|
28335
|
+
"pagination": {
|
|
28336
|
+
"mode": "none"
|
|
28337
|
+
},
|
|
28338
|
+
"resolution": null,
|
|
28339
|
+
"retry": {
|
|
28340
|
+
"preset": "retry-ffb3a9cb"
|
|
28341
|
+
},
|
|
28342
|
+
"errors": {
|
|
28343
|
+
"set": 3
|
|
28344
|
+
},
|
|
28345
|
+
"metadata": {
|
|
28346
|
+
"purpose": "Get one SalesOrderAttachment by id.",
|
|
28347
|
+
"usage": "Returns the attachment model directly; item: null or an empty model is a typed not-found. Parent-scoped: parentId is the sales-order id, followed by the attachment id.",
|
|
28348
|
+
"preferredWhen": "Use a known attachment id; query the scoped collection to discover ids.",
|
|
28349
|
+
"related": [
|
|
28350
|
+
"sales_order_attachments.query"
|
|
28351
|
+
],
|
|
28352
|
+
"args": "args are (parentId: number, id: number) Item GET returns the FULL vendor model — the vendor documents no field selection on single-record reads. For a slim record use a sales_order_attachments.query with includeFields.",
|
|
28353
|
+
"untrustedFields": [
|
|
28354
|
+
"title"
|
|
28355
|
+
]
|
|
28356
|
+
},
|
|
28357
|
+
"compact": null,
|
|
28358
|
+
"status": "tested"
|
|
28359
|
+
},
|
|
28360
|
+
{
|
|
28361
|
+
"id": "sales_order_attachments.getEntityInfo",
|
|
28362
|
+
"resource": "sales_order_attachments",
|
|
28363
|
+
"udfCapable": false,
|
|
28364
|
+
"operation": "getEntityInfo",
|
|
28365
|
+
"kind": "primitive",
|
|
28366
|
+
"endpoint": "GET /V1.0/SalesOrderAttachments/entityInformation",
|
|
28367
|
+
"effect": "read",
|
|
28368
|
+
"flags": [],
|
|
28369
|
+
"dryRun": false,
|
|
28370
|
+
"envelope": "EntityInformationResultModel",
|
|
28371
|
+
"inputSchema": {},
|
|
28372
|
+
"inputSchemaStrict": true,
|
|
28373
|
+
"outputSchema": {
|
|
28374
|
+
"type": "EntityInformationResultModel",
|
|
28375
|
+
"drops": []
|
|
28376
|
+
},
|
|
28377
|
+
"examples": [
|
|
28378
|
+
"await client.salesOrderAttachments.getEntityInfo()"
|
|
28379
|
+
],
|
|
28380
|
+
"permissions": "unknown",
|
|
28381
|
+
"pagination": {
|
|
28382
|
+
"mode": "none"
|
|
28383
|
+
},
|
|
28384
|
+
"resolution": null,
|
|
28385
|
+
"retry": {
|
|
28386
|
+
"preset": "retry-ffb3a9cb"
|
|
28387
|
+
},
|
|
28388
|
+
"errors": {
|
|
28389
|
+
"set": 0
|
|
28390
|
+
},
|
|
28391
|
+
"metadata": {
|
|
28392
|
+
"purpose": "Get the SalesOrderAttachment capability metadata (canCreate/canUpdate/hasUserDefinedFields/...).",
|
|
28393
|
+
"usage": "Unwraps info{}; drives client-side capability checks.",
|
|
28394
|
+
"preferredWhen": null,
|
|
28395
|
+
"related": [
|
|
28396
|
+
"sales_order_attachments.getFieldInfo"
|
|
28397
|
+
],
|
|
28398
|
+
"untrustedFields": [
|
|
28399
|
+
"title"
|
|
28400
|
+
]
|
|
28401
|
+
},
|
|
28402
|
+
"compact": null,
|
|
28403
|
+
"status": "tested"
|
|
28404
|
+
},
|
|
28405
|
+
{
|
|
28406
|
+
"id": "sales_order_attachments.getFieldInfo",
|
|
28407
|
+
"resource": "sales_order_attachments",
|
|
28408
|
+
"udfCapable": false,
|
|
28409
|
+
"operation": "getFieldInfo",
|
|
28410
|
+
"kind": "primitive",
|
|
28411
|
+
"endpoint": "GET /V1.0/SalesOrderAttachments/entityInformation/fields",
|
|
28412
|
+
"effect": "read",
|
|
28413
|
+
"flags": [],
|
|
28414
|
+
"dryRun": false,
|
|
28415
|
+
"envelope": "FieldInformationResultModel",
|
|
28416
|
+
"inputSchema": {},
|
|
28417
|
+
"inputSchemaStrict": true,
|
|
28418
|
+
"outputSchema": {
|
|
28419
|
+
"type": "FieldInformationResultModel",
|
|
28420
|
+
"drops": []
|
|
28421
|
+
},
|
|
28422
|
+
"examples": [
|
|
28423
|
+
"await client.salesOrderAttachments.getFieldInfo()"
|
|
28424
|
+
],
|
|
28425
|
+
"permissions": "unknown",
|
|
28426
|
+
"pagination": {
|
|
28427
|
+
"mode": "none"
|
|
28428
|
+
},
|
|
28429
|
+
"resolution": null,
|
|
28430
|
+
"retry": {
|
|
28431
|
+
"preset": "retry-ffb3a9cb"
|
|
28432
|
+
},
|
|
28433
|
+
"errors": {
|
|
28434
|
+
"set": 0
|
|
28435
|
+
},
|
|
28436
|
+
"metadata": {
|
|
28437
|
+
"purpose": "Get the SalesOrderAttachment field catalog (types, picklists, required, maxLength) — the full raw field dump (the largest read of the info trio; compact discovery: operations.fieldCatalog).",
|
|
28438
|
+
"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.",
|
|
28439
|
+
"preferredWhen": null,
|
|
28440
|
+
"related": [
|
|
28441
|
+
"sales_order_attachments.getEntityInfo"
|
|
28442
|
+
],
|
|
28443
|
+
"untrustedFields": [
|
|
28444
|
+
"title"
|
|
28445
|
+
]
|
|
28446
|
+
},
|
|
28447
|
+
"compact": null,
|
|
28448
|
+
"status": "tested"
|
|
28449
|
+
},
|
|
28450
|
+
{
|
|
28451
|
+
"id": "sales_order_attachments.query",
|
|
28452
|
+
"resource": "sales_order_attachments",
|
|
28453
|
+
"udfCapable": false,
|
|
28454
|
+
"operation": "query",
|
|
28455
|
+
"kind": "primitive",
|
|
28456
|
+
"endpoint": "GET|POST /V1.0/SalesOrderAttachments/query",
|
|
28457
|
+
"effect": "read",
|
|
28458
|
+
"flags": [],
|
|
28459
|
+
"dryRun": false,
|
|
28460
|
+
"envelope": "QueryActionResult[<Model>,<Entity>]",
|
|
28461
|
+
"inputSchema": {
|
|
28462
|
+
"params": {
|
|
28463
|
+
"type": "object",
|
|
28464
|
+
"required": false,
|
|
28465
|
+
"description": "The query params object (CLOSED — unknown keys are refused pre-request with a typed error naming the key + the valid keys): { filter?: FilterCondition[], limit?: number (total cap, default 500, max 2500 — NOT a page size), latest?: number (1-2500; the N highest-id rows — the vendor has no sort; count-probe + id-threshold semantics, see docs/API.md §4; the same-process latest-walk count probes are briefly cached per client — a 30 s TTL, cleared on a write through this client (a probe in flight across the write is discarded by the cache's invalidation epoch); the plain count op and aggregate stay fresh; limit and latest may coexist only when limit >= latest), noteChars?: number (integer >= 1; opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result), includeFields?: string[], fieldCheck?: boolean (default true: every includeFields NAME and every filter condition FIELD NAME is checked pre-request against the live field set (the vendored spec when that read faults — the resource's plan-pinned live-only fields, metadata.liveOnlyFields, are exempt from the vendored refusal: the live entity carries them and the vendor model omits them (e.g. time_entries postedDate/postedOnTime) — a truly unknown name is still refused); a refusal costs zero QUERY wire — the query POST and the count probe that anchors latest are never issued, a COLD fieldCache performs one authority metadata GET first (zero on a warm one); the one udf:true condition per query is exempt (a tenant UDF name is absent from the vendored spec by definition); false disables both name checks, never the shape/grammar checks; the count verb's bag is name-checked the same way and carries the same fieldCheck opt-out; a direct queryBounded/queryAll call is not checked (no bag contract there)), names?: boolean (absent = the client's labels option — OFF by default (the label pass costs a field-catalog read + up to 20 cold name reads per call; the MCP server (iit-mcp-autotask) enables the client labels option when it re-pins to this version (downstream)); true adds the row label siblings: picklist <field>Label (statusLabel), <fk>Name for companyID/contractID/ticketID/roleID/billingCodeID/*ResourceID (contractIDName, assignedResourceIDName) — null, never missing, when the field is keyed with a null value, a 0 id or an unresolved value (a picklist 0 is labelled when the picklist defines it); a names summary appears only when something was left unlabelled (the 20 uncached name-read cap or an unresolved picklist value); false = raw ids, ~30% smaller on a full tickets row), via?: \"post\" | \"get\" (vendor GET has a 2048-char cap), acknowledgeUnscoped?: boolean (query verb only; a walk expected to read over 500 rows with no id scope in the filter is guarded — one pre-flight <resource>.count, and a count over 500 refuses with the typed SCOPE_REQUIRED before the walk; true walks the unscoped set anyway; a count that fails or is blind lets the walk run and the result's scopeNote says so), walk?: object (walk.maxRows: positive integer — (D6): the walk's TOTAL row cap — serves at most maxRows rows in total; the page size stays min(500, limit), so one vendor page may fetch more rows than maxRows and the surplus is sliced off (fetched, not served); the result's truncated flag — false only when the cursor is exhausted, true iff more rows exist past the cap (so an exact-multiple count with a live next page reports true); not combinable with latest) }. Filter grammar: 13 operators (eq, noteq, gt, gte, lt, lte, beginsWith, endsWith, contains, exist, notExist, in, notIn; in/notIn: array or \"1,2,3\") + and/or grouping (no not-group); field names in vendor API casing (via operations.fieldCatalog); caps: 500 OR-conditions / 1 UDF / 8000 chars.",
|
|
28466
|
+
"properties": [
|
|
28467
|
+
{
|
|
28468
|
+
"name": "filter",
|
|
28469
|
+
"type": "FilterCondition[]",
|
|
28470
|
+
"optional": true
|
|
28471
|
+
},
|
|
28472
|
+
{
|
|
28473
|
+
"name": "limit",
|
|
28474
|
+
"type": "number",
|
|
28475
|
+
"optional": true,
|
|
28476
|
+
"default": 500
|
|
28477
|
+
},
|
|
28478
|
+
{
|
|
28479
|
+
"name": "latest",
|
|
28480
|
+
"type": "number",
|
|
28481
|
+
"optional": true
|
|
28482
|
+
},
|
|
28483
|
+
{
|
|
28484
|
+
"name": "noteChars",
|
|
28485
|
+
"type": "number",
|
|
28486
|
+
"optional": true
|
|
28487
|
+
},
|
|
28488
|
+
{
|
|
28489
|
+
"name": "includeFields",
|
|
28490
|
+
"type": "string[]",
|
|
28491
|
+
"optional": true
|
|
28492
|
+
},
|
|
28493
|
+
{
|
|
28494
|
+
"name": "fieldCheck",
|
|
28495
|
+
"type": "boolean",
|
|
28496
|
+
"optional": true,
|
|
28497
|
+
"default": true
|
|
28498
|
+
},
|
|
28499
|
+
{
|
|
28500
|
+
"name": "names",
|
|
28501
|
+
"type": "boolean",
|
|
28502
|
+
"optional": true
|
|
28503
|
+
},
|
|
28504
|
+
{
|
|
28505
|
+
"name": "via",
|
|
28506
|
+
"type": "\"post\" | \"get\"",
|
|
28507
|
+
"optional": true
|
|
28508
|
+
},
|
|
28509
|
+
{
|
|
28510
|
+
"name": "acknowledgeUnscoped",
|
|
28511
|
+
"type": "boolean",
|
|
28512
|
+
"optional": true
|
|
28513
|
+
},
|
|
28514
|
+
{
|
|
28515
|
+
"name": "walk",
|
|
28516
|
+
"type": "object",
|
|
28517
|
+
"optional": true
|
|
28518
|
+
}
|
|
28519
|
+
]
|
|
28520
|
+
}
|
|
28521
|
+
},
|
|
28522
|
+
"inputSchemaStrict": true,
|
|
28523
|
+
"outputSchema": {
|
|
28524
|
+
"type": "QueryActionResult[<Model>,<Entity>]",
|
|
28525
|
+
"drops": []
|
|
28526
|
+
},
|
|
28527
|
+
"examples": [
|
|
28528
|
+
"await invoke(client, 'sales_order_attachments.query', [{ filter: [{ field: 'salesOrderID', op: 'eq', value: 7 }], limit: 25 }])"
|
|
28529
|
+
],
|
|
28530
|
+
"permissions": "unknown",
|
|
28531
|
+
"pagination": {
|
|
28532
|
+
"mode": "cursor",
|
|
28533
|
+
"vendorDefault": 10,
|
|
28534
|
+
"vendorMax": 500,
|
|
28535
|
+
"pageGuard": 1000,
|
|
28536
|
+
"queryBounded": {
|
|
28537
|
+
"default": 500,
|
|
28538
|
+
"max": 2500
|
|
28539
|
+
}
|
|
28540
|
+
},
|
|
28541
|
+
"resolution": null,
|
|
28542
|
+
"retry": {
|
|
28543
|
+
"preset": "retry-ffb3a9cb"
|
|
28544
|
+
},
|
|
28545
|
+
"errors": {
|
|
28546
|
+
"set": 4
|
|
28547
|
+
},
|
|
28548
|
+
"metadata": {
|
|
28549
|
+
"purpose": "Query SalesOrderAttachment records with a JSON filter.",
|
|
28550
|
+
"usage": "Server-side pagination: one call walks the vendor cursor internally (page 1 POSTs the QueryModel body with MaxRecords = the walk's internal page size (at most 500; the default POST path — `via: 'get'` issues a GET on page 1); later pages POST the SAME body — IncludeFields, MaxRecords and the preserved filter — to the absolute vendor cursor, rebased to the client base URL; the vendor honours IncludeFields on a continuation and ignores MaxRecords there, so a later page carries the vendor's own page size) until the limit is met or the cursor is null; 1000-page guard (hasMore stays true at the guard). queryAll is the unbounded raw walk — only when you need the ENTIRE set and accept a large payload; default to the bounded query op. noteChars: N (integer >= 1) is an opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose — the same set the server wraps): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result (zero wire — response-side only). latest: N returns the N highest-id rows (id-descending): the vendor has no sort parameter — this is the only ordering channel, and a date window in `filter` narrows the cost; count-anchored — C ≤ 2500 → one count + a ≤6-page walk of the matching set, C > 2500 → count probes + an id-threshold window (≤64 probes; LATEST_THRESHOLD_UNRESOLVED on budget exhaustion), a blind count → a bounded walk with the blind-surface stamp (LATEST_WINDOW_INCOMPLETE on a truncated walk). Parent-scoped entity: the query stays global (filter with salesOrderID eq <parentId> where the parent is known). Explicit walk.maxRows independently sets the TOTAL returned-row cap (including export-sized walks); the ordinary limit is still validated in 1..2500 and only bounds the internal page size for this form. hasMore and truncated remain true at the page guard or while a cursor or unserved fetched rows remain. Self-resource prefixes are accepted in filter fields and includeFields; dotted UDF names are always refused before metadata or vendor requests, never rewritten to another tenant UDF. Include an object-specific salesOrderID filter. opportunityID is the separate opportunity association; salesOrderID identifies the sales-order parent. Do not substitute the opportunity id for the sales-order id. creatorType, data and fileSize are not queryable. Object-specific filters do not establish exact direct-parent attachment membership; an empty result is conditional on API-user permissions and visibility. The Swagger query response names an attachment model, while this collection uses the existing SDK attachment query contract { items, pageDetails }; a bare-model response is rejected as INVALID_RESPONSE rather than guessed into a collection.",
|
|
28551
|
+
"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).",
|
|
28552
|
+
"related": [
|
|
28553
|
+
"sales_order_attachments.get"
|
|
28554
|
+
],
|
|
28555
|
+
"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.",
|
|
28556
|
+
"untrustedFields": [
|
|
28557
|
+
"title"
|
|
28558
|
+
]
|
|
28559
|
+
},
|
|
28560
|
+
"compact": null,
|
|
28561
|
+
"status": "tested"
|
|
28562
|
+
},
|
|
27135
28563
|
{
|
|
27136
28564
|
"id": "sales_orders.count",
|
|
27137
28565
|
"resource": "sales_orders",
|
|
@@ -42918,8 +44346,8 @@
|
|
|
42918
44346
|
]
|
|
42919
44347
|
},
|
|
42920
44348
|
"A": {
|
|
42921
|
-
"planHash": "
|
|
42922
|
-
"builtAt": "2026-11-
|
|
44349
|
+
"planHash": "d758816a699191e3da784f70f8ebe1f37ea9458aaf528241770f7bac94ba6ede",
|
|
44350
|
+
"builtAt": "2026-11-19T12:16:58.732Z",
|
|
42923
44351
|
"records": [
|
|
42924
44352
|
{
|
|
42925
44353
|
"id": "attachment_info.count",
|
|
@@ -88086,8 +89514,8 @@
|
|
|
88086
89514
|
]
|
|
88087
89515
|
},
|
|
88088
89516
|
"operations": {
|
|
88089
|
-
"planHash": "
|
|
88090
|
-
"builtAt": "2026-11-
|
|
89517
|
+
"planHash": "d758816a699191e3da784f70f8ebe1f37ea9458aaf528241770f7bac94ba6ede",
|
|
89518
|
+
"builtAt": "2026-11-19T12:16:58.732Z",
|
|
88091
89519
|
"records": [
|
|
88092
89520
|
{
|
|
88093
89521
|
"id": "operations.aggregate",
|