node-autotask 0.82.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 +6 -0
- package/MCP_TOOL_CATALOG.json +265 -9
- package/README.md +1 -1
- package/capabilities.json +959 -7
- package/dist/capabilities-data.js +958 -6
- package/dist/capabilities.cjs +4 -4
- package/dist/capabilities.js +1 -1
- package/dist/{chunk-XJQYDJKB.cjs → chunk-5AHEJCSP.cjs} +32 -30
- package/dist/{chunk-EFINBMXE.cjs → chunk-C2AFRW5M.cjs} +297 -9
- package/dist/{chunk-HZGCJ2CQ.js → chunk-CV56RIGS.js} +292 -4
- package/dist/{chunk-EQ6LOII6.js → chunk-DBEAS3IR.js} +3 -3
- package/dist/{chunk-FYDLVUSN.js → chunk-HQJLIRXW.js} +4 -2
- package/dist/{chunk-5UR4L7SB.cjs → chunk-QCA5R7QF.cjs} +3 -3
- package/dist/{chunk-TZL45TYE.cjs → chunk-QEMBBAF5.cjs} +199 -199
- package/dist/{chunk-7PQKFGTI.js → chunk-ZKAJVHHZ.js} +2 -2
- package/dist/{index-inEhFJaU.d.cts → index-8Hg6dytT.d.cts} +88 -1
- package/dist/{index-inEhFJaU.d.ts → index-8Hg6dytT.d.ts} +88 -1
- package/dist/{index-Dt1KqDEQ.d.cts → index-DxESlIIg.d.cts} +4 -2
- package/dist/{index-CW3PJPqH.d.ts → index-nXhYAQOf.d.ts} +4 -2
- package/dist/index.cjs +84 -84
- package/dist/index.d.cts +3 -3
- package/dist/index.d.ts +3 -3
- package/dist/index.js +5 -5
- package/dist/operations/index.cjs +51 -51
- package/dist/operations/index.d.cts +4 -4
- package/dist/operations/index.d.ts +4 -4
- package/dist/operations/index.js +2 -2
- package/dist/pool.cjs +12 -12
- package/dist/pool.d.cts +1 -1
- package/dist/pool.d.ts +1 -1
- package/dist/pool.js +4 -4
- package/dist/resources/index.cjs +27 -27
- package/dist/resources/index.d.cts +2 -2
- package/dist/resources/index.d.ts +2 -2
- package/dist/resources/index.js +3 -3
- package/dist/types/index.d.cts +1 -1
- package/dist/types/index.d.ts +1 -1
- package/docs/API.md +4 -2
- package/package.json +1 -1
|
@@ -410,8 +410,8 @@ const CAPABILITY_DATA = {
|
|
|
410
410
|
],
|
|
411
411
|
"groups": {
|
|
412
412
|
"B": {
|
|
413
|
-
"planHash": "
|
|
414
|
-
"builtAt": "2026-11-
|
|
413
|
+
"planHash": "d758816a699191e3da784f70f8ebe1f37ea9458aaf528241770f7bac94ba6ede",
|
|
414
|
+
"builtAt": "2026-11-19T12:16:58.731Z",
|
|
415
415
|
"records": [
|
|
416
416
|
{
|
|
417
417
|
"id": "appointments.count",
|
|
@@ -13529,6 +13529,482 @@ const CAPABILITY_DATA = {
|
|
|
13529
13529
|
"compact": null,
|
|
13530
13530
|
"status": "tested"
|
|
13531
13531
|
},
|
|
13532
|
+
{
|
|
13533
|
+
"id": "expense_report_attachments.count",
|
|
13534
|
+
"resource": "expense_report_attachments",
|
|
13535
|
+
"udfCapable": false,
|
|
13536
|
+
"operation": "count",
|
|
13537
|
+
"kind": "primitive",
|
|
13538
|
+
"endpoint": "GET|POST /V1.0/ExpenseReportAttachments/query/count",
|
|
13539
|
+
"effect": "read",
|
|
13540
|
+
"flags": [],
|
|
13541
|
+
"dryRun": false,
|
|
13542
|
+
"envelope": "QueryCountResultModel",
|
|
13543
|
+
"inputSchema": {
|
|
13544
|
+
"params": {
|
|
13545
|
+
"type": "object",
|
|
13546
|
+
"required": false,
|
|
13547
|
+
"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.",
|
|
13548
|
+
"properties": [
|
|
13549
|
+
{
|
|
13550
|
+
"name": "filter",
|
|
13551
|
+
"type": "FilterCondition[]",
|
|
13552
|
+
"optional": true
|
|
13553
|
+
},
|
|
13554
|
+
{
|
|
13555
|
+
"name": "fieldCheck",
|
|
13556
|
+
"type": "boolean",
|
|
13557
|
+
"optional": true
|
|
13558
|
+
}
|
|
13559
|
+
]
|
|
13560
|
+
}
|
|
13561
|
+
},
|
|
13562
|
+
"inputSchemaStrict": true,
|
|
13563
|
+
"outputSchema": {
|
|
13564
|
+
"type": "QueryCountResultModel",
|
|
13565
|
+
"drops": []
|
|
13566
|
+
},
|
|
13567
|
+
"examples": [
|
|
13568
|
+
"await invoke(client, 'expense_report_attachments.count', [{ filter: [{ field: 'expenseReportID', op: 'eq', value: 7 }] }])"
|
|
13569
|
+
],
|
|
13570
|
+
"permissions": "unknown",
|
|
13571
|
+
"pagination": {
|
|
13572
|
+
"mode": "none"
|
|
13573
|
+
},
|
|
13574
|
+
"resolution": null,
|
|
13575
|
+
"retry": {
|
|
13576
|
+
"preset": "retry-ffb3a9cb"
|
|
13577
|
+
},
|
|
13578
|
+
"errors": {
|
|
13579
|
+
"set": 0
|
|
13580
|
+
},
|
|
13581
|
+
"metadata": {
|
|
13582
|
+
"purpose": "Count expense report attachment records matching a JSON filter. Use expenseReportID for parent scope.",
|
|
13583
|
+
"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.",
|
|
13584
|
+
"preferredWhen": null,
|
|
13585
|
+
"related": [
|
|
13586
|
+
"expense_report_attachments.query"
|
|
13587
|
+
],
|
|
13588
|
+
"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.",
|
|
13589
|
+
"untrustedFields": [
|
|
13590
|
+
"title"
|
|
13591
|
+
]
|
|
13592
|
+
},
|
|
13593
|
+
"compact": null,
|
|
13594
|
+
"status": "tested"
|
|
13595
|
+
},
|
|
13596
|
+
{
|
|
13597
|
+
"id": "expense_report_attachments.create",
|
|
13598
|
+
"resource": "expense_report_attachments",
|
|
13599
|
+
"udfCapable": false,
|
|
13600
|
+
"operation": "create",
|
|
13601
|
+
"kind": "primitive",
|
|
13602
|
+
"endpoint": "POST /V1.0/ExpenseReports/{parentId}/Attachments",
|
|
13603
|
+
"effect": "write",
|
|
13604
|
+
"flags": [],
|
|
13605
|
+
"dryRun": true,
|
|
13606
|
+
"envelope": "OperationResultModel",
|
|
13607
|
+
"inputSchema": {
|
|
13608
|
+
"parentId": {
|
|
13609
|
+
"type": "string | number",
|
|
13610
|
+
"required": true,
|
|
13611
|
+
"description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
|
|
13612
|
+
},
|
|
13613
|
+
"data": {
|
|
13614
|
+
"type": "object",
|
|
13615
|
+
"required": true,
|
|
13616
|
+
"description": "The record payload (vendor model fields)."
|
|
13617
|
+
}
|
|
13618
|
+
},
|
|
13619
|
+
"inputSchemaStrict": true,
|
|
13620
|
+
"outputSchema": {
|
|
13621
|
+
"type": "OperationResultModel",
|
|
13622
|
+
"drops": []
|
|
13623
|
+
},
|
|
13624
|
+
"examples": [
|
|
13625
|
+
"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 });"
|
|
13626
|
+
],
|
|
13627
|
+
"permissions": "unknown",
|
|
13628
|
+
"pagination": {
|
|
13629
|
+
"mode": "none"
|
|
13630
|
+
},
|
|
13631
|
+
"resolution": null,
|
|
13632
|
+
"retry": {
|
|
13633
|
+
"preset": "retry-c5657094"
|
|
13634
|
+
},
|
|
13635
|
+
"errors": {
|
|
13636
|
+
"set": 1
|
|
13637
|
+
},
|
|
13638
|
+
"metadata": {
|
|
13639
|
+
"purpose": "Create a file attachment under an expense report.",
|
|
13640
|
+
"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.",
|
|
13641
|
+
"preferredWhen": "Add a new attachment; existing attachments cannot be updated. Replace through separately governed delete and create actions.",
|
|
13642
|
+
"related": [
|
|
13643
|
+
"expense_report_attachments.get"
|
|
13644
|
+
],
|
|
13645
|
+
"argNotes": {
|
|
13646
|
+
"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."
|
|
13647
|
+
},
|
|
13648
|
+
"untrustedFields": [
|
|
13649
|
+
"title"
|
|
13650
|
+
],
|
|
13651
|
+
"createRequirements": {
|
|
13652
|
+
"requires": {
|
|
13653
|
+
"allOf": [
|
|
13654
|
+
"attachmentType",
|
|
13655
|
+
"fullPath",
|
|
13656
|
+
"title",
|
|
13657
|
+
"publish",
|
|
13658
|
+
"data"
|
|
13659
|
+
]
|
|
13660
|
+
},
|
|
13661
|
+
"requiresByValue": [
|
|
13662
|
+
{
|
|
13663
|
+
"field": "attachmentType",
|
|
13664
|
+
"value": "FILE_ATTACHMENT",
|
|
13665
|
+
"requires": {
|
|
13666
|
+
"allOf": [
|
|
13667
|
+
"data"
|
|
13668
|
+
]
|
|
13669
|
+
}
|
|
13670
|
+
}
|
|
13671
|
+
]
|
|
13672
|
+
}
|
|
13673
|
+
},
|
|
13674
|
+
"compact": null,
|
|
13675
|
+
"status": "tested"
|
|
13676
|
+
},
|
|
13677
|
+
{
|
|
13678
|
+
"id": "expense_report_attachments.delete",
|
|
13679
|
+
"resource": "expense_report_attachments",
|
|
13680
|
+
"udfCapable": false,
|
|
13681
|
+
"operation": "delete",
|
|
13682
|
+
"kind": "primitive",
|
|
13683
|
+
"endpoint": "DELETE /V1.0/ExpenseReports/{parentId}/Attachments/{id}",
|
|
13684
|
+
"effect": "destructive",
|
|
13685
|
+
"flags": [
|
|
13686
|
+
"idempotent",
|
|
13687
|
+
"requiresApproval"
|
|
13688
|
+
],
|
|
13689
|
+
"dryRun": true,
|
|
13690
|
+
"envelope": "OperationResultModel (attachment entities: the deleted attachment model is returned, not OperationResultModel)",
|
|
13691
|
+
"inputSchema": {
|
|
13692
|
+
"parentId": {
|
|
13693
|
+
"type": "string | number",
|
|
13694
|
+
"required": true,
|
|
13695
|
+
"description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
|
|
13696
|
+
},
|
|
13697
|
+
"id": {
|
|
13698
|
+
"type": "string | number",
|
|
13699
|
+
"required": true,
|
|
13700
|
+
"description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
|
|
13701
|
+
}
|
|
13702
|
+
},
|
|
13703
|
+
"inputSchemaStrict": true,
|
|
13704
|
+
"outputSchema": {
|
|
13705
|
+
"type": "OperationResultModel (attachment entities: the deleted attachment model is returned, not OperationResultModel)",
|
|
13706
|
+
"drops": []
|
|
13707
|
+
},
|
|
13708
|
+
"examples": [
|
|
13709
|
+
"await invoke(client, 'expense_report_attachments.delete', [7, 3], { confirm: 'expense_report_attachments.delete' })"
|
|
13710
|
+
],
|
|
13711
|
+
"permissions": "unknown",
|
|
13712
|
+
"pagination": {
|
|
13713
|
+
"mode": "none"
|
|
13714
|
+
},
|
|
13715
|
+
"resolution": null,
|
|
13716
|
+
"retry": {
|
|
13717
|
+
"preset": "retry-1849870d"
|
|
13718
|
+
},
|
|
13719
|
+
"errors": {
|
|
13720
|
+
"set": 2
|
|
13721
|
+
},
|
|
13722
|
+
"metadata": {
|
|
13723
|
+
"purpose": "Delete an attachment under an expense report.",
|
|
13724
|
+
"usage": "Irreversible; dry-run validates the target id first. Parent-scoped: parentId + id.",
|
|
13725
|
+
"preferredWhen": null,
|
|
13726
|
+
"related": [
|
|
13727
|
+
"expense_report_attachments.get"
|
|
13728
|
+
],
|
|
13729
|
+
"untrustedFields": [
|
|
13730
|
+
"title"
|
|
13731
|
+
]
|
|
13732
|
+
},
|
|
13733
|
+
"compact": null,
|
|
13734
|
+
"status": "tested"
|
|
13735
|
+
},
|
|
13736
|
+
{
|
|
13737
|
+
"id": "expense_report_attachments.get",
|
|
13738
|
+
"resource": "expense_report_attachments",
|
|
13739
|
+
"udfCapable": false,
|
|
13740
|
+
"operation": "get",
|
|
13741
|
+
"kind": "primitive",
|
|
13742
|
+
"endpoint": "GET /V1.0/ExpenseReports/{parentId}/Attachments/{id}",
|
|
13743
|
+
"effect": "read",
|
|
13744
|
+
"flags": [],
|
|
13745
|
+
"dryRun": false,
|
|
13746
|
+
"envelope": "ExpenseReportAttachmentModel",
|
|
13747
|
+
"inputSchema": {
|
|
13748
|
+
"parentId": {
|
|
13749
|
+
"type": "string | number",
|
|
13750
|
+
"required": true,
|
|
13751
|
+
"description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
|
|
13752
|
+
},
|
|
13753
|
+
"id": {
|
|
13754
|
+
"type": "string | number",
|
|
13755
|
+
"required": true,
|
|
13756
|
+
"description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
|
|
13757
|
+
},
|
|
13758
|
+
"opts": {
|
|
13759
|
+
"type": "object",
|
|
13760
|
+
"required": false,
|
|
13761
|
+
"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.",
|
|
13762
|
+
"properties": [
|
|
13763
|
+
{
|
|
13764
|
+
"name": "fresh",
|
|
13765
|
+
"type": "boolean",
|
|
13766
|
+
"optional": true
|
|
13767
|
+
}
|
|
13768
|
+
]
|
|
13769
|
+
}
|
|
13770
|
+
},
|
|
13771
|
+
"inputSchemaStrict": true,
|
|
13772
|
+
"outputSchema": {
|
|
13773
|
+
"type": "ExpenseReportAttachmentModel",
|
|
13774
|
+
"drops": []
|
|
13775
|
+
},
|
|
13776
|
+
"examples": [
|
|
13777
|
+
"await client.expenseReportAttachments.get(7, 3)"
|
|
13778
|
+
],
|
|
13779
|
+
"permissions": "unknown",
|
|
13780
|
+
"pagination": {
|
|
13781
|
+
"mode": "none"
|
|
13782
|
+
},
|
|
13783
|
+
"resolution": null,
|
|
13784
|
+
"retry": {
|
|
13785
|
+
"preset": "retry-ffb3a9cb"
|
|
13786
|
+
},
|
|
13787
|
+
"errors": {
|
|
13788
|
+
"set": 3
|
|
13789
|
+
},
|
|
13790
|
+
"metadata": {
|
|
13791
|
+
"purpose": "Get one ExpenseReportAttachment by id.",
|
|
13792
|
+
"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.",
|
|
13793
|
+
"preferredWhen": "Use a known attachment id; query the scoped collection to discover ids.",
|
|
13794
|
+
"related": [
|
|
13795
|
+
"expense_report_attachments.query"
|
|
13796
|
+
],
|
|
13797
|
+
"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.",
|
|
13798
|
+
"untrustedFields": [
|
|
13799
|
+
"title"
|
|
13800
|
+
]
|
|
13801
|
+
},
|
|
13802
|
+
"compact": null,
|
|
13803
|
+
"status": "tested"
|
|
13804
|
+
},
|
|
13805
|
+
{
|
|
13806
|
+
"id": "expense_report_attachments.getEntityInfo",
|
|
13807
|
+
"resource": "expense_report_attachments",
|
|
13808
|
+
"udfCapable": false,
|
|
13809
|
+
"operation": "getEntityInfo",
|
|
13810
|
+
"kind": "primitive",
|
|
13811
|
+
"endpoint": "GET /V1.0/ExpenseReportAttachments/entityInformation",
|
|
13812
|
+
"effect": "read",
|
|
13813
|
+
"flags": [],
|
|
13814
|
+
"dryRun": false,
|
|
13815
|
+
"envelope": "EntityInformationResultModel",
|
|
13816
|
+
"inputSchema": {},
|
|
13817
|
+
"inputSchemaStrict": true,
|
|
13818
|
+
"outputSchema": {
|
|
13819
|
+
"type": "EntityInformationResultModel",
|
|
13820
|
+
"drops": []
|
|
13821
|
+
},
|
|
13822
|
+
"examples": [
|
|
13823
|
+
"await client.expenseReportAttachments.getEntityInfo()"
|
|
13824
|
+
],
|
|
13825
|
+
"permissions": "unknown",
|
|
13826
|
+
"pagination": {
|
|
13827
|
+
"mode": "none"
|
|
13828
|
+
},
|
|
13829
|
+
"resolution": null,
|
|
13830
|
+
"retry": {
|
|
13831
|
+
"preset": "retry-ffb3a9cb"
|
|
13832
|
+
},
|
|
13833
|
+
"errors": {
|
|
13834
|
+
"set": 0
|
|
13835
|
+
},
|
|
13836
|
+
"metadata": {
|
|
13837
|
+
"purpose": "Get the ExpenseReportAttachment capability metadata (canCreate/canUpdate/hasUserDefinedFields/...).",
|
|
13838
|
+
"usage": "Unwraps info{}; drives client-side capability checks.",
|
|
13839
|
+
"preferredWhen": null,
|
|
13840
|
+
"related": [
|
|
13841
|
+
"expense_report_attachments.getFieldInfo"
|
|
13842
|
+
],
|
|
13843
|
+
"untrustedFields": [
|
|
13844
|
+
"title"
|
|
13845
|
+
]
|
|
13846
|
+
},
|
|
13847
|
+
"compact": null,
|
|
13848
|
+
"status": "tested"
|
|
13849
|
+
},
|
|
13850
|
+
{
|
|
13851
|
+
"id": "expense_report_attachments.getFieldInfo",
|
|
13852
|
+
"resource": "expense_report_attachments",
|
|
13853
|
+
"udfCapable": false,
|
|
13854
|
+
"operation": "getFieldInfo",
|
|
13855
|
+
"kind": "primitive",
|
|
13856
|
+
"endpoint": "GET /V1.0/ExpenseReportAttachments/entityInformation/fields",
|
|
13857
|
+
"effect": "read",
|
|
13858
|
+
"flags": [],
|
|
13859
|
+
"dryRun": false,
|
|
13860
|
+
"envelope": "FieldInformationResultModel",
|
|
13861
|
+
"inputSchema": {},
|
|
13862
|
+
"inputSchemaStrict": true,
|
|
13863
|
+
"outputSchema": {
|
|
13864
|
+
"type": "FieldInformationResultModel",
|
|
13865
|
+
"drops": []
|
|
13866
|
+
},
|
|
13867
|
+
"examples": [
|
|
13868
|
+
"await client.expenseReportAttachments.getFieldInfo()"
|
|
13869
|
+
],
|
|
13870
|
+
"permissions": "unknown",
|
|
13871
|
+
"pagination": {
|
|
13872
|
+
"mode": "none"
|
|
13873
|
+
},
|
|
13874
|
+
"resolution": null,
|
|
13875
|
+
"retry": {
|
|
13876
|
+
"preset": "retry-ffb3a9cb"
|
|
13877
|
+
},
|
|
13878
|
+
"errors": {
|
|
13879
|
+
"set": 0
|
|
13880
|
+
},
|
|
13881
|
+
"metadata": {
|
|
13882
|
+
"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).",
|
|
13883
|
+
"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.",
|
|
13884
|
+
"preferredWhen": null,
|
|
13885
|
+
"related": [
|
|
13886
|
+
"expense_report_attachments.getEntityInfo"
|
|
13887
|
+
],
|
|
13888
|
+
"untrustedFields": [
|
|
13889
|
+
"title"
|
|
13890
|
+
]
|
|
13891
|
+
},
|
|
13892
|
+
"compact": null,
|
|
13893
|
+
"status": "tested"
|
|
13894
|
+
},
|
|
13895
|
+
{
|
|
13896
|
+
"id": "expense_report_attachments.query",
|
|
13897
|
+
"resource": "expense_report_attachments",
|
|
13898
|
+
"udfCapable": false,
|
|
13899
|
+
"operation": "query",
|
|
13900
|
+
"kind": "primitive",
|
|
13901
|
+
"endpoint": "GET|POST /V1.0/ExpenseReportAttachments/query",
|
|
13902
|
+
"effect": "read",
|
|
13903
|
+
"flags": [],
|
|
13904
|
+
"dryRun": false,
|
|
13905
|
+
"envelope": "QueryActionResult[<Model>,<Entity>]",
|
|
13906
|
+
"inputSchema": {
|
|
13907
|
+
"params": {
|
|
13908
|
+
"type": "object",
|
|
13909
|
+
"required": false,
|
|
13910
|
+
"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.",
|
|
13911
|
+
"properties": [
|
|
13912
|
+
{
|
|
13913
|
+
"name": "filter",
|
|
13914
|
+
"type": "FilterCondition[]",
|
|
13915
|
+
"optional": true
|
|
13916
|
+
},
|
|
13917
|
+
{
|
|
13918
|
+
"name": "limit",
|
|
13919
|
+
"type": "number",
|
|
13920
|
+
"optional": true,
|
|
13921
|
+
"default": 500
|
|
13922
|
+
},
|
|
13923
|
+
{
|
|
13924
|
+
"name": "latest",
|
|
13925
|
+
"type": "number",
|
|
13926
|
+
"optional": true
|
|
13927
|
+
},
|
|
13928
|
+
{
|
|
13929
|
+
"name": "noteChars",
|
|
13930
|
+
"type": "number",
|
|
13931
|
+
"optional": true
|
|
13932
|
+
},
|
|
13933
|
+
{
|
|
13934
|
+
"name": "includeFields",
|
|
13935
|
+
"type": "string[]",
|
|
13936
|
+
"optional": true
|
|
13937
|
+
},
|
|
13938
|
+
{
|
|
13939
|
+
"name": "fieldCheck",
|
|
13940
|
+
"type": "boolean",
|
|
13941
|
+
"optional": true,
|
|
13942
|
+
"default": true
|
|
13943
|
+
},
|
|
13944
|
+
{
|
|
13945
|
+
"name": "names",
|
|
13946
|
+
"type": "boolean",
|
|
13947
|
+
"optional": true
|
|
13948
|
+
},
|
|
13949
|
+
{
|
|
13950
|
+
"name": "via",
|
|
13951
|
+
"type": "\"post\" | \"get\"",
|
|
13952
|
+
"optional": true
|
|
13953
|
+
},
|
|
13954
|
+
{
|
|
13955
|
+
"name": "acknowledgeUnscoped",
|
|
13956
|
+
"type": "boolean",
|
|
13957
|
+
"optional": true
|
|
13958
|
+
},
|
|
13959
|
+
{
|
|
13960
|
+
"name": "walk",
|
|
13961
|
+
"type": "object",
|
|
13962
|
+
"optional": true
|
|
13963
|
+
}
|
|
13964
|
+
]
|
|
13965
|
+
}
|
|
13966
|
+
},
|
|
13967
|
+
"inputSchemaStrict": true,
|
|
13968
|
+
"outputSchema": {
|
|
13969
|
+
"type": "QueryActionResult[<Model>,<Entity>]",
|
|
13970
|
+
"drops": []
|
|
13971
|
+
},
|
|
13972
|
+
"examples": [
|
|
13973
|
+
"await invoke(client, 'expense_report_attachments.query', [{ filter: [{ field: 'expenseReportID', op: 'eq', value: 7 }], limit: 25 }])"
|
|
13974
|
+
],
|
|
13975
|
+
"permissions": "unknown",
|
|
13976
|
+
"pagination": {
|
|
13977
|
+
"mode": "cursor",
|
|
13978
|
+
"vendorDefault": 10,
|
|
13979
|
+
"vendorMax": 500,
|
|
13980
|
+
"pageGuard": 1000,
|
|
13981
|
+
"queryBounded": {
|
|
13982
|
+
"default": 500,
|
|
13983
|
+
"max": 2500
|
|
13984
|
+
}
|
|
13985
|
+
},
|
|
13986
|
+
"resolution": null,
|
|
13987
|
+
"retry": {
|
|
13988
|
+
"preset": "retry-ffb3a9cb"
|
|
13989
|
+
},
|
|
13990
|
+
"errors": {
|
|
13991
|
+
"set": 4
|
|
13992
|
+
},
|
|
13993
|
+
"metadata": {
|
|
13994
|
+
"purpose": "Query ExpenseReportAttachment records with a JSON filter.",
|
|
13995
|
+
"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.",
|
|
13996
|
+
"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).",
|
|
13997
|
+
"related": [
|
|
13998
|
+
"expense_report_attachments.get"
|
|
13999
|
+
],
|
|
14000
|
+
"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.",
|
|
14001
|
+
"untrustedFields": [
|
|
14002
|
+
"title"
|
|
14003
|
+
]
|
|
14004
|
+
},
|
|
14005
|
+
"compact": null,
|
|
14006
|
+
"status": "tested"
|
|
14007
|
+
},
|
|
13532
14008
|
{
|
|
13533
14009
|
"id": "expense_reports.count",
|
|
13534
14010
|
"resource": "expense_reports",
|
|
@@ -23441,6 +23917,482 @@ const CAPABILITY_DATA = {
|
|
|
23441
23917
|
"compact": "QuoteTemplateSummary",
|
|
23442
23918
|
"status": "tested"
|
|
23443
23919
|
},
|
|
23920
|
+
{
|
|
23921
|
+
"id": "resource_attachments.count",
|
|
23922
|
+
"resource": "resource_attachments",
|
|
23923
|
+
"udfCapable": false,
|
|
23924
|
+
"operation": "count",
|
|
23925
|
+
"kind": "primitive",
|
|
23926
|
+
"endpoint": "GET|POST /V1.0/ResourceAttachments/query/count",
|
|
23927
|
+
"effect": "read",
|
|
23928
|
+
"flags": [],
|
|
23929
|
+
"dryRun": false,
|
|
23930
|
+
"envelope": "QueryCountResultModel",
|
|
23931
|
+
"inputSchema": {
|
|
23932
|
+
"params": {
|
|
23933
|
+
"type": "object",
|
|
23934
|
+
"required": false,
|
|
23935
|
+
"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.",
|
|
23936
|
+
"properties": [
|
|
23937
|
+
{
|
|
23938
|
+
"name": "filter",
|
|
23939
|
+
"type": "FilterCondition[]",
|
|
23940
|
+
"optional": true
|
|
23941
|
+
},
|
|
23942
|
+
{
|
|
23943
|
+
"name": "fieldCheck",
|
|
23944
|
+
"type": "boolean",
|
|
23945
|
+
"optional": true
|
|
23946
|
+
}
|
|
23947
|
+
]
|
|
23948
|
+
}
|
|
23949
|
+
},
|
|
23950
|
+
"inputSchemaStrict": true,
|
|
23951
|
+
"outputSchema": {
|
|
23952
|
+
"type": "QueryCountResultModel",
|
|
23953
|
+
"drops": []
|
|
23954
|
+
},
|
|
23955
|
+
"examples": [
|
|
23956
|
+
"await invoke(client, 'resource_attachments.count', [{ filter: [{ field: 'resourceID', op: 'eq', value: 7 }] }])"
|
|
23957
|
+
],
|
|
23958
|
+
"permissions": "unknown",
|
|
23959
|
+
"pagination": {
|
|
23960
|
+
"mode": "none"
|
|
23961
|
+
},
|
|
23962
|
+
"resolution": null,
|
|
23963
|
+
"retry": {
|
|
23964
|
+
"preset": "retry-ffb3a9cb"
|
|
23965
|
+
},
|
|
23966
|
+
"errors": {
|
|
23967
|
+
"set": 0
|
|
23968
|
+
},
|
|
23969
|
+
"metadata": {
|
|
23970
|
+
"purpose": "Count resource attachment records matching a JSON filter. Use resourceID for parent scope.",
|
|
23971
|
+
"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.",
|
|
23972
|
+
"preferredWhen": null,
|
|
23973
|
+
"related": [
|
|
23974
|
+
"resource_attachments.query"
|
|
23975
|
+
],
|
|
23976
|
+
"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.",
|
|
23977
|
+
"untrustedFields": [
|
|
23978
|
+
"title"
|
|
23979
|
+
]
|
|
23980
|
+
},
|
|
23981
|
+
"compact": null,
|
|
23982
|
+
"status": "tested"
|
|
23983
|
+
},
|
|
23984
|
+
{
|
|
23985
|
+
"id": "resource_attachments.create",
|
|
23986
|
+
"resource": "resource_attachments",
|
|
23987
|
+
"udfCapable": false,
|
|
23988
|
+
"operation": "create",
|
|
23989
|
+
"kind": "primitive",
|
|
23990
|
+
"endpoint": "POST /V1.0/Resources/{parentId}/Attachments",
|
|
23991
|
+
"effect": "write",
|
|
23992
|
+
"flags": [],
|
|
23993
|
+
"dryRun": true,
|
|
23994
|
+
"envelope": "OperationResultModel",
|
|
23995
|
+
"inputSchema": {
|
|
23996
|
+
"parentId": {
|
|
23997
|
+
"type": "string | number",
|
|
23998
|
+
"required": true,
|
|
23999
|
+
"description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
|
|
24000
|
+
},
|
|
24001
|
+
"data": {
|
|
24002
|
+
"type": "object",
|
|
24003
|
+
"required": true,
|
|
24004
|
+
"description": "The record payload (vendor model fields)."
|
|
24005
|
+
}
|
|
24006
|
+
},
|
|
24007
|
+
"inputSchemaStrict": true,
|
|
24008
|
+
"outputSchema": {
|
|
24009
|
+
"type": "OperationResultModel",
|
|
24010
|
+
"drops": []
|
|
24011
|
+
},
|
|
24012
|
+
"examples": [
|
|
24013
|
+
"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 });"
|
|
24014
|
+
],
|
|
24015
|
+
"permissions": "unknown",
|
|
24016
|
+
"pagination": {
|
|
24017
|
+
"mode": "none"
|
|
24018
|
+
},
|
|
24019
|
+
"resolution": null,
|
|
24020
|
+
"retry": {
|
|
24021
|
+
"preset": "retry-c5657094"
|
|
24022
|
+
},
|
|
24023
|
+
"errors": {
|
|
24024
|
+
"set": 1
|
|
24025
|
+
},
|
|
24026
|
+
"metadata": {
|
|
24027
|
+
"purpose": "Create a file attachment under a resource.",
|
|
24028
|
+
"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.",
|
|
24029
|
+
"preferredWhen": "Add a new attachment; existing attachments cannot be updated. Replace through separately governed delete and create actions.",
|
|
24030
|
+
"related": [
|
|
24031
|
+
"resource_attachments.get"
|
|
24032
|
+
],
|
|
24033
|
+
"argNotes": {
|
|
24034
|
+
"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."
|
|
24035
|
+
},
|
|
24036
|
+
"untrustedFields": [
|
|
24037
|
+
"title"
|
|
24038
|
+
],
|
|
24039
|
+
"createRequirements": {
|
|
24040
|
+
"requires": {
|
|
24041
|
+
"allOf": [
|
|
24042
|
+
"attachmentType",
|
|
24043
|
+
"fullPath",
|
|
24044
|
+
"title",
|
|
24045
|
+
"publish",
|
|
24046
|
+
"data"
|
|
24047
|
+
]
|
|
24048
|
+
},
|
|
24049
|
+
"requiresByValue": [
|
|
24050
|
+
{
|
|
24051
|
+
"field": "attachmentType",
|
|
24052
|
+
"value": "FILE_ATTACHMENT",
|
|
24053
|
+
"requires": {
|
|
24054
|
+
"allOf": [
|
|
24055
|
+
"data"
|
|
24056
|
+
]
|
|
24057
|
+
}
|
|
24058
|
+
}
|
|
24059
|
+
]
|
|
24060
|
+
}
|
|
24061
|
+
},
|
|
24062
|
+
"compact": null,
|
|
24063
|
+
"status": "tested"
|
|
24064
|
+
},
|
|
24065
|
+
{
|
|
24066
|
+
"id": "resource_attachments.delete",
|
|
24067
|
+
"resource": "resource_attachments",
|
|
24068
|
+
"udfCapable": false,
|
|
24069
|
+
"operation": "delete",
|
|
24070
|
+
"kind": "primitive",
|
|
24071
|
+
"endpoint": "DELETE /V1.0/Resources/{parentId}/Attachments/{id}",
|
|
24072
|
+
"effect": "destructive",
|
|
24073
|
+
"flags": [
|
|
24074
|
+
"idempotent",
|
|
24075
|
+
"requiresApproval"
|
|
24076
|
+
],
|
|
24077
|
+
"dryRun": true,
|
|
24078
|
+
"envelope": "OperationResultModel (attachment entities: the deleted attachment model is returned, not OperationResultModel)",
|
|
24079
|
+
"inputSchema": {
|
|
24080
|
+
"parentId": {
|
|
24081
|
+
"type": "string | number",
|
|
24082
|
+
"required": true,
|
|
24083
|
+
"description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
|
|
24084
|
+
},
|
|
24085
|
+
"id": {
|
|
24086
|
+
"type": "string | number",
|
|
24087
|
+
"required": true,
|
|
24088
|
+
"description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
|
|
24089
|
+
}
|
|
24090
|
+
},
|
|
24091
|
+
"inputSchemaStrict": true,
|
|
24092
|
+
"outputSchema": {
|
|
24093
|
+
"type": "OperationResultModel (attachment entities: the deleted attachment model is returned, not OperationResultModel)",
|
|
24094
|
+
"drops": []
|
|
24095
|
+
},
|
|
24096
|
+
"examples": [
|
|
24097
|
+
"await invoke(client, 'resource_attachments.delete', [7, 3], { confirm: 'resource_attachments.delete' })"
|
|
24098
|
+
],
|
|
24099
|
+
"permissions": "unknown",
|
|
24100
|
+
"pagination": {
|
|
24101
|
+
"mode": "none"
|
|
24102
|
+
},
|
|
24103
|
+
"resolution": null,
|
|
24104
|
+
"retry": {
|
|
24105
|
+
"preset": "retry-1849870d"
|
|
24106
|
+
},
|
|
24107
|
+
"errors": {
|
|
24108
|
+
"set": 2
|
|
24109
|
+
},
|
|
24110
|
+
"metadata": {
|
|
24111
|
+
"purpose": "Delete an attachment under a resource.",
|
|
24112
|
+
"usage": "Irreversible; dry-run validates the target id first. Parent-scoped: parentId + id.",
|
|
24113
|
+
"preferredWhen": null,
|
|
24114
|
+
"related": [
|
|
24115
|
+
"resource_attachments.get"
|
|
24116
|
+
],
|
|
24117
|
+
"untrustedFields": [
|
|
24118
|
+
"title"
|
|
24119
|
+
]
|
|
24120
|
+
},
|
|
24121
|
+
"compact": null,
|
|
24122
|
+
"status": "tested"
|
|
24123
|
+
},
|
|
24124
|
+
{
|
|
24125
|
+
"id": "resource_attachments.get",
|
|
24126
|
+
"resource": "resource_attachments",
|
|
24127
|
+
"udfCapable": false,
|
|
24128
|
+
"operation": "get",
|
|
24129
|
+
"kind": "primitive",
|
|
24130
|
+
"endpoint": "GET /V1.0/Resources/{parentId}/Attachments/{id}",
|
|
24131
|
+
"effect": "read",
|
|
24132
|
+
"flags": [],
|
|
24133
|
+
"dryRun": false,
|
|
24134
|
+
"envelope": "ResourceAttachmentModel",
|
|
24135
|
+
"inputSchema": {
|
|
24136
|
+
"parentId": {
|
|
24137
|
+
"type": "string | number",
|
|
24138
|
+
"required": true,
|
|
24139
|
+
"description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
|
|
24140
|
+
},
|
|
24141
|
+
"id": {
|
|
24142
|
+
"type": "string | number",
|
|
24143
|
+
"required": true,
|
|
24144
|
+
"description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
|
|
24145
|
+
},
|
|
24146
|
+
"opts": {
|
|
24147
|
+
"type": "object",
|
|
24148
|
+
"required": false,
|
|
24149
|
+
"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.",
|
|
24150
|
+
"properties": [
|
|
24151
|
+
{
|
|
24152
|
+
"name": "fresh",
|
|
24153
|
+
"type": "boolean",
|
|
24154
|
+
"optional": true
|
|
24155
|
+
}
|
|
24156
|
+
]
|
|
24157
|
+
}
|
|
24158
|
+
},
|
|
24159
|
+
"inputSchemaStrict": true,
|
|
24160
|
+
"outputSchema": {
|
|
24161
|
+
"type": "ResourceAttachmentModel",
|
|
24162
|
+
"drops": []
|
|
24163
|
+
},
|
|
24164
|
+
"examples": [
|
|
24165
|
+
"await client.resourceAttachments.get(7, 3)"
|
|
24166
|
+
],
|
|
24167
|
+
"permissions": "unknown",
|
|
24168
|
+
"pagination": {
|
|
24169
|
+
"mode": "none"
|
|
24170
|
+
},
|
|
24171
|
+
"resolution": null,
|
|
24172
|
+
"retry": {
|
|
24173
|
+
"preset": "retry-ffb3a9cb"
|
|
24174
|
+
},
|
|
24175
|
+
"errors": {
|
|
24176
|
+
"set": 3
|
|
24177
|
+
},
|
|
24178
|
+
"metadata": {
|
|
24179
|
+
"purpose": "Get one ResourceAttachment by id.",
|
|
24180
|
+
"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.",
|
|
24181
|
+
"preferredWhen": "Use a known attachment id; query the scoped collection to discover ids.",
|
|
24182
|
+
"related": [
|
|
24183
|
+
"resource_attachments.query"
|
|
24184
|
+
],
|
|
24185
|
+
"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.",
|
|
24186
|
+
"untrustedFields": [
|
|
24187
|
+
"title"
|
|
24188
|
+
]
|
|
24189
|
+
},
|
|
24190
|
+
"compact": null,
|
|
24191
|
+
"status": "tested"
|
|
24192
|
+
},
|
|
24193
|
+
{
|
|
24194
|
+
"id": "resource_attachments.getEntityInfo",
|
|
24195
|
+
"resource": "resource_attachments",
|
|
24196
|
+
"udfCapable": false,
|
|
24197
|
+
"operation": "getEntityInfo",
|
|
24198
|
+
"kind": "primitive",
|
|
24199
|
+
"endpoint": "GET /V1.0/ResourceAttachments/entityInformation",
|
|
24200
|
+
"effect": "read",
|
|
24201
|
+
"flags": [],
|
|
24202
|
+
"dryRun": false,
|
|
24203
|
+
"envelope": "EntityInformationResultModel",
|
|
24204
|
+
"inputSchema": {},
|
|
24205
|
+
"inputSchemaStrict": true,
|
|
24206
|
+
"outputSchema": {
|
|
24207
|
+
"type": "EntityInformationResultModel",
|
|
24208
|
+
"drops": []
|
|
24209
|
+
},
|
|
24210
|
+
"examples": [
|
|
24211
|
+
"await client.resourceAttachments.getEntityInfo()"
|
|
24212
|
+
],
|
|
24213
|
+
"permissions": "unknown",
|
|
24214
|
+
"pagination": {
|
|
24215
|
+
"mode": "none"
|
|
24216
|
+
},
|
|
24217
|
+
"resolution": null,
|
|
24218
|
+
"retry": {
|
|
24219
|
+
"preset": "retry-ffb3a9cb"
|
|
24220
|
+
},
|
|
24221
|
+
"errors": {
|
|
24222
|
+
"set": 0
|
|
24223
|
+
},
|
|
24224
|
+
"metadata": {
|
|
24225
|
+
"purpose": "Get the ResourceAttachment capability metadata (canCreate/canUpdate/hasUserDefinedFields/...).",
|
|
24226
|
+
"usage": "Unwraps info{}; drives client-side capability checks.",
|
|
24227
|
+
"preferredWhen": null,
|
|
24228
|
+
"related": [
|
|
24229
|
+
"resource_attachments.getFieldInfo"
|
|
24230
|
+
],
|
|
24231
|
+
"untrustedFields": [
|
|
24232
|
+
"title"
|
|
24233
|
+
]
|
|
24234
|
+
},
|
|
24235
|
+
"compact": null,
|
|
24236
|
+
"status": "tested"
|
|
24237
|
+
},
|
|
24238
|
+
{
|
|
24239
|
+
"id": "resource_attachments.getFieldInfo",
|
|
24240
|
+
"resource": "resource_attachments",
|
|
24241
|
+
"udfCapable": false,
|
|
24242
|
+
"operation": "getFieldInfo",
|
|
24243
|
+
"kind": "primitive",
|
|
24244
|
+
"endpoint": "GET /V1.0/ResourceAttachments/entityInformation/fields",
|
|
24245
|
+
"effect": "read",
|
|
24246
|
+
"flags": [],
|
|
24247
|
+
"dryRun": false,
|
|
24248
|
+
"envelope": "FieldInformationResultModel",
|
|
24249
|
+
"inputSchema": {},
|
|
24250
|
+
"inputSchemaStrict": true,
|
|
24251
|
+
"outputSchema": {
|
|
24252
|
+
"type": "FieldInformationResultModel",
|
|
24253
|
+
"drops": []
|
|
24254
|
+
},
|
|
24255
|
+
"examples": [
|
|
24256
|
+
"await client.resourceAttachments.getFieldInfo()"
|
|
24257
|
+
],
|
|
24258
|
+
"permissions": "unknown",
|
|
24259
|
+
"pagination": {
|
|
24260
|
+
"mode": "none"
|
|
24261
|
+
},
|
|
24262
|
+
"resolution": null,
|
|
24263
|
+
"retry": {
|
|
24264
|
+
"preset": "retry-ffb3a9cb"
|
|
24265
|
+
},
|
|
24266
|
+
"errors": {
|
|
24267
|
+
"set": 0
|
|
24268
|
+
},
|
|
24269
|
+
"metadata": {
|
|
24270
|
+
"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).",
|
|
24271
|
+
"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.",
|
|
24272
|
+
"preferredWhen": null,
|
|
24273
|
+
"related": [
|
|
24274
|
+
"resource_attachments.getEntityInfo"
|
|
24275
|
+
],
|
|
24276
|
+
"untrustedFields": [
|
|
24277
|
+
"title"
|
|
24278
|
+
]
|
|
24279
|
+
},
|
|
24280
|
+
"compact": null,
|
|
24281
|
+
"status": "tested"
|
|
24282
|
+
},
|
|
24283
|
+
{
|
|
24284
|
+
"id": "resource_attachments.query",
|
|
24285
|
+
"resource": "resource_attachments",
|
|
24286
|
+
"udfCapable": false,
|
|
24287
|
+
"operation": "query",
|
|
24288
|
+
"kind": "primitive",
|
|
24289
|
+
"endpoint": "GET|POST /V1.0/ResourceAttachments/query",
|
|
24290
|
+
"effect": "read",
|
|
24291
|
+
"flags": [],
|
|
24292
|
+
"dryRun": false,
|
|
24293
|
+
"envelope": "QueryActionResult[<Model>,<Entity>]",
|
|
24294
|
+
"inputSchema": {
|
|
24295
|
+
"params": {
|
|
24296
|
+
"type": "object",
|
|
24297
|
+
"required": false,
|
|
24298
|
+
"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.",
|
|
24299
|
+
"properties": [
|
|
24300
|
+
{
|
|
24301
|
+
"name": "filter",
|
|
24302
|
+
"type": "FilterCondition[]",
|
|
24303
|
+
"optional": true
|
|
24304
|
+
},
|
|
24305
|
+
{
|
|
24306
|
+
"name": "limit",
|
|
24307
|
+
"type": "number",
|
|
24308
|
+
"optional": true,
|
|
24309
|
+
"default": 500
|
|
24310
|
+
},
|
|
24311
|
+
{
|
|
24312
|
+
"name": "latest",
|
|
24313
|
+
"type": "number",
|
|
24314
|
+
"optional": true
|
|
24315
|
+
},
|
|
24316
|
+
{
|
|
24317
|
+
"name": "noteChars",
|
|
24318
|
+
"type": "number",
|
|
24319
|
+
"optional": true
|
|
24320
|
+
},
|
|
24321
|
+
{
|
|
24322
|
+
"name": "includeFields",
|
|
24323
|
+
"type": "string[]",
|
|
24324
|
+
"optional": true
|
|
24325
|
+
},
|
|
24326
|
+
{
|
|
24327
|
+
"name": "fieldCheck",
|
|
24328
|
+
"type": "boolean",
|
|
24329
|
+
"optional": true,
|
|
24330
|
+
"default": true
|
|
24331
|
+
},
|
|
24332
|
+
{
|
|
24333
|
+
"name": "names",
|
|
24334
|
+
"type": "boolean",
|
|
24335
|
+
"optional": true
|
|
24336
|
+
},
|
|
24337
|
+
{
|
|
24338
|
+
"name": "via",
|
|
24339
|
+
"type": "\"post\" | \"get\"",
|
|
24340
|
+
"optional": true
|
|
24341
|
+
},
|
|
24342
|
+
{
|
|
24343
|
+
"name": "acknowledgeUnscoped",
|
|
24344
|
+
"type": "boolean",
|
|
24345
|
+
"optional": true
|
|
24346
|
+
},
|
|
24347
|
+
{
|
|
24348
|
+
"name": "walk",
|
|
24349
|
+
"type": "object",
|
|
24350
|
+
"optional": true
|
|
24351
|
+
}
|
|
24352
|
+
]
|
|
24353
|
+
}
|
|
24354
|
+
},
|
|
24355
|
+
"inputSchemaStrict": true,
|
|
24356
|
+
"outputSchema": {
|
|
24357
|
+
"type": "QueryActionResult[<Model>,<Entity>]",
|
|
24358
|
+
"drops": []
|
|
24359
|
+
},
|
|
24360
|
+
"examples": [
|
|
24361
|
+
"await invoke(client, 'resource_attachments.query', [{ filter: [{ field: 'resourceID', op: 'eq', value: 7 }], limit: 25 }])"
|
|
24362
|
+
],
|
|
24363
|
+
"permissions": "unknown",
|
|
24364
|
+
"pagination": {
|
|
24365
|
+
"mode": "cursor",
|
|
24366
|
+
"vendorDefault": 10,
|
|
24367
|
+
"vendorMax": 500,
|
|
24368
|
+
"pageGuard": 1000,
|
|
24369
|
+
"queryBounded": {
|
|
24370
|
+
"default": 500,
|
|
24371
|
+
"max": 2500
|
|
24372
|
+
}
|
|
24373
|
+
},
|
|
24374
|
+
"resolution": null,
|
|
24375
|
+
"retry": {
|
|
24376
|
+
"preset": "retry-ffb3a9cb"
|
|
24377
|
+
},
|
|
24378
|
+
"errors": {
|
|
24379
|
+
"set": 4
|
|
24380
|
+
},
|
|
24381
|
+
"metadata": {
|
|
24382
|
+
"purpose": "Query ResourceAttachment records with a JSON filter.",
|
|
24383
|
+
"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.",
|
|
24384
|
+
"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).",
|
|
24385
|
+
"related": [
|
|
24386
|
+
"resource_attachments.get"
|
|
24387
|
+
],
|
|
24388
|
+
"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.",
|
|
24389
|
+
"untrustedFields": [
|
|
24390
|
+
"title"
|
|
24391
|
+
]
|
|
24392
|
+
},
|
|
24393
|
+
"compact": null,
|
|
24394
|
+
"status": "tested"
|
|
24395
|
+
},
|
|
23444
24396
|
{
|
|
23445
24397
|
"id": "resource_role_queues.count",
|
|
23446
24398
|
"resource": "resource_role_queues",
|
|
@@ -43802,8 +44754,8 @@ const CAPABILITY_DATA = {
|
|
|
43802
44754
|
]
|
|
43803
44755
|
},
|
|
43804
44756
|
"A": {
|
|
43805
|
-
"planHash": "
|
|
43806
|
-
"builtAt": "2026-11-
|
|
44757
|
+
"planHash": "d758816a699191e3da784f70f8ebe1f37ea9458aaf528241770f7bac94ba6ede",
|
|
44758
|
+
"builtAt": "2026-11-19T12:16:58.732Z",
|
|
43807
44759
|
"records": [
|
|
43808
44760
|
{
|
|
43809
44761
|
"id": "attachment_info.count",
|
|
@@ -88970,8 +89922,8 @@ const CAPABILITY_DATA = {
|
|
|
88970
89922
|
]
|
|
88971
89923
|
},
|
|
88972
89924
|
"operations": {
|
|
88973
|
-
"planHash": "
|
|
88974
|
-
"builtAt": "2026-11-
|
|
89925
|
+
"planHash": "d758816a699191e3da784f70f8ebe1f37ea9458aaf528241770f7bac94ba6ede",
|
|
89926
|
+
"builtAt": "2026-11-19T12:16:58.732Z",
|
|
88975
89927
|
"records": [
|
|
88976
89928
|
{
|
|
88977
89929
|
"id": "operations.aggregate",
|