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
|
@@ -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",
|
|
@@ -23442,12 +23918,12 @@ const CAPABILITY_DATA = {
|
|
|
23442
23918
|
"status": "tested"
|
|
23443
23919
|
},
|
|
23444
23920
|
{
|
|
23445
|
-
"id": "
|
|
23446
|
-
"resource": "
|
|
23921
|
+
"id": "resource_attachments.count",
|
|
23922
|
+
"resource": "resource_attachments",
|
|
23447
23923
|
"udfCapable": false,
|
|
23448
23924
|
"operation": "count",
|
|
23449
23925
|
"kind": "primitive",
|
|
23450
|
-
"endpoint": "GET|POST /V1.0/
|
|
23926
|
+
"endpoint": "GET|POST /V1.0/ResourceAttachments/query/count",
|
|
23451
23927
|
"effect": "read",
|
|
23452
23928
|
"flags": [],
|
|
23453
23929
|
"dryRun": false,
|
|
@@ -23477,7 +23953,7 @@ const CAPABILITY_DATA = {
|
|
|
23477
23953
|
"drops": []
|
|
23478
23954
|
},
|
|
23479
23955
|
"examples": [
|
|
23480
|
-
"await client.
|
|
23956
|
+
"await invoke(client, 'resource_attachments.count', [{ filter: [{ field: 'resourceID', op: 'eq', value: 7 }] }])"
|
|
23481
23957
|
],
|
|
23482
23958
|
"permissions": "unknown",
|
|
23483
23959
|
"pagination": {
|
|
@@ -23491,24 +23967,27 @@ const CAPABILITY_DATA = {
|
|
|
23491
23967
|
"set": 0
|
|
23492
23968
|
},
|
|
23493
23969
|
"metadata": {
|
|
23494
|
-
"purpose": "Count resource
|
|
23495
|
-
"usage": "Unwraps queryCount; returns a plain number.",
|
|
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.",
|
|
23496
23972
|
"preferredWhen": null,
|
|
23497
23973
|
"related": [
|
|
23498
|
-
"
|
|
23974
|
+
"resource_attachments.query"
|
|
23499
23975
|
],
|
|
23500
|
-
"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."
|
|
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
|
+
]
|
|
23501
23980
|
},
|
|
23502
23981
|
"compact": null,
|
|
23503
23982
|
"status": "tested"
|
|
23504
23983
|
},
|
|
23505
23984
|
{
|
|
23506
|
-
"id": "
|
|
23507
|
-
"resource": "
|
|
23985
|
+
"id": "resource_attachments.create",
|
|
23986
|
+
"resource": "resource_attachments",
|
|
23508
23987
|
"udfCapable": false,
|
|
23509
23988
|
"operation": "create",
|
|
23510
23989
|
"kind": "primitive",
|
|
23511
|
-
"endpoint": "POST /V1.0/Resources/{parentId}/
|
|
23990
|
+
"endpoint": "POST /V1.0/Resources/{parentId}/Attachments",
|
|
23512
23991
|
"effect": "write",
|
|
23513
23992
|
"flags": [],
|
|
23514
23993
|
"dryRun": true,
|
|
@@ -23531,7 +24010,7 @@ const CAPABILITY_DATA = {
|
|
|
23531
24010
|
"drops": []
|
|
23532
24011
|
},
|
|
23533
24012
|
"examples": [
|
|
23534
|
-
"await client.
|
|
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 });"
|
|
23535
24014
|
],
|
|
23536
24015
|
"permissions": "unknown",
|
|
23537
24016
|
"pagination": {
|
|
@@ -23545,33 +24024,58 @@ const CAPABILITY_DATA = {
|
|
|
23545
24024
|
"set": 1
|
|
23546
24025
|
},
|
|
23547
24026
|
"metadata": {
|
|
23548
|
-
"purpose": "Create a
|
|
23549
|
-
"usage": "
|
|
23550
|
-
"preferredWhen": "
|
|
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.",
|
|
23551
24030
|
"related": [
|
|
23552
|
-
"
|
|
24031
|
+
"resource_attachments.get"
|
|
23553
24032
|
],
|
|
23554
|
-
"
|
|
23555
|
-
"
|
|
23556
|
-
"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.",
|
|
23557
|
-
"proof": "spec-derived"
|
|
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."
|
|
23558
24035
|
},
|
|
23559
|
-
"
|
|
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
|
+
}
|
|
23560
24061
|
},
|
|
23561
24062
|
"compact": null,
|
|
23562
24063
|
"status": "tested"
|
|
23563
24064
|
},
|
|
23564
24065
|
{
|
|
23565
|
-
"id": "
|
|
23566
|
-
"resource": "
|
|
24066
|
+
"id": "resource_attachments.delete",
|
|
24067
|
+
"resource": "resource_attachments",
|
|
23567
24068
|
"udfCapable": false,
|
|
23568
|
-
"operation": "
|
|
24069
|
+
"operation": "delete",
|
|
23569
24070
|
"kind": "primitive",
|
|
23570
|
-
"endpoint": "
|
|
23571
|
-
"effect": "
|
|
23572
|
-
"flags": [
|
|
23573
|
-
|
|
23574
|
-
|
|
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)",
|
|
23575
24079
|
"inputSchema": {
|
|
23576
24080
|
"parentId": {
|
|
23577
24081
|
"type": "string | number",
|
|
@@ -23582,27 +24086,15 @@ const CAPABILITY_DATA = {
|
|
|
23582
24086
|
"type": "string | number",
|
|
23583
24087
|
"required": true,
|
|
23584
24088
|
"description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
|
|
23585
|
-
},
|
|
23586
|
-
"opts": {
|
|
23587
|
-
"type": "object",
|
|
23588
|
-
"required": false,
|
|
23589
|
-
"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.",
|
|
23590
|
-
"properties": [
|
|
23591
|
-
{
|
|
23592
|
-
"name": "fresh",
|
|
23593
|
-
"type": "boolean",
|
|
23594
|
-
"optional": true
|
|
23595
|
-
}
|
|
23596
|
-
]
|
|
23597
24089
|
}
|
|
23598
24090
|
},
|
|
23599
24091
|
"inputSchemaStrict": true,
|
|
23600
24092
|
"outputSchema": {
|
|
23601
|
-
"type": "
|
|
24093
|
+
"type": "OperationResultModel (attachment entities: the deleted attachment model is returned, not OperationResultModel)",
|
|
23602
24094
|
"drops": []
|
|
23603
24095
|
},
|
|
23604
24096
|
"examples": [
|
|
23605
|
-
"await client.
|
|
24097
|
+
"await invoke(client, 'resource_attachments.delete', [7, 3], { confirm: 'resource_attachments.delete' })"
|
|
23606
24098
|
],
|
|
23607
24099
|
"permissions": "unknown",
|
|
23608
24100
|
"pagination": {
|
|
@@ -23610,42 +24102,67 @@ const CAPABILITY_DATA = {
|
|
|
23610
24102
|
},
|
|
23611
24103
|
"resolution": null,
|
|
23612
24104
|
"retry": {
|
|
23613
|
-
"preset": "retry-
|
|
24105
|
+
"preset": "retry-1849870d"
|
|
23614
24106
|
},
|
|
23615
24107
|
"errors": {
|
|
23616
|
-
"set":
|
|
24108
|
+
"set": 2
|
|
23617
24109
|
},
|
|
23618
24110
|
"metadata": {
|
|
23619
|
-
"purpose": "
|
|
23620
|
-
"usage": "
|
|
23621
|
-
"preferredWhen":
|
|
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,
|
|
23622
24114
|
"related": [
|
|
23623
|
-
"
|
|
24115
|
+
"resource_attachments.get"
|
|
23624
24116
|
],
|
|
23625
|
-
"
|
|
24117
|
+
"untrustedFields": [
|
|
24118
|
+
"title"
|
|
24119
|
+
]
|
|
23626
24120
|
},
|
|
23627
24121
|
"compact": null,
|
|
23628
24122
|
"status": "tested"
|
|
23629
24123
|
},
|
|
23630
24124
|
{
|
|
23631
|
-
"id": "
|
|
23632
|
-
"resource": "
|
|
24125
|
+
"id": "resource_attachments.get",
|
|
24126
|
+
"resource": "resource_attachments",
|
|
23633
24127
|
"udfCapable": false,
|
|
23634
|
-
"operation": "
|
|
24128
|
+
"operation": "get",
|
|
23635
24129
|
"kind": "primitive",
|
|
23636
|
-
"endpoint": "GET /V1.0/
|
|
24130
|
+
"endpoint": "GET /V1.0/Resources/{parentId}/Attachments/{id}",
|
|
23637
24131
|
"effect": "read",
|
|
23638
24132
|
"flags": [],
|
|
23639
24133
|
"dryRun": false,
|
|
23640
|
-
"envelope": "
|
|
23641
|
-
"inputSchema": {
|
|
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
|
+
},
|
|
23642
24159
|
"inputSchemaStrict": true,
|
|
23643
24160
|
"outputSchema": {
|
|
23644
|
-
"type": "
|
|
24161
|
+
"type": "ResourceAttachmentModel",
|
|
23645
24162
|
"drops": []
|
|
23646
24163
|
},
|
|
23647
24164
|
"examples": [
|
|
23648
|
-
"await client.
|
|
24165
|
+
"await client.resourceAttachments.get(7, 3)"
|
|
23649
24166
|
],
|
|
23650
24167
|
"permissions": "unknown",
|
|
23651
24168
|
"pagination": {
|
|
@@ -23656,38 +24173,42 @@ const CAPABILITY_DATA = {
|
|
|
23656
24173
|
"preset": "retry-ffb3a9cb"
|
|
23657
24174
|
},
|
|
23658
24175
|
"errors": {
|
|
23659
|
-
"set":
|
|
24176
|
+
"set": 3
|
|
23660
24177
|
},
|
|
23661
24178
|
"metadata": {
|
|
23662
|
-
"purpose": "Get
|
|
23663
|
-
"usage": "
|
|
23664
|
-
"preferredWhen":
|
|
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.",
|
|
23665
24182
|
"related": [
|
|
23666
|
-
"
|
|
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"
|
|
23667
24188
|
]
|
|
23668
24189
|
},
|
|
23669
24190
|
"compact": null,
|
|
23670
24191
|
"status": "tested"
|
|
23671
24192
|
},
|
|
23672
24193
|
{
|
|
23673
|
-
"id": "
|
|
23674
|
-
"resource": "
|
|
24194
|
+
"id": "resource_attachments.getEntityInfo",
|
|
24195
|
+
"resource": "resource_attachments",
|
|
23675
24196
|
"udfCapable": false,
|
|
23676
|
-
"operation": "
|
|
24197
|
+
"operation": "getEntityInfo",
|
|
23677
24198
|
"kind": "primitive",
|
|
23678
|
-
"endpoint": "GET /V1.0/
|
|
24199
|
+
"endpoint": "GET /V1.0/ResourceAttachments/entityInformation",
|
|
23679
24200
|
"effect": "read",
|
|
23680
24201
|
"flags": [],
|
|
23681
24202
|
"dryRun": false,
|
|
23682
|
-
"envelope": "
|
|
24203
|
+
"envelope": "EntityInformationResultModel",
|
|
23683
24204
|
"inputSchema": {},
|
|
23684
24205
|
"inputSchemaStrict": true,
|
|
23685
24206
|
"outputSchema": {
|
|
23686
|
-
"type": "
|
|
24207
|
+
"type": "EntityInformationResultModel",
|
|
23687
24208
|
"drops": []
|
|
23688
24209
|
},
|
|
23689
24210
|
"examples": [
|
|
23690
|
-
"await client.
|
|
24211
|
+
"await client.resourceAttachments.getEntityInfo()"
|
|
23691
24212
|
],
|
|
23692
24213
|
"permissions": "unknown",
|
|
23693
24214
|
"pagination": {
|
|
@@ -23701,36 +24222,38 @@ const CAPABILITY_DATA = {
|
|
|
23701
24222
|
"set": 0
|
|
23702
24223
|
},
|
|
23703
24224
|
"metadata": {
|
|
23704
|
-
"purpose": "Get the
|
|
23705
|
-
"usage": "Unwraps
|
|
24225
|
+
"purpose": "Get the ResourceAttachment capability metadata (canCreate/canUpdate/hasUserDefinedFields/...).",
|
|
24226
|
+
"usage": "Unwraps info{}; drives client-side capability checks.",
|
|
23706
24227
|
"preferredWhen": null,
|
|
23707
24228
|
"related": [
|
|
23708
|
-
"
|
|
23709
|
-
|
|
24229
|
+
"resource_attachments.getFieldInfo"
|
|
24230
|
+
],
|
|
24231
|
+
"untrustedFields": [
|
|
24232
|
+
"title"
|
|
23710
24233
|
]
|
|
23711
24234
|
},
|
|
23712
24235
|
"compact": null,
|
|
23713
24236
|
"status": "tested"
|
|
23714
24237
|
},
|
|
23715
24238
|
{
|
|
23716
|
-
"id": "
|
|
23717
|
-
"resource": "
|
|
24239
|
+
"id": "resource_attachments.getFieldInfo",
|
|
24240
|
+
"resource": "resource_attachments",
|
|
23718
24241
|
"udfCapable": false,
|
|
23719
|
-
"operation": "
|
|
24242
|
+
"operation": "getFieldInfo",
|
|
23720
24243
|
"kind": "primitive",
|
|
23721
|
-
"endpoint": "GET /V1.0/
|
|
24244
|
+
"endpoint": "GET /V1.0/ResourceAttachments/entityInformation/fields",
|
|
23722
24245
|
"effect": "read",
|
|
23723
24246
|
"flags": [],
|
|
23724
24247
|
"dryRun": false,
|
|
23725
|
-
"envelope": "
|
|
24248
|
+
"envelope": "FieldInformationResultModel",
|
|
23726
24249
|
"inputSchema": {},
|
|
23727
24250
|
"inputSchemaStrict": true,
|
|
23728
24251
|
"outputSchema": {
|
|
23729
|
-
"type": "
|
|
24252
|
+
"type": "FieldInformationResultModel",
|
|
23730
24253
|
"drops": []
|
|
23731
24254
|
},
|
|
23732
24255
|
"examples": [
|
|
23733
|
-
"await client.
|
|
24256
|
+
"await client.resourceAttachments.getFieldInfo()"
|
|
23734
24257
|
],
|
|
23735
24258
|
"permissions": "unknown",
|
|
23736
24259
|
"pagination": {
|
|
@@ -23744,23 +24267,26 @@ const CAPABILITY_DATA = {
|
|
|
23744
24267
|
"set": 0
|
|
23745
24268
|
},
|
|
23746
24269
|
"metadata": {
|
|
23747
|
-
"purpose": "Get the
|
|
23748
|
-
"usage": "Unwraps fields[];
|
|
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.",
|
|
23749
24272
|
"preferredWhen": null,
|
|
23750
24273
|
"related": [
|
|
23751
|
-
"
|
|
24274
|
+
"resource_attachments.getEntityInfo"
|
|
24275
|
+
],
|
|
24276
|
+
"untrustedFields": [
|
|
24277
|
+
"title"
|
|
23752
24278
|
]
|
|
23753
24279
|
},
|
|
23754
24280
|
"compact": null,
|
|
23755
24281
|
"status": "tested"
|
|
23756
24282
|
},
|
|
23757
24283
|
{
|
|
23758
|
-
"id": "
|
|
23759
|
-
"resource": "
|
|
24284
|
+
"id": "resource_attachments.query",
|
|
24285
|
+
"resource": "resource_attachments",
|
|
23760
24286
|
"udfCapable": false,
|
|
23761
24287
|
"operation": "query",
|
|
23762
24288
|
"kind": "primitive",
|
|
23763
|
-
"endpoint": "GET|POST /V1.0/
|
|
24289
|
+
"endpoint": "GET|POST /V1.0/ResourceAttachments/query",
|
|
23764
24290
|
"effect": "read",
|
|
23765
24291
|
"flags": [],
|
|
23766
24292
|
"dryRun": false,
|
|
@@ -23832,7 +24358,7 @@ const CAPABILITY_DATA = {
|
|
|
23832
24358
|
"drops": []
|
|
23833
24359
|
},
|
|
23834
24360
|
"examples": [
|
|
23835
|
-
"await client.
|
|
24361
|
+
"await invoke(client, 'resource_attachments.query', [{ filter: [{ field: 'resourceID', op: 'eq', value: 7 }], limit: 25 }])"
|
|
23836
24362
|
],
|
|
23837
24363
|
"permissions": "unknown",
|
|
23838
24364
|
"pagination": {
|
|
@@ -23853,41 +24379,44 @@ const CAPABILITY_DATA = {
|
|
|
23853
24379
|
"set": 4
|
|
23854
24380
|
},
|
|
23855
24381
|
"metadata": {
|
|
23856
|
-
"purpose": "Query
|
|
23857
|
-
"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.",
|
|
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.",
|
|
23858
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).",
|
|
23859
24385
|
"related": [
|
|
23860
|
-
"
|
|
24386
|
+
"resource_attachments.get"
|
|
23861
24387
|
],
|
|
23862
|
-
"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."
|
|
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
|
+
]
|
|
23863
24392
|
},
|
|
23864
24393
|
"compact": null,
|
|
23865
24394
|
"status": "tested"
|
|
23866
24395
|
},
|
|
23867
24396
|
{
|
|
23868
|
-
"id": "resource_role_queues.
|
|
24397
|
+
"id": "resource_role_queues.count",
|
|
23869
24398
|
"resource": "resource_role_queues",
|
|
23870
24399
|
"udfCapable": false,
|
|
23871
|
-
"operation": "
|
|
23872
|
-
"kind": "
|
|
23873
|
-
"endpoint":
|
|
24400
|
+
"operation": "count",
|
|
24401
|
+
"kind": "primitive",
|
|
24402
|
+
"endpoint": "GET|POST /V1.0/ResourceRoleQueues/query/count",
|
|
23874
24403
|
"effect": "read",
|
|
23875
24404
|
"flags": [],
|
|
23876
24405
|
"dryRun": false,
|
|
23877
|
-
"envelope":
|
|
24406
|
+
"envelope": "QueryCountResultModel",
|
|
23878
24407
|
"inputSchema": {
|
|
23879
|
-
"
|
|
23880
|
-
"type": "string | number",
|
|
23881
|
-
"required": true,
|
|
23882
|
-
"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)."
|
|
23883
|
-
},
|
|
23884
|
-
"opts": {
|
|
24408
|
+
"params": {
|
|
23885
24409
|
"type": "object",
|
|
23886
24410
|
"required": false,
|
|
23887
|
-
"description": "
|
|
24411
|
+
"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.",
|
|
23888
24412
|
"properties": [
|
|
23889
24413
|
{
|
|
23890
|
-
"name": "
|
|
24414
|
+
"name": "filter",
|
|
24415
|
+
"type": "FilterCondition[]",
|
|
24416
|
+
"optional": true
|
|
24417
|
+
},
|
|
24418
|
+
{
|
|
24419
|
+
"name": "fieldCheck",
|
|
23891
24420
|
"type": "boolean",
|
|
23892
24421
|
"optional": true
|
|
23893
24422
|
}
|
|
@@ -23896,49 +24425,44 @@ const CAPABILITY_DATA = {
|
|
|
23896
24425
|
},
|
|
23897
24426
|
"inputSchemaStrict": true,
|
|
23898
24427
|
"outputSchema": {
|
|
23899
|
-
"type": "
|
|
24428
|
+
"type": "QueryCountResultModel",
|
|
23900
24429
|
"drops": []
|
|
23901
24430
|
},
|
|
23902
24431
|
"examples": [
|
|
23903
|
-
"await client.resourceRoleQueues.
|
|
24432
|
+
"await client.resourceRoleQueues.count({ filter: [{ field: 'name', op: 'eq', value: 'example' }] })"
|
|
23904
24433
|
],
|
|
23905
24434
|
"permissions": "unknown",
|
|
23906
24435
|
"pagination": {
|
|
23907
24436
|
"mode": "none"
|
|
23908
24437
|
},
|
|
23909
|
-
"resolution":
|
|
23910
|
-
"basis": "server-filter",
|
|
23911
|
-
"maxScanRecords": 500,
|
|
23912
|
-
"maxScanPages": 4
|
|
23913
|
-
},
|
|
24438
|
+
"resolution": null,
|
|
23914
24439
|
"retry": {
|
|
23915
24440
|
"preset": "retry-ffb3a9cb"
|
|
23916
24441
|
},
|
|
23917
24442
|
"errors": {
|
|
23918
|
-
"set":
|
|
24443
|
+
"set": 0
|
|
23919
24444
|
},
|
|
23920
24445
|
"metadata": {
|
|
23921
|
-
"purpose": "
|
|
23922
|
-
"usage": "
|
|
24446
|
+
"purpose": "Count resource role queue records matching a JSON filter.",
|
|
24447
|
+
"usage": "Unwraps queryCount; returns a plain number.",
|
|
23923
24448
|
"preferredWhen": null,
|
|
23924
24449
|
"related": [
|
|
23925
|
-
"resource_role_queues.
|
|
23926
|
-
]
|
|
24450
|
+
"resource_role_queues.query"
|
|
24451
|
+
],
|
|
24452
|
+
"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."
|
|
23927
24453
|
},
|
|
23928
|
-
"compact":
|
|
24454
|
+
"compact": null,
|
|
23929
24455
|
"status": "tested"
|
|
23930
24456
|
},
|
|
23931
24457
|
{
|
|
23932
|
-
"id": "resource_role_queues.
|
|
24458
|
+
"id": "resource_role_queues.create",
|
|
23933
24459
|
"resource": "resource_role_queues",
|
|
23934
24460
|
"udfCapable": false,
|
|
23935
|
-
"operation": "
|
|
24461
|
+
"operation": "create",
|
|
23936
24462
|
"kind": "primitive",
|
|
23937
|
-
"endpoint": "
|
|
24463
|
+
"endpoint": "POST /V1.0/Resources/{parentId}/RoleQueues",
|
|
23938
24464
|
"effect": "write",
|
|
23939
|
-
"flags": [
|
|
23940
|
-
"idempotent"
|
|
23941
|
-
],
|
|
24465
|
+
"flags": [],
|
|
23942
24466
|
"dryRun": true,
|
|
23943
24467
|
"envelope": "OperationResultModel",
|
|
23944
24468
|
"inputSchema": {
|
|
@@ -23947,11 +24471,6 @@ const CAPABILITY_DATA = {
|
|
|
23947
24471
|
"required": true,
|
|
23948
24472
|
"description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
|
|
23949
24473
|
},
|
|
23950
|
-
"id": {
|
|
23951
|
-
"type": "string | number",
|
|
23952
|
-
"required": true,
|
|
23953
|
-
"description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
|
|
23954
|
-
},
|
|
23955
24474
|
"data": {
|
|
23956
24475
|
"type": "object",
|
|
23957
24476
|
"required": true,
|
|
@@ -23964,7 +24483,7 @@ const CAPABILITY_DATA = {
|
|
|
23964
24483
|
"drops": []
|
|
23965
24484
|
},
|
|
23966
24485
|
"examples": [
|
|
23967
|
-
"await client.resourceRoleQueues.
|
|
24486
|
+
"await client.resourceRoleQueues.create('example-value', { name: 'example' }, { dryRun: true })"
|
|
23968
24487
|
],
|
|
23969
24488
|
"permissions": "unknown",
|
|
23970
24489
|
"pagination": {
|
|
@@ -23972,95 +24491,39 @@ const CAPABILITY_DATA = {
|
|
|
23972
24491
|
},
|
|
23973
24492
|
"resolution": null,
|
|
23974
24493
|
"retry": {
|
|
23975
|
-
"preset": "retry-
|
|
24494
|
+
"preset": "retry-c5657094"
|
|
23976
24495
|
},
|
|
23977
24496
|
"errors": {
|
|
23978
24497
|
"set": 1
|
|
23979
24498
|
},
|
|
23980
24499
|
"metadata": {
|
|
23981
|
-
"purpose": "
|
|
23982
|
-
"usage": "
|
|
23983
|
-
"preferredWhen": "
|
|
24500
|
+
"purpose": "Create a resource role queue.",
|
|
24501
|
+
"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.",
|
|
24502
|
+
"preferredWhen": "Only for a record that does not exist yet; prefer update for an id you already have.",
|
|
23984
24503
|
"related": [
|
|
23985
|
-
"resource_role_queues.
|
|
24504
|
+
"resource_role_queues.update"
|
|
23986
24505
|
],
|
|
24506
|
+
"deleteBoundary": {
|
|
24507
|
+
"resource": "resource_role_queues",
|
|
24508
|
+
"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.",
|
|
24509
|
+
"proof": "spec-derived"
|
|
24510
|
+
},
|
|
23987
24511
|
"accountWide": true
|
|
23988
24512
|
},
|
|
23989
24513
|
"compact": null,
|
|
23990
24514
|
"status": "tested"
|
|
23991
24515
|
},
|
|
23992
24516
|
{
|
|
23993
|
-
"id": "
|
|
23994
|
-
"resource": "
|
|
23995
|
-
"udfCapable": false,
|
|
23996
|
-
"operation": "count",
|
|
23997
|
-
"kind": "primitive",
|
|
23998
|
-
"endpoint": "GET|POST /V1.0/ResourceRoles/query/count",
|
|
23999
|
-
"effect": "read",
|
|
24000
|
-
"flags": [],
|
|
24001
|
-
"dryRun": false,
|
|
24002
|
-
"envelope": "QueryCountResultModel",
|
|
24003
|
-
"inputSchema": {
|
|
24004
|
-
"params": {
|
|
24005
|
-
"type": "object",
|
|
24006
|
-
"required": false,
|
|
24007
|
-
"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.",
|
|
24008
|
-
"properties": [
|
|
24009
|
-
{
|
|
24010
|
-
"name": "filter",
|
|
24011
|
-
"type": "FilterCondition[]",
|
|
24012
|
-
"optional": true
|
|
24013
|
-
},
|
|
24014
|
-
{
|
|
24015
|
-
"name": "fieldCheck",
|
|
24016
|
-
"type": "boolean",
|
|
24017
|
-
"optional": true
|
|
24018
|
-
}
|
|
24019
|
-
]
|
|
24020
|
-
}
|
|
24021
|
-
},
|
|
24022
|
-
"inputSchemaStrict": true,
|
|
24023
|
-
"outputSchema": {
|
|
24024
|
-
"type": "QueryCountResultModel",
|
|
24025
|
-
"drops": []
|
|
24026
|
-
},
|
|
24027
|
-
"examples": [
|
|
24028
|
-
"await client.resourceRoles.count({ filter: [{ field: 'name', op: 'eq', value: 'example' }] })"
|
|
24029
|
-
],
|
|
24030
|
-
"permissions": "unknown",
|
|
24031
|
-
"pagination": {
|
|
24032
|
-
"mode": "none"
|
|
24033
|
-
},
|
|
24034
|
-
"resolution": null,
|
|
24035
|
-
"retry": {
|
|
24036
|
-
"preset": "retry-ffb3a9cb"
|
|
24037
|
-
},
|
|
24038
|
-
"errors": {
|
|
24039
|
-
"set": 0
|
|
24040
|
-
},
|
|
24041
|
-
"metadata": {
|
|
24042
|
-
"purpose": "Count resource role records matching a JSON filter.",
|
|
24043
|
-
"usage": "Unwraps queryCount; returns a plain number.",
|
|
24044
|
-
"preferredWhen": null,
|
|
24045
|
-
"related": [
|
|
24046
|
-
"resource_roles.query"
|
|
24047
|
-
],
|
|
24048
|
-
"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."
|
|
24049
|
-
},
|
|
24050
|
-
"compact": null,
|
|
24051
|
-
"status": "tested"
|
|
24052
|
-
},
|
|
24053
|
-
{
|
|
24054
|
-
"id": "resource_roles.get",
|
|
24055
|
-
"resource": "resource_roles",
|
|
24517
|
+
"id": "resource_role_queues.get",
|
|
24518
|
+
"resource": "resource_role_queues",
|
|
24056
24519
|
"udfCapable": false,
|
|
24057
24520
|
"operation": "get",
|
|
24058
24521
|
"kind": "primitive",
|
|
24059
|
-
"endpoint": "GET /V1.0/Resources/{parentId}/
|
|
24522
|
+
"endpoint": "GET /V1.0/Resources/{parentId}/RoleQueues/{id}",
|
|
24060
24523
|
"effect": "read",
|
|
24061
24524
|
"flags": [],
|
|
24062
24525
|
"dryRun": false,
|
|
24063
|
-
"envelope": "ItemQueryResultModel[
|
|
24526
|
+
"envelope": "ItemQueryResultModel[ResourceRoleQueueModel,ResourceRoleQueue]",
|
|
24064
24527
|
"inputSchema": {
|
|
24065
24528
|
"parentId": {
|
|
24066
24529
|
"type": "string | number",
|
|
@@ -24087,11 +24550,11 @@ const CAPABILITY_DATA = {
|
|
|
24087
24550
|
},
|
|
24088
24551
|
"inputSchemaStrict": true,
|
|
24089
24552
|
"outputSchema": {
|
|
24090
|
-
"type": "ItemQueryResultModel[
|
|
24553
|
+
"type": "ItemQueryResultModel[ResourceRoleQueueModel,ResourceRoleQueue]",
|
|
24091
24554
|
"drops": []
|
|
24092
24555
|
},
|
|
24093
24556
|
"examples": [
|
|
24094
|
-
"await client.
|
|
24557
|
+
"await client.resourceRoleQueues.get('example-value', 'example-value')"
|
|
24095
24558
|
],
|
|
24096
24559
|
"permissions": "unknown",
|
|
24097
24560
|
"pagination": {
|
|
@@ -24105,24 +24568,24 @@ const CAPABILITY_DATA = {
|
|
|
24105
24568
|
"set": 3
|
|
24106
24569
|
},
|
|
24107
24570
|
"metadata": {
|
|
24108
|
-
"purpose": "Get one
|
|
24571
|
+
"purpose": "Get one ResourceRoleQueue by id.",
|
|
24109
24572
|
"usage": "item: null on the 200 body maps to NotFoundError (vendor not-found signal). Parent-scoped: parentId + id.",
|
|
24110
|
-
"preferredWhen": "Preferred when the numeric id is already known;
|
|
24573
|
+
"preferredWhen": "Preferred when the numeric id is already known; resource_role_queues.resolve is for a field value.",
|
|
24111
24574
|
"related": [
|
|
24112
|
-
"
|
|
24575
|
+
"resource_role_queues.resolve"
|
|
24113
24576
|
],
|
|
24114
|
-
"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
|
|
24577
|
+
"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."
|
|
24115
24578
|
},
|
|
24116
24579
|
"compact": null,
|
|
24117
24580
|
"status": "tested"
|
|
24118
24581
|
},
|
|
24119
24582
|
{
|
|
24120
|
-
"id": "
|
|
24121
|
-
"resource": "
|
|
24583
|
+
"id": "resource_role_queues.getEntityInfo",
|
|
24584
|
+
"resource": "resource_role_queues",
|
|
24122
24585
|
"udfCapable": false,
|
|
24123
24586
|
"operation": "getEntityInfo",
|
|
24124
24587
|
"kind": "primitive",
|
|
24125
|
-
"endpoint": "GET /V1.0/
|
|
24588
|
+
"endpoint": "GET /V1.0/ResourceRoleQueues/entityInformation",
|
|
24126
24589
|
"effect": "read",
|
|
24127
24590
|
"flags": [],
|
|
24128
24591
|
"dryRun": false,
|
|
@@ -24134,7 +24597,7 @@ const CAPABILITY_DATA = {
|
|
|
24134
24597
|
"drops": []
|
|
24135
24598
|
},
|
|
24136
24599
|
"examples": [
|
|
24137
|
-
"await client.
|
|
24600
|
+
"await client.resourceRoleQueues.getEntityInfo()"
|
|
24138
24601
|
],
|
|
24139
24602
|
"permissions": "unknown",
|
|
24140
24603
|
"pagination": {
|
|
@@ -24148,23 +24611,23 @@ const CAPABILITY_DATA = {
|
|
|
24148
24611
|
"set": 0
|
|
24149
24612
|
},
|
|
24150
24613
|
"metadata": {
|
|
24151
|
-
"purpose": "Get the
|
|
24614
|
+
"purpose": "Get the ResourceRoleQueue capability metadata (canCreate/canUpdate/hasUserDefinedFields/...).",
|
|
24152
24615
|
"usage": "Unwraps info{}; drives client-side capability checks.",
|
|
24153
24616
|
"preferredWhen": null,
|
|
24154
24617
|
"related": [
|
|
24155
|
-
"
|
|
24618
|
+
"resource_role_queues.getFieldInfo"
|
|
24156
24619
|
]
|
|
24157
24620
|
},
|
|
24158
24621
|
"compact": null,
|
|
24159
24622
|
"status": "tested"
|
|
24160
24623
|
},
|
|
24161
24624
|
{
|
|
24162
|
-
"id": "
|
|
24163
|
-
"resource": "
|
|
24625
|
+
"id": "resource_role_queues.getFieldInfo",
|
|
24626
|
+
"resource": "resource_role_queues",
|
|
24164
24627
|
"udfCapable": false,
|
|
24165
24628
|
"operation": "getFieldInfo",
|
|
24166
24629
|
"kind": "primitive",
|
|
24167
|
-
"endpoint": "GET /V1.0/
|
|
24630
|
+
"endpoint": "GET /V1.0/ResourceRoleQueues/entityInformation/fields",
|
|
24168
24631
|
"effect": "read",
|
|
24169
24632
|
"flags": [],
|
|
24170
24633
|
"dryRun": false,
|
|
@@ -24176,7 +24639,7 @@ const CAPABILITY_DATA = {
|
|
|
24176
24639
|
"drops": []
|
|
24177
24640
|
},
|
|
24178
24641
|
"examples": [
|
|
24179
|
-
"await client.
|
|
24642
|
+
"await client.resourceRoleQueues.getFieldInfo()"
|
|
24180
24643
|
],
|
|
24181
24644
|
"permissions": "unknown",
|
|
24182
24645
|
"pagination": {
|
|
@@ -24190,24 +24653,24 @@ const CAPABILITY_DATA = {
|
|
|
24190
24653
|
"set": 0
|
|
24191
24654
|
},
|
|
24192
24655
|
"metadata": {
|
|
24193
|
-
"purpose": "Get the
|
|
24656
|
+
"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).",
|
|
24194
24657
|
"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.",
|
|
24195
24658
|
"preferredWhen": null,
|
|
24196
24659
|
"related": [
|
|
24197
|
-
"
|
|
24198
|
-
"
|
|
24660
|
+
"resource_role_queues.getEntityInfo",
|
|
24661
|
+
"resource_role_queues.getUdfInfo"
|
|
24199
24662
|
]
|
|
24200
24663
|
},
|
|
24201
24664
|
"compact": null,
|
|
24202
24665
|
"status": "tested"
|
|
24203
24666
|
},
|
|
24204
24667
|
{
|
|
24205
|
-
"id": "
|
|
24206
|
-
"resource": "
|
|
24668
|
+
"id": "resource_role_queues.getUdfInfo",
|
|
24669
|
+
"resource": "resource_role_queues",
|
|
24207
24670
|
"udfCapable": false,
|
|
24208
24671
|
"operation": "getUdfInfo",
|
|
24209
24672
|
"kind": "primitive",
|
|
24210
|
-
"endpoint": "GET /V1.0/
|
|
24673
|
+
"endpoint": "GET /V1.0/ResourceRoleQueues/entityInformation/userDefinedFields",
|
|
24211
24674
|
"effect": "read",
|
|
24212
24675
|
"flags": [],
|
|
24213
24676
|
"dryRun": false,
|
|
@@ -24219,7 +24682,7 @@ const CAPABILITY_DATA = {
|
|
|
24219
24682
|
"drops": []
|
|
24220
24683
|
},
|
|
24221
24684
|
"examples": [
|
|
24222
|
-
"await client.
|
|
24685
|
+
"await client.resourceRoleQueues.getUdfInfo()"
|
|
24223
24686
|
],
|
|
24224
24687
|
"permissions": "unknown",
|
|
24225
24688
|
"pagination": {
|
|
@@ -24233,23 +24696,512 @@ const CAPABILITY_DATA = {
|
|
|
24233
24696
|
"set": 0
|
|
24234
24697
|
},
|
|
24235
24698
|
"metadata": {
|
|
24236
|
-
"purpose": "Get the
|
|
24699
|
+
"purpose": "Get the ResourceRoleQueue user-defined-field catalog.",
|
|
24237
24700
|
"usage": "Unwraps fields[]; only meaningful where the entity is UDF-capable. (entity is not UDF-capable; catalog is expected empty).",
|
|
24238
24701
|
"preferredWhen": null,
|
|
24239
24702
|
"related": [
|
|
24240
|
-
"
|
|
24703
|
+
"resource_role_queues.getFieldInfo"
|
|
24241
24704
|
]
|
|
24242
24705
|
},
|
|
24243
24706
|
"compact": null,
|
|
24244
24707
|
"status": "tested"
|
|
24245
24708
|
},
|
|
24246
24709
|
{
|
|
24247
|
-
"id": "
|
|
24248
|
-
"resource": "
|
|
24710
|
+
"id": "resource_role_queues.query",
|
|
24711
|
+
"resource": "resource_role_queues",
|
|
24249
24712
|
"udfCapable": false,
|
|
24250
24713
|
"operation": "query",
|
|
24251
24714
|
"kind": "primitive",
|
|
24252
|
-
"endpoint": "GET|POST /V1.0/
|
|
24715
|
+
"endpoint": "GET|POST /V1.0/ResourceRoleQueues/query",
|
|
24716
|
+
"effect": "read",
|
|
24717
|
+
"flags": [],
|
|
24718
|
+
"dryRun": false,
|
|
24719
|
+
"envelope": "QueryActionResult[<Model>,<Entity>]",
|
|
24720
|
+
"inputSchema": {
|
|
24721
|
+
"params": {
|
|
24722
|
+
"type": "object",
|
|
24723
|
+
"required": false,
|
|
24724
|
+
"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.",
|
|
24725
|
+
"properties": [
|
|
24726
|
+
{
|
|
24727
|
+
"name": "filter",
|
|
24728
|
+
"type": "FilterCondition[]",
|
|
24729
|
+
"optional": true
|
|
24730
|
+
},
|
|
24731
|
+
{
|
|
24732
|
+
"name": "limit",
|
|
24733
|
+
"type": "number",
|
|
24734
|
+
"optional": true,
|
|
24735
|
+
"default": 500
|
|
24736
|
+
},
|
|
24737
|
+
{
|
|
24738
|
+
"name": "latest",
|
|
24739
|
+
"type": "number",
|
|
24740
|
+
"optional": true
|
|
24741
|
+
},
|
|
24742
|
+
{
|
|
24743
|
+
"name": "noteChars",
|
|
24744
|
+
"type": "number",
|
|
24745
|
+
"optional": true
|
|
24746
|
+
},
|
|
24747
|
+
{
|
|
24748
|
+
"name": "includeFields",
|
|
24749
|
+
"type": "string[]",
|
|
24750
|
+
"optional": true
|
|
24751
|
+
},
|
|
24752
|
+
{
|
|
24753
|
+
"name": "fieldCheck",
|
|
24754
|
+
"type": "boolean",
|
|
24755
|
+
"optional": true,
|
|
24756
|
+
"default": true
|
|
24757
|
+
},
|
|
24758
|
+
{
|
|
24759
|
+
"name": "names",
|
|
24760
|
+
"type": "boolean",
|
|
24761
|
+
"optional": true
|
|
24762
|
+
},
|
|
24763
|
+
{
|
|
24764
|
+
"name": "via",
|
|
24765
|
+
"type": "\"post\" | \"get\"",
|
|
24766
|
+
"optional": true
|
|
24767
|
+
},
|
|
24768
|
+
{
|
|
24769
|
+
"name": "acknowledgeUnscoped",
|
|
24770
|
+
"type": "boolean",
|
|
24771
|
+
"optional": true
|
|
24772
|
+
},
|
|
24773
|
+
{
|
|
24774
|
+
"name": "walk",
|
|
24775
|
+
"type": "object",
|
|
24776
|
+
"optional": true
|
|
24777
|
+
}
|
|
24778
|
+
]
|
|
24779
|
+
}
|
|
24780
|
+
},
|
|
24781
|
+
"inputSchemaStrict": true,
|
|
24782
|
+
"outputSchema": {
|
|
24783
|
+
"type": "QueryActionResult[<Model>,<Entity>]",
|
|
24784
|
+
"drops": []
|
|
24785
|
+
},
|
|
24786
|
+
"examples": [
|
|
24787
|
+
"await client.resourceRoleQueues.query({ filter: [{ field: 'name', op: 'eq', value: 'example' }], limit: 500 })"
|
|
24788
|
+
],
|
|
24789
|
+
"permissions": "unknown",
|
|
24790
|
+
"pagination": {
|
|
24791
|
+
"mode": "cursor",
|
|
24792
|
+
"vendorDefault": 10,
|
|
24793
|
+
"vendorMax": 500,
|
|
24794
|
+
"pageGuard": 1000,
|
|
24795
|
+
"queryBounded": {
|
|
24796
|
+
"default": 500,
|
|
24797
|
+
"max": 2500
|
|
24798
|
+
}
|
|
24799
|
+
},
|
|
24800
|
+
"resolution": null,
|
|
24801
|
+
"retry": {
|
|
24802
|
+
"preset": "retry-ffb3a9cb"
|
|
24803
|
+
},
|
|
24804
|
+
"errors": {
|
|
24805
|
+
"set": 4
|
|
24806
|
+
},
|
|
24807
|
+
"metadata": {
|
|
24808
|
+
"purpose": "Query ResourceRoleQueue records with a JSON filter.",
|
|
24809
|
+
"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.",
|
|
24810
|
+
"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).",
|
|
24811
|
+
"related": [
|
|
24812
|
+
"resource_role_queues.resolve"
|
|
24813
|
+
],
|
|
24814
|
+
"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."
|
|
24815
|
+
},
|
|
24816
|
+
"compact": null,
|
|
24817
|
+
"status": "tested"
|
|
24818
|
+
},
|
|
24819
|
+
{
|
|
24820
|
+
"id": "resource_role_queues.resolve",
|
|
24821
|
+
"resource": "resource_role_queues",
|
|
24822
|
+
"udfCapable": false,
|
|
24823
|
+
"operation": "resolve",
|
|
24824
|
+
"kind": "helper",
|
|
24825
|
+
"endpoint": null,
|
|
24826
|
+
"effect": "read",
|
|
24827
|
+
"flags": [],
|
|
24828
|
+
"dryRun": false,
|
|
24829
|
+
"envelope": null,
|
|
24830
|
+
"inputSchema": {
|
|
24831
|
+
"identifier": {
|
|
24832
|
+
"type": "string | number",
|
|
24833
|
+
"required": true,
|
|
24834
|
+
"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)."
|
|
24835
|
+
},
|
|
24836
|
+
"opts": {
|
|
24837
|
+
"type": "object",
|
|
24838
|
+
"required": false,
|
|
24839
|
+
"description": "ResolutionOpts — { expand?: boolean } (return the full record; a no-op where the Summary is a structural alias).",
|
|
24840
|
+
"properties": [
|
|
24841
|
+
{
|
|
24842
|
+
"name": "expand",
|
|
24843
|
+
"type": "boolean",
|
|
24844
|
+
"optional": true
|
|
24845
|
+
}
|
|
24846
|
+
]
|
|
24847
|
+
}
|
|
24848
|
+
},
|
|
24849
|
+
"inputSchemaStrict": true,
|
|
24850
|
+
"outputSchema": {
|
|
24851
|
+
"type": "ResourceRoleQueueSummary",
|
|
24852
|
+
"drops": []
|
|
24853
|
+
},
|
|
24854
|
+
"examples": [
|
|
24855
|
+
"await client.resourceRoleQueues.resolve('example-value')"
|
|
24856
|
+
],
|
|
24857
|
+
"permissions": "unknown",
|
|
24858
|
+
"pagination": {
|
|
24859
|
+
"mode": "none"
|
|
24860
|
+
},
|
|
24861
|
+
"resolution": {
|
|
24862
|
+
"basis": "server-filter",
|
|
24863
|
+
"maxScanRecords": 500,
|
|
24864
|
+
"maxScanPages": 4
|
|
24865
|
+
},
|
|
24866
|
+
"retry": {
|
|
24867
|
+
"preset": "retry-ffb3a9cb"
|
|
24868
|
+
},
|
|
24869
|
+
"errors": {
|
|
24870
|
+
"set": 5
|
|
24871
|
+
},
|
|
24872
|
+
"metadata": {
|
|
24873
|
+
"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.",
|
|
24874
|
+
"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.",
|
|
24875
|
+
"preferredWhen": null,
|
|
24876
|
+
"related": [
|
|
24877
|
+
"resource_role_queues.get"
|
|
24878
|
+
]
|
|
24879
|
+
},
|
|
24880
|
+
"compact": "ResourceRoleQueueSummary",
|
|
24881
|
+
"status": "tested"
|
|
24882
|
+
},
|
|
24883
|
+
{
|
|
24884
|
+
"id": "resource_role_queues.update",
|
|
24885
|
+
"resource": "resource_role_queues",
|
|
24886
|
+
"udfCapable": false,
|
|
24887
|
+
"operation": "update",
|
|
24888
|
+
"kind": "primitive",
|
|
24889
|
+
"endpoint": "PUT|PATCH /V1.0/Resources/{parentId}/RoleQueues",
|
|
24890
|
+
"effect": "write",
|
|
24891
|
+
"flags": [
|
|
24892
|
+
"idempotent"
|
|
24893
|
+
],
|
|
24894
|
+
"dryRun": true,
|
|
24895
|
+
"envelope": "OperationResultModel",
|
|
24896
|
+
"inputSchema": {
|
|
24897
|
+
"parentId": {
|
|
24898
|
+
"type": "string | number",
|
|
24899
|
+
"required": true,
|
|
24900
|
+
"description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
|
|
24901
|
+
},
|
|
24902
|
+
"id": {
|
|
24903
|
+
"type": "string | number",
|
|
24904
|
+
"required": true,
|
|
24905
|
+
"description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
|
|
24906
|
+
},
|
|
24907
|
+
"data": {
|
|
24908
|
+
"type": "object",
|
|
24909
|
+
"required": true,
|
|
24910
|
+
"description": "The record payload (vendor model fields)."
|
|
24911
|
+
}
|
|
24912
|
+
},
|
|
24913
|
+
"inputSchemaStrict": true,
|
|
24914
|
+
"outputSchema": {
|
|
24915
|
+
"type": "OperationResultModel",
|
|
24916
|
+
"drops": []
|
|
24917
|
+
},
|
|
24918
|
+
"examples": [
|
|
24919
|
+
"await client.resourceRoleQueues.update('example-value', 'example-value', { name: 'example' }, { dryRun: true })"
|
|
24920
|
+
],
|
|
24921
|
+
"permissions": "unknown",
|
|
24922
|
+
"pagination": {
|
|
24923
|
+
"mode": "none"
|
|
24924
|
+
},
|
|
24925
|
+
"resolution": null,
|
|
24926
|
+
"retry": {
|
|
24927
|
+
"preset": "retry-85897a3a"
|
|
24928
|
+
},
|
|
24929
|
+
"errors": {
|
|
24930
|
+
"set": 1
|
|
24931
|
+
},
|
|
24932
|
+
"metadata": {
|
|
24933
|
+
"purpose": "Update a resource role queue.",
|
|
24934
|
+
"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.",
|
|
24935
|
+
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
24936
|
+
"related": [
|
|
24937
|
+
"resource_role_queues.get"
|
|
24938
|
+
],
|
|
24939
|
+
"accountWide": true
|
|
24940
|
+
},
|
|
24941
|
+
"compact": null,
|
|
24942
|
+
"status": "tested"
|
|
24943
|
+
},
|
|
24944
|
+
{
|
|
24945
|
+
"id": "resource_roles.count",
|
|
24946
|
+
"resource": "resource_roles",
|
|
24947
|
+
"udfCapable": false,
|
|
24948
|
+
"operation": "count",
|
|
24949
|
+
"kind": "primitive",
|
|
24950
|
+
"endpoint": "GET|POST /V1.0/ResourceRoles/query/count",
|
|
24951
|
+
"effect": "read",
|
|
24952
|
+
"flags": [],
|
|
24953
|
+
"dryRun": false,
|
|
24954
|
+
"envelope": "QueryCountResultModel",
|
|
24955
|
+
"inputSchema": {
|
|
24956
|
+
"params": {
|
|
24957
|
+
"type": "object",
|
|
24958
|
+
"required": false,
|
|
24959
|
+
"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.",
|
|
24960
|
+
"properties": [
|
|
24961
|
+
{
|
|
24962
|
+
"name": "filter",
|
|
24963
|
+
"type": "FilterCondition[]",
|
|
24964
|
+
"optional": true
|
|
24965
|
+
},
|
|
24966
|
+
{
|
|
24967
|
+
"name": "fieldCheck",
|
|
24968
|
+
"type": "boolean",
|
|
24969
|
+
"optional": true
|
|
24970
|
+
}
|
|
24971
|
+
]
|
|
24972
|
+
}
|
|
24973
|
+
},
|
|
24974
|
+
"inputSchemaStrict": true,
|
|
24975
|
+
"outputSchema": {
|
|
24976
|
+
"type": "QueryCountResultModel",
|
|
24977
|
+
"drops": []
|
|
24978
|
+
},
|
|
24979
|
+
"examples": [
|
|
24980
|
+
"await client.resourceRoles.count({ filter: [{ field: 'name', op: 'eq', value: 'example' }] })"
|
|
24981
|
+
],
|
|
24982
|
+
"permissions": "unknown",
|
|
24983
|
+
"pagination": {
|
|
24984
|
+
"mode": "none"
|
|
24985
|
+
},
|
|
24986
|
+
"resolution": null,
|
|
24987
|
+
"retry": {
|
|
24988
|
+
"preset": "retry-ffb3a9cb"
|
|
24989
|
+
},
|
|
24990
|
+
"errors": {
|
|
24991
|
+
"set": 0
|
|
24992
|
+
},
|
|
24993
|
+
"metadata": {
|
|
24994
|
+
"purpose": "Count resource role records matching a JSON filter.",
|
|
24995
|
+
"usage": "Unwraps queryCount; returns a plain number.",
|
|
24996
|
+
"preferredWhen": null,
|
|
24997
|
+
"related": [
|
|
24998
|
+
"resource_roles.query"
|
|
24999
|
+
],
|
|
25000
|
+
"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."
|
|
25001
|
+
},
|
|
25002
|
+
"compact": null,
|
|
25003
|
+
"status": "tested"
|
|
25004
|
+
},
|
|
25005
|
+
{
|
|
25006
|
+
"id": "resource_roles.get",
|
|
25007
|
+
"resource": "resource_roles",
|
|
25008
|
+
"udfCapable": false,
|
|
25009
|
+
"operation": "get",
|
|
25010
|
+
"kind": "primitive",
|
|
25011
|
+
"endpoint": "GET /V1.0/Resources/{parentId}/Roles/{id}",
|
|
25012
|
+
"effect": "read",
|
|
25013
|
+
"flags": [],
|
|
25014
|
+
"dryRun": false,
|
|
25015
|
+
"envelope": "ItemQueryResultModel[ResourceRoleModel,ResourceRole]",
|
|
25016
|
+
"inputSchema": {
|
|
25017
|
+
"parentId": {
|
|
25018
|
+
"type": "string | number",
|
|
25019
|
+
"required": true,
|
|
25020
|
+
"description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
|
|
25021
|
+
},
|
|
25022
|
+
"id": {
|
|
25023
|
+
"type": "string | number",
|
|
25024
|
+
"required": true,
|
|
25025
|
+
"description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
|
|
25026
|
+
},
|
|
25027
|
+
"opts": {
|
|
25028
|
+
"type": "object",
|
|
25029
|
+
"required": false,
|
|
25030
|
+
"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.",
|
|
25031
|
+
"properties": [
|
|
25032
|
+
{
|
|
25033
|
+
"name": "fresh",
|
|
25034
|
+
"type": "boolean",
|
|
25035
|
+
"optional": true
|
|
25036
|
+
}
|
|
25037
|
+
]
|
|
25038
|
+
}
|
|
25039
|
+
},
|
|
25040
|
+
"inputSchemaStrict": true,
|
|
25041
|
+
"outputSchema": {
|
|
25042
|
+
"type": "ItemQueryResultModel[ResourceRoleModel,ResourceRole]",
|
|
25043
|
+
"drops": []
|
|
25044
|
+
},
|
|
25045
|
+
"examples": [
|
|
25046
|
+
"await client.resourceRoles.get('example-value', 'example-value')"
|
|
25047
|
+
],
|
|
25048
|
+
"permissions": "unknown",
|
|
25049
|
+
"pagination": {
|
|
25050
|
+
"mode": "none"
|
|
25051
|
+
},
|
|
25052
|
+
"resolution": null,
|
|
25053
|
+
"retry": {
|
|
25054
|
+
"preset": "retry-ffb3a9cb"
|
|
25055
|
+
},
|
|
25056
|
+
"errors": {
|
|
25057
|
+
"set": 3
|
|
25058
|
+
},
|
|
25059
|
+
"metadata": {
|
|
25060
|
+
"purpose": "Get one ResourceRole by id.",
|
|
25061
|
+
"usage": "item: null on the 200 body maps to NotFoundError (vendor not-found signal). Parent-scoped: parentId + id.",
|
|
25062
|
+
"preferredWhen": "Preferred when the numeric id is already known; resource_roles.resolve is for a field value.",
|
|
25063
|
+
"related": [
|
|
25064
|
+
"resource_roles.resolve"
|
|
25065
|
+
],
|
|
25066
|
+
"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."
|
|
25067
|
+
},
|
|
25068
|
+
"compact": null,
|
|
25069
|
+
"status": "tested"
|
|
25070
|
+
},
|
|
25071
|
+
{
|
|
25072
|
+
"id": "resource_roles.getEntityInfo",
|
|
25073
|
+
"resource": "resource_roles",
|
|
25074
|
+
"udfCapable": false,
|
|
25075
|
+
"operation": "getEntityInfo",
|
|
25076
|
+
"kind": "primitive",
|
|
25077
|
+
"endpoint": "GET /V1.0/ResourceRoles/entityInformation",
|
|
25078
|
+
"effect": "read",
|
|
25079
|
+
"flags": [],
|
|
25080
|
+
"dryRun": false,
|
|
25081
|
+
"envelope": "EntityInformationResultModel",
|
|
25082
|
+
"inputSchema": {},
|
|
25083
|
+
"inputSchemaStrict": true,
|
|
25084
|
+
"outputSchema": {
|
|
25085
|
+
"type": "EntityInformationResultModel",
|
|
25086
|
+
"drops": []
|
|
25087
|
+
},
|
|
25088
|
+
"examples": [
|
|
25089
|
+
"await client.resourceRoles.getEntityInfo()"
|
|
25090
|
+
],
|
|
25091
|
+
"permissions": "unknown",
|
|
25092
|
+
"pagination": {
|
|
25093
|
+
"mode": "none"
|
|
25094
|
+
},
|
|
25095
|
+
"resolution": null,
|
|
25096
|
+
"retry": {
|
|
25097
|
+
"preset": "retry-ffb3a9cb"
|
|
25098
|
+
},
|
|
25099
|
+
"errors": {
|
|
25100
|
+
"set": 0
|
|
25101
|
+
},
|
|
25102
|
+
"metadata": {
|
|
25103
|
+
"purpose": "Get the ResourceRole capability metadata (canCreate/canUpdate/hasUserDefinedFields/...).",
|
|
25104
|
+
"usage": "Unwraps info{}; drives client-side capability checks.",
|
|
25105
|
+
"preferredWhen": null,
|
|
25106
|
+
"related": [
|
|
25107
|
+
"resource_roles.getFieldInfo"
|
|
25108
|
+
]
|
|
25109
|
+
},
|
|
25110
|
+
"compact": null,
|
|
25111
|
+
"status": "tested"
|
|
25112
|
+
},
|
|
25113
|
+
{
|
|
25114
|
+
"id": "resource_roles.getFieldInfo",
|
|
25115
|
+
"resource": "resource_roles",
|
|
25116
|
+
"udfCapable": false,
|
|
25117
|
+
"operation": "getFieldInfo",
|
|
25118
|
+
"kind": "primitive",
|
|
25119
|
+
"endpoint": "GET /V1.0/ResourceRoles/entityInformation/fields",
|
|
25120
|
+
"effect": "read",
|
|
25121
|
+
"flags": [],
|
|
25122
|
+
"dryRun": false,
|
|
25123
|
+
"envelope": "FieldInformationResultModel",
|
|
25124
|
+
"inputSchema": {},
|
|
25125
|
+
"inputSchemaStrict": true,
|
|
25126
|
+
"outputSchema": {
|
|
25127
|
+
"type": "FieldInformationResultModel",
|
|
25128
|
+
"drops": []
|
|
25129
|
+
},
|
|
25130
|
+
"examples": [
|
|
25131
|
+
"await client.resourceRoles.getFieldInfo()"
|
|
25132
|
+
],
|
|
25133
|
+
"permissions": "unknown",
|
|
25134
|
+
"pagination": {
|
|
25135
|
+
"mode": "none"
|
|
25136
|
+
},
|
|
25137
|
+
"resolution": null,
|
|
25138
|
+
"retry": {
|
|
25139
|
+
"preset": "retry-ffb3a9cb"
|
|
25140
|
+
},
|
|
25141
|
+
"errors": {
|
|
25142
|
+
"set": 0
|
|
25143
|
+
},
|
|
25144
|
+
"metadata": {
|
|
25145
|
+
"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).",
|
|
25146
|
+
"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.",
|
|
25147
|
+
"preferredWhen": null,
|
|
25148
|
+
"related": [
|
|
25149
|
+
"resource_roles.getEntityInfo",
|
|
25150
|
+
"resource_roles.getUdfInfo"
|
|
25151
|
+
]
|
|
25152
|
+
},
|
|
25153
|
+
"compact": null,
|
|
25154
|
+
"status": "tested"
|
|
25155
|
+
},
|
|
25156
|
+
{
|
|
25157
|
+
"id": "resource_roles.getUdfInfo",
|
|
25158
|
+
"resource": "resource_roles",
|
|
25159
|
+
"udfCapable": false,
|
|
25160
|
+
"operation": "getUdfInfo",
|
|
25161
|
+
"kind": "primitive",
|
|
25162
|
+
"endpoint": "GET /V1.0/ResourceRoles/entityInformation/userDefinedFields",
|
|
25163
|
+
"effect": "read",
|
|
25164
|
+
"flags": [],
|
|
25165
|
+
"dryRun": false,
|
|
25166
|
+
"envelope": "UserDefinedFieldInformationResultModel",
|
|
25167
|
+
"inputSchema": {},
|
|
25168
|
+
"inputSchemaStrict": true,
|
|
25169
|
+
"outputSchema": {
|
|
25170
|
+
"type": "UserDefinedFieldInformationResultModel",
|
|
25171
|
+
"drops": []
|
|
25172
|
+
},
|
|
25173
|
+
"examples": [
|
|
25174
|
+
"await client.resourceRoles.getUdfInfo()"
|
|
25175
|
+
],
|
|
25176
|
+
"permissions": "unknown",
|
|
25177
|
+
"pagination": {
|
|
25178
|
+
"mode": "none"
|
|
25179
|
+
},
|
|
25180
|
+
"resolution": null,
|
|
25181
|
+
"retry": {
|
|
25182
|
+
"preset": "retry-ffb3a9cb"
|
|
25183
|
+
},
|
|
25184
|
+
"errors": {
|
|
25185
|
+
"set": 0
|
|
25186
|
+
},
|
|
25187
|
+
"metadata": {
|
|
25188
|
+
"purpose": "Get the ResourceRole user-defined-field catalog.",
|
|
25189
|
+
"usage": "Unwraps fields[]; only meaningful where the entity is UDF-capable. (entity is not UDF-capable; catalog is expected empty).",
|
|
25190
|
+
"preferredWhen": null,
|
|
25191
|
+
"related": [
|
|
25192
|
+
"resource_roles.getFieldInfo"
|
|
25193
|
+
]
|
|
25194
|
+
},
|
|
25195
|
+
"compact": null,
|
|
25196
|
+
"status": "tested"
|
|
25197
|
+
},
|
|
25198
|
+
{
|
|
25199
|
+
"id": "resource_roles.query",
|
|
25200
|
+
"resource": "resource_roles",
|
|
25201
|
+
"udfCapable": false,
|
|
25202
|
+
"operation": "query",
|
|
25203
|
+
"kind": "primitive",
|
|
25204
|
+
"endpoint": "GET|POST /V1.0/ResourceRoles/query",
|
|
24253
25205
|
"effect": "read",
|
|
24254
25206
|
"flags": [],
|
|
24255
25207
|
"dryRun": false,
|
|
@@ -27540,6 +28492,482 @@ const CAPABILITY_DATA = {
|
|
|
27540
28492
|
"compact": null,
|
|
27541
28493
|
"status": "tested"
|
|
27542
28494
|
},
|
|
28495
|
+
{
|
|
28496
|
+
"id": "sales_order_attachments.count",
|
|
28497
|
+
"resource": "sales_order_attachments",
|
|
28498
|
+
"udfCapable": false,
|
|
28499
|
+
"operation": "count",
|
|
28500
|
+
"kind": "primitive",
|
|
28501
|
+
"endpoint": "GET|POST /V1.0/SalesOrderAttachments/query/count",
|
|
28502
|
+
"effect": "read",
|
|
28503
|
+
"flags": [],
|
|
28504
|
+
"dryRun": false,
|
|
28505
|
+
"envelope": "QueryCountResultModel",
|
|
28506
|
+
"inputSchema": {
|
|
28507
|
+
"params": {
|
|
28508
|
+
"type": "object",
|
|
28509
|
+
"required": false,
|
|
28510
|
+
"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.",
|
|
28511
|
+
"properties": [
|
|
28512
|
+
{
|
|
28513
|
+
"name": "filter",
|
|
28514
|
+
"type": "FilterCondition[]",
|
|
28515
|
+
"optional": true
|
|
28516
|
+
},
|
|
28517
|
+
{
|
|
28518
|
+
"name": "fieldCheck",
|
|
28519
|
+
"type": "boolean",
|
|
28520
|
+
"optional": true
|
|
28521
|
+
}
|
|
28522
|
+
]
|
|
28523
|
+
}
|
|
28524
|
+
},
|
|
28525
|
+
"inputSchemaStrict": true,
|
|
28526
|
+
"outputSchema": {
|
|
28527
|
+
"type": "QueryCountResultModel",
|
|
28528
|
+
"drops": []
|
|
28529
|
+
},
|
|
28530
|
+
"examples": [
|
|
28531
|
+
"await invoke(client, 'sales_order_attachments.count', [{ filter: [{ field: 'salesOrderID', op: 'eq', value: 7 }] }])"
|
|
28532
|
+
],
|
|
28533
|
+
"permissions": "unknown",
|
|
28534
|
+
"pagination": {
|
|
28535
|
+
"mode": "none"
|
|
28536
|
+
},
|
|
28537
|
+
"resolution": null,
|
|
28538
|
+
"retry": {
|
|
28539
|
+
"preset": "retry-ffb3a9cb"
|
|
28540
|
+
},
|
|
28541
|
+
"errors": {
|
|
28542
|
+
"set": 0
|
|
28543
|
+
},
|
|
28544
|
+
"metadata": {
|
|
28545
|
+
"purpose": "Count sales order attachment records matching a JSON filter. Use salesOrderID for sales-order scope.",
|
|
28546
|
+
"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.",
|
|
28547
|
+
"preferredWhen": null,
|
|
28548
|
+
"related": [
|
|
28549
|
+
"sales_order_attachments.query"
|
|
28550
|
+
],
|
|
28551
|
+
"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.",
|
|
28552
|
+
"untrustedFields": [
|
|
28553
|
+
"title"
|
|
28554
|
+
]
|
|
28555
|
+
},
|
|
28556
|
+
"compact": null,
|
|
28557
|
+
"status": "tested"
|
|
28558
|
+
},
|
|
28559
|
+
{
|
|
28560
|
+
"id": "sales_order_attachments.create",
|
|
28561
|
+
"resource": "sales_order_attachments",
|
|
28562
|
+
"udfCapable": false,
|
|
28563
|
+
"operation": "create",
|
|
28564
|
+
"kind": "primitive",
|
|
28565
|
+
"endpoint": "POST /V1.0/SalesOrders/{parentId}/Attachments",
|
|
28566
|
+
"effect": "write",
|
|
28567
|
+
"flags": [],
|
|
28568
|
+
"dryRun": true,
|
|
28569
|
+
"envelope": "OperationResultModel",
|
|
28570
|
+
"inputSchema": {
|
|
28571
|
+
"parentId": {
|
|
28572
|
+
"type": "string | number",
|
|
28573
|
+
"required": true,
|
|
28574
|
+
"description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
|
|
28575
|
+
},
|
|
28576
|
+
"data": {
|
|
28577
|
+
"type": "object",
|
|
28578
|
+
"required": true,
|
|
28579
|
+
"description": "The record payload (vendor model fields)."
|
|
28580
|
+
}
|
|
28581
|
+
},
|
|
28582
|
+
"inputSchemaStrict": true,
|
|
28583
|
+
"outputSchema": {
|
|
28584
|
+
"type": "OperationResultModel",
|
|
28585
|
+
"drops": []
|
|
28586
|
+
},
|
|
28587
|
+
"examples": [
|
|
28588
|
+
"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 });"
|
|
28589
|
+
],
|
|
28590
|
+
"permissions": "unknown",
|
|
28591
|
+
"pagination": {
|
|
28592
|
+
"mode": "none"
|
|
28593
|
+
},
|
|
28594
|
+
"resolution": null,
|
|
28595
|
+
"retry": {
|
|
28596
|
+
"preset": "retry-c5657094"
|
|
28597
|
+
},
|
|
28598
|
+
"errors": {
|
|
28599
|
+
"set": 1
|
|
28600
|
+
},
|
|
28601
|
+
"metadata": {
|
|
28602
|
+
"purpose": "Create a file attachment under a sales order.",
|
|
28603
|
+
"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.",
|
|
28604
|
+
"preferredWhen": "Add a new attachment; existing attachments cannot be updated. Replace through separately governed delete and create actions.",
|
|
28605
|
+
"related": [
|
|
28606
|
+
"sales_order_attachments.get"
|
|
28607
|
+
],
|
|
28608
|
+
"argNotes": {
|
|
28609
|
+
"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."
|
|
28610
|
+
},
|
|
28611
|
+
"untrustedFields": [
|
|
28612
|
+
"title"
|
|
28613
|
+
],
|
|
28614
|
+
"createRequirements": {
|
|
28615
|
+
"requires": {
|
|
28616
|
+
"allOf": [
|
|
28617
|
+
"attachmentType",
|
|
28618
|
+
"fullPath",
|
|
28619
|
+
"title",
|
|
28620
|
+
"publish",
|
|
28621
|
+
"data"
|
|
28622
|
+
]
|
|
28623
|
+
},
|
|
28624
|
+
"requiresByValue": [
|
|
28625
|
+
{
|
|
28626
|
+
"field": "attachmentType",
|
|
28627
|
+
"value": "FILE_ATTACHMENT",
|
|
28628
|
+
"requires": {
|
|
28629
|
+
"allOf": [
|
|
28630
|
+
"data"
|
|
28631
|
+
]
|
|
28632
|
+
}
|
|
28633
|
+
}
|
|
28634
|
+
]
|
|
28635
|
+
}
|
|
28636
|
+
},
|
|
28637
|
+
"compact": null,
|
|
28638
|
+
"status": "tested"
|
|
28639
|
+
},
|
|
28640
|
+
{
|
|
28641
|
+
"id": "sales_order_attachments.delete",
|
|
28642
|
+
"resource": "sales_order_attachments",
|
|
28643
|
+
"udfCapable": false,
|
|
28644
|
+
"operation": "delete",
|
|
28645
|
+
"kind": "primitive",
|
|
28646
|
+
"endpoint": "DELETE /V1.0/SalesOrders/{parentId}/Attachments/{id}",
|
|
28647
|
+
"effect": "destructive",
|
|
28648
|
+
"flags": [
|
|
28649
|
+
"idempotent",
|
|
28650
|
+
"requiresApproval"
|
|
28651
|
+
],
|
|
28652
|
+
"dryRun": true,
|
|
28653
|
+
"envelope": "OperationResultModel (attachment entities: the deleted attachment model is returned, not OperationResultModel)",
|
|
28654
|
+
"inputSchema": {
|
|
28655
|
+
"parentId": {
|
|
28656
|
+
"type": "string | number",
|
|
28657
|
+
"required": true,
|
|
28658
|
+
"description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
|
|
28659
|
+
},
|
|
28660
|
+
"id": {
|
|
28661
|
+
"type": "string | number",
|
|
28662
|
+
"required": true,
|
|
28663
|
+
"description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
|
|
28664
|
+
}
|
|
28665
|
+
},
|
|
28666
|
+
"inputSchemaStrict": true,
|
|
28667
|
+
"outputSchema": {
|
|
28668
|
+
"type": "OperationResultModel (attachment entities: the deleted attachment model is returned, not OperationResultModel)",
|
|
28669
|
+
"drops": []
|
|
28670
|
+
},
|
|
28671
|
+
"examples": [
|
|
28672
|
+
"await invoke(client, 'sales_order_attachments.delete', [7, 3], { confirm: 'sales_order_attachments.delete' })"
|
|
28673
|
+
],
|
|
28674
|
+
"permissions": "unknown",
|
|
28675
|
+
"pagination": {
|
|
28676
|
+
"mode": "none"
|
|
28677
|
+
},
|
|
28678
|
+
"resolution": null,
|
|
28679
|
+
"retry": {
|
|
28680
|
+
"preset": "retry-1849870d"
|
|
28681
|
+
},
|
|
28682
|
+
"errors": {
|
|
28683
|
+
"set": 2
|
|
28684
|
+
},
|
|
28685
|
+
"metadata": {
|
|
28686
|
+
"purpose": "Delete an attachment under a sales order.",
|
|
28687
|
+
"usage": "Irreversible; dry-run validates the target id first. Parent-scoped: parentId + id.",
|
|
28688
|
+
"preferredWhen": null,
|
|
28689
|
+
"related": [
|
|
28690
|
+
"sales_order_attachments.get"
|
|
28691
|
+
],
|
|
28692
|
+
"untrustedFields": [
|
|
28693
|
+
"title"
|
|
28694
|
+
]
|
|
28695
|
+
},
|
|
28696
|
+
"compact": null,
|
|
28697
|
+
"status": "tested"
|
|
28698
|
+
},
|
|
28699
|
+
{
|
|
28700
|
+
"id": "sales_order_attachments.get",
|
|
28701
|
+
"resource": "sales_order_attachments",
|
|
28702
|
+
"udfCapable": false,
|
|
28703
|
+
"operation": "get",
|
|
28704
|
+
"kind": "primitive",
|
|
28705
|
+
"endpoint": "GET /V1.0/SalesOrders/{parentId}/Attachments/{id}",
|
|
28706
|
+
"effect": "read",
|
|
28707
|
+
"flags": [],
|
|
28708
|
+
"dryRun": false,
|
|
28709
|
+
"envelope": "SalesOrderAttachmentModel",
|
|
28710
|
+
"inputSchema": {
|
|
28711
|
+
"parentId": {
|
|
28712
|
+
"type": "string | number",
|
|
28713
|
+
"required": true,
|
|
28714
|
+
"description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
|
|
28715
|
+
},
|
|
28716
|
+
"id": {
|
|
28717
|
+
"type": "string | number",
|
|
28718
|
+
"required": true,
|
|
28719
|
+
"description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
|
|
28720
|
+
},
|
|
28721
|
+
"opts": {
|
|
28722
|
+
"type": "object",
|
|
28723
|
+
"required": false,
|
|
28724
|
+
"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.",
|
|
28725
|
+
"properties": [
|
|
28726
|
+
{
|
|
28727
|
+
"name": "fresh",
|
|
28728
|
+
"type": "boolean",
|
|
28729
|
+
"optional": true
|
|
28730
|
+
}
|
|
28731
|
+
]
|
|
28732
|
+
}
|
|
28733
|
+
},
|
|
28734
|
+
"inputSchemaStrict": true,
|
|
28735
|
+
"outputSchema": {
|
|
28736
|
+
"type": "SalesOrderAttachmentModel",
|
|
28737
|
+
"drops": []
|
|
28738
|
+
},
|
|
28739
|
+
"examples": [
|
|
28740
|
+
"await client.salesOrderAttachments.get(7, 3)"
|
|
28741
|
+
],
|
|
28742
|
+
"permissions": "unknown",
|
|
28743
|
+
"pagination": {
|
|
28744
|
+
"mode": "none"
|
|
28745
|
+
},
|
|
28746
|
+
"resolution": null,
|
|
28747
|
+
"retry": {
|
|
28748
|
+
"preset": "retry-ffb3a9cb"
|
|
28749
|
+
},
|
|
28750
|
+
"errors": {
|
|
28751
|
+
"set": 3
|
|
28752
|
+
},
|
|
28753
|
+
"metadata": {
|
|
28754
|
+
"purpose": "Get one SalesOrderAttachment by id.",
|
|
28755
|
+
"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.",
|
|
28756
|
+
"preferredWhen": "Use a known attachment id; query the scoped collection to discover ids.",
|
|
28757
|
+
"related": [
|
|
28758
|
+
"sales_order_attachments.query"
|
|
28759
|
+
],
|
|
28760
|
+
"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.",
|
|
28761
|
+
"untrustedFields": [
|
|
28762
|
+
"title"
|
|
28763
|
+
]
|
|
28764
|
+
},
|
|
28765
|
+
"compact": null,
|
|
28766
|
+
"status": "tested"
|
|
28767
|
+
},
|
|
28768
|
+
{
|
|
28769
|
+
"id": "sales_order_attachments.getEntityInfo",
|
|
28770
|
+
"resource": "sales_order_attachments",
|
|
28771
|
+
"udfCapable": false,
|
|
28772
|
+
"operation": "getEntityInfo",
|
|
28773
|
+
"kind": "primitive",
|
|
28774
|
+
"endpoint": "GET /V1.0/SalesOrderAttachments/entityInformation",
|
|
28775
|
+
"effect": "read",
|
|
28776
|
+
"flags": [],
|
|
28777
|
+
"dryRun": false,
|
|
28778
|
+
"envelope": "EntityInformationResultModel",
|
|
28779
|
+
"inputSchema": {},
|
|
28780
|
+
"inputSchemaStrict": true,
|
|
28781
|
+
"outputSchema": {
|
|
28782
|
+
"type": "EntityInformationResultModel",
|
|
28783
|
+
"drops": []
|
|
28784
|
+
},
|
|
28785
|
+
"examples": [
|
|
28786
|
+
"await client.salesOrderAttachments.getEntityInfo()"
|
|
28787
|
+
],
|
|
28788
|
+
"permissions": "unknown",
|
|
28789
|
+
"pagination": {
|
|
28790
|
+
"mode": "none"
|
|
28791
|
+
},
|
|
28792
|
+
"resolution": null,
|
|
28793
|
+
"retry": {
|
|
28794
|
+
"preset": "retry-ffb3a9cb"
|
|
28795
|
+
},
|
|
28796
|
+
"errors": {
|
|
28797
|
+
"set": 0
|
|
28798
|
+
},
|
|
28799
|
+
"metadata": {
|
|
28800
|
+
"purpose": "Get the SalesOrderAttachment capability metadata (canCreate/canUpdate/hasUserDefinedFields/...).",
|
|
28801
|
+
"usage": "Unwraps info{}; drives client-side capability checks.",
|
|
28802
|
+
"preferredWhen": null,
|
|
28803
|
+
"related": [
|
|
28804
|
+
"sales_order_attachments.getFieldInfo"
|
|
28805
|
+
],
|
|
28806
|
+
"untrustedFields": [
|
|
28807
|
+
"title"
|
|
28808
|
+
]
|
|
28809
|
+
},
|
|
28810
|
+
"compact": null,
|
|
28811
|
+
"status": "tested"
|
|
28812
|
+
},
|
|
28813
|
+
{
|
|
28814
|
+
"id": "sales_order_attachments.getFieldInfo",
|
|
28815
|
+
"resource": "sales_order_attachments",
|
|
28816
|
+
"udfCapable": false,
|
|
28817
|
+
"operation": "getFieldInfo",
|
|
28818
|
+
"kind": "primitive",
|
|
28819
|
+
"endpoint": "GET /V1.0/SalesOrderAttachments/entityInformation/fields",
|
|
28820
|
+
"effect": "read",
|
|
28821
|
+
"flags": [],
|
|
28822
|
+
"dryRun": false,
|
|
28823
|
+
"envelope": "FieldInformationResultModel",
|
|
28824
|
+
"inputSchema": {},
|
|
28825
|
+
"inputSchemaStrict": true,
|
|
28826
|
+
"outputSchema": {
|
|
28827
|
+
"type": "FieldInformationResultModel",
|
|
28828
|
+
"drops": []
|
|
28829
|
+
},
|
|
28830
|
+
"examples": [
|
|
28831
|
+
"await client.salesOrderAttachments.getFieldInfo()"
|
|
28832
|
+
],
|
|
28833
|
+
"permissions": "unknown",
|
|
28834
|
+
"pagination": {
|
|
28835
|
+
"mode": "none"
|
|
28836
|
+
},
|
|
28837
|
+
"resolution": null,
|
|
28838
|
+
"retry": {
|
|
28839
|
+
"preset": "retry-ffb3a9cb"
|
|
28840
|
+
},
|
|
28841
|
+
"errors": {
|
|
28842
|
+
"set": 0
|
|
28843
|
+
},
|
|
28844
|
+
"metadata": {
|
|
28845
|
+
"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).",
|
|
28846
|
+
"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.",
|
|
28847
|
+
"preferredWhen": null,
|
|
28848
|
+
"related": [
|
|
28849
|
+
"sales_order_attachments.getEntityInfo"
|
|
28850
|
+
],
|
|
28851
|
+
"untrustedFields": [
|
|
28852
|
+
"title"
|
|
28853
|
+
]
|
|
28854
|
+
},
|
|
28855
|
+
"compact": null,
|
|
28856
|
+
"status": "tested"
|
|
28857
|
+
},
|
|
28858
|
+
{
|
|
28859
|
+
"id": "sales_order_attachments.query",
|
|
28860
|
+
"resource": "sales_order_attachments",
|
|
28861
|
+
"udfCapable": false,
|
|
28862
|
+
"operation": "query",
|
|
28863
|
+
"kind": "primitive",
|
|
28864
|
+
"endpoint": "GET|POST /V1.0/SalesOrderAttachments/query",
|
|
28865
|
+
"effect": "read",
|
|
28866
|
+
"flags": [],
|
|
28867
|
+
"dryRun": false,
|
|
28868
|
+
"envelope": "QueryActionResult[<Model>,<Entity>]",
|
|
28869
|
+
"inputSchema": {
|
|
28870
|
+
"params": {
|
|
28871
|
+
"type": "object",
|
|
28872
|
+
"required": false,
|
|
28873
|
+
"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.",
|
|
28874
|
+
"properties": [
|
|
28875
|
+
{
|
|
28876
|
+
"name": "filter",
|
|
28877
|
+
"type": "FilterCondition[]",
|
|
28878
|
+
"optional": true
|
|
28879
|
+
},
|
|
28880
|
+
{
|
|
28881
|
+
"name": "limit",
|
|
28882
|
+
"type": "number",
|
|
28883
|
+
"optional": true,
|
|
28884
|
+
"default": 500
|
|
28885
|
+
},
|
|
28886
|
+
{
|
|
28887
|
+
"name": "latest",
|
|
28888
|
+
"type": "number",
|
|
28889
|
+
"optional": true
|
|
28890
|
+
},
|
|
28891
|
+
{
|
|
28892
|
+
"name": "noteChars",
|
|
28893
|
+
"type": "number",
|
|
28894
|
+
"optional": true
|
|
28895
|
+
},
|
|
28896
|
+
{
|
|
28897
|
+
"name": "includeFields",
|
|
28898
|
+
"type": "string[]",
|
|
28899
|
+
"optional": true
|
|
28900
|
+
},
|
|
28901
|
+
{
|
|
28902
|
+
"name": "fieldCheck",
|
|
28903
|
+
"type": "boolean",
|
|
28904
|
+
"optional": true,
|
|
28905
|
+
"default": true
|
|
28906
|
+
},
|
|
28907
|
+
{
|
|
28908
|
+
"name": "names",
|
|
28909
|
+
"type": "boolean",
|
|
28910
|
+
"optional": true
|
|
28911
|
+
},
|
|
28912
|
+
{
|
|
28913
|
+
"name": "via",
|
|
28914
|
+
"type": "\"post\" | \"get\"",
|
|
28915
|
+
"optional": true
|
|
28916
|
+
},
|
|
28917
|
+
{
|
|
28918
|
+
"name": "acknowledgeUnscoped",
|
|
28919
|
+
"type": "boolean",
|
|
28920
|
+
"optional": true
|
|
28921
|
+
},
|
|
28922
|
+
{
|
|
28923
|
+
"name": "walk",
|
|
28924
|
+
"type": "object",
|
|
28925
|
+
"optional": true
|
|
28926
|
+
}
|
|
28927
|
+
]
|
|
28928
|
+
}
|
|
28929
|
+
},
|
|
28930
|
+
"inputSchemaStrict": true,
|
|
28931
|
+
"outputSchema": {
|
|
28932
|
+
"type": "QueryActionResult[<Model>,<Entity>]",
|
|
28933
|
+
"drops": []
|
|
28934
|
+
},
|
|
28935
|
+
"examples": [
|
|
28936
|
+
"await invoke(client, 'sales_order_attachments.query', [{ filter: [{ field: 'salesOrderID', op: 'eq', value: 7 }], limit: 25 }])"
|
|
28937
|
+
],
|
|
28938
|
+
"permissions": "unknown",
|
|
28939
|
+
"pagination": {
|
|
28940
|
+
"mode": "cursor",
|
|
28941
|
+
"vendorDefault": 10,
|
|
28942
|
+
"vendorMax": 500,
|
|
28943
|
+
"pageGuard": 1000,
|
|
28944
|
+
"queryBounded": {
|
|
28945
|
+
"default": 500,
|
|
28946
|
+
"max": 2500
|
|
28947
|
+
}
|
|
28948
|
+
},
|
|
28949
|
+
"resolution": null,
|
|
28950
|
+
"retry": {
|
|
28951
|
+
"preset": "retry-ffb3a9cb"
|
|
28952
|
+
},
|
|
28953
|
+
"errors": {
|
|
28954
|
+
"set": 4
|
|
28955
|
+
},
|
|
28956
|
+
"metadata": {
|
|
28957
|
+
"purpose": "Query SalesOrderAttachment records with a JSON filter.",
|
|
28958
|
+
"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.",
|
|
28959
|
+
"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).",
|
|
28960
|
+
"related": [
|
|
28961
|
+
"sales_order_attachments.get"
|
|
28962
|
+
],
|
|
28963
|
+
"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.",
|
|
28964
|
+
"untrustedFields": [
|
|
28965
|
+
"title"
|
|
28966
|
+
]
|
|
28967
|
+
},
|
|
28968
|
+
"compact": null,
|
|
28969
|
+
"status": "tested"
|
|
28970
|
+
},
|
|
27543
28971
|
{
|
|
27544
28972
|
"id": "sales_orders.count",
|
|
27545
28973
|
"resource": "sales_orders",
|
|
@@ -43326,8 +44754,8 @@ const CAPABILITY_DATA = {
|
|
|
43326
44754
|
]
|
|
43327
44755
|
},
|
|
43328
44756
|
"A": {
|
|
43329
|
-
"planHash": "
|
|
43330
|
-
"builtAt": "2026-11-
|
|
44757
|
+
"planHash": "d758816a699191e3da784f70f8ebe1f37ea9458aaf528241770f7bac94ba6ede",
|
|
44758
|
+
"builtAt": "2026-11-19T12:16:58.732Z",
|
|
43331
44759
|
"records": [
|
|
43332
44760
|
{
|
|
43333
44761
|
"id": "attachment_info.count",
|
|
@@ -88494,8 +89922,8 @@ const CAPABILITY_DATA = {
|
|
|
88494
89922
|
]
|
|
88495
89923
|
},
|
|
88496
89924
|
"operations": {
|
|
88497
|
-
"planHash": "
|
|
88498
|
-
"builtAt": "2026-11-
|
|
89925
|
+
"planHash": "d758816a699191e3da784f70f8ebe1f37ea9458aaf528241770f7bac94ba6ede",
|
|
89926
|
+
"builtAt": "2026-11-19T12:16:58.732Z",
|
|
88499
89927
|
"records": [
|
|
88500
89928
|
{
|
|
88501
89929
|
"id": "operations.aggregate",
|