node-autotask 0.92.1 → 0.93.1
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 +11 -0
- package/MCP_TOOL_CATALOG.json +255 -9
- package/README.md +1 -1
- package/capabilities.json +1042 -222
- package/dist/capabilities-data.js +1296 -476
- package/dist/capabilities.cjs +4 -4
- package/dist/capabilities.js +1 -1
- package/dist/{chunk-2MC3LDZU.js → chunk-DCISF6AG.js} +3 -3
- package/dist/{chunk-JY6BQUPO.cjs → chunk-I75N5VVE.cjs} +202 -202
- package/dist/{chunk-C7KZ7PB3.js → chunk-L7SWLH3U.js} +4 -2
- package/dist/{chunk-QVDXIXY4.js → chunk-NDGMPMCW.js} +2 -2
- package/dist/{chunk-LYAHXYZR.cjs → chunk-NRO2NJAZ.cjs} +202 -19
- package/dist/{chunk-QC45KFQQ.cjs → chunk-RYPG3K4Y.cjs} +32 -30
- package/dist/{chunk-QXJQIZCT.cjs → chunk-SBHQIPCJ.cjs} +3 -3
- package/dist/{chunk-4BICEQ4S.js → chunk-TWQQ3EER.js} +197 -14
- package/dist/{index-B0p5O-2e.d.cts → index-Cbos4Wgx.d.cts} +71 -1
- package/dist/{index-B0p5O-2e.d.ts → index-Cbos4Wgx.d.ts} +71 -1
- package/dist/{index-opnSlg90.d.cts → index-CnNxnu7M.d.cts} +9 -2
- package/dist/{index-it9IqLsM.d.ts → index-coyFHSSF.d.ts} +9 -2
- package/dist/index.cjs +86 -86
- package/dist/index.d.cts +4 -4
- package/dist/index.d.ts +4 -4
- package/dist/index.js +5 -5
- package/dist/operations/index.cjs +51 -51
- package/dist/operations/index.d.cts +10 -4
- package/dist/operations/index.d.ts +10 -4
- package/dist/operations/index.js +2 -2
- package/dist/pool.cjs +24 -15
- package/dist/pool.d.cts +10 -7
- package/dist/pool.d.ts +10 -7
- package/dist/pool.js +17 -8
- package/dist/resources/index.cjs +27 -27
- package/dist/resources/index.d.cts +2 -2
- package/dist/resources/index.d.ts +2 -2
- package/dist/resources/index.js +3 -3
- package/dist/types/index.d.cts +1 -1
- package/dist/types/index.d.ts +1 -1
- package/docs/API.md +4 -2
- package/examples/mcp-server-http.ts +6 -3
- package/package.json +1 -1
|
@@ -208,6 +208,21 @@ const CAPABILITY_DATA = {
|
|
|
208
208
|
"REDIRECT_BLOCKED",
|
|
209
209
|
"STALE_OBJECT"
|
|
210
210
|
],
|
|
211
|
+
[
|
|
212
|
+
"BAD_REQUEST",
|
|
213
|
+
"CONFIG_ERROR",
|
|
214
|
+
"NETWORK_ERROR",
|
|
215
|
+
"UNAUTHORIZED",
|
|
216
|
+
"RATE_LIMITED",
|
|
217
|
+
"TIMEOUT",
|
|
218
|
+
"SERVER_ERROR",
|
|
219
|
+
"INVALID_RESPONSE",
|
|
220
|
+
"ABORTED",
|
|
221
|
+
"RESPONSE_TOO_LARGE",
|
|
222
|
+
"REDIRECT_BLOCKED",
|
|
223
|
+
"SCOPE_REQUIRED",
|
|
224
|
+
"FORBIDDEN"
|
|
225
|
+
],
|
|
211
226
|
[
|
|
212
227
|
"CONFIG_ERROR",
|
|
213
228
|
"NOT_FOUND",
|
|
@@ -344,21 +359,6 @@ const CAPABILITY_DATA = {
|
|
|
344
359
|
"REDIRECT_BLOCKED",
|
|
345
360
|
"FORBIDDEN"
|
|
346
361
|
],
|
|
347
|
-
[
|
|
348
|
-
"BAD_REQUEST",
|
|
349
|
-
"CONFIG_ERROR",
|
|
350
|
-
"NETWORK_ERROR",
|
|
351
|
-
"UNAUTHORIZED",
|
|
352
|
-
"RATE_LIMITED",
|
|
353
|
-
"TIMEOUT",
|
|
354
|
-
"SERVER_ERROR",
|
|
355
|
-
"INVALID_RESPONSE",
|
|
356
|
-
"ABORTED",
|
|
357
|
-
"RESPONSE_TOO_LARGE",
|
|
358
|
-
"REDIRECT_BLOCKED",
|
|
359
|
-
"SCOPE_REQUIRED",
|
|
360
|
-
"FORBIDDEN"
|
|
361
|
-
],
|
|
362
362
|
[
|
|
363
363
|
"BAD_REQUEST",
|
|
364
364
|
"CONFIG_ERROR",
|
|
@@ -526,8 +526,8 @@ const CAPABILITY_DATA = {
|
|
|
526
526
|
],
|
|
527
527
|
"groups": {
|
|
528
528
|
"B": {
|
|
529
|
-
"planHash": "
|
|
530
|
-
"builtAt": "2026-11-
|
|
529
|
+
"planHash": "51888554f455b96e13c50591342fa516b095065762430b783201ac7a995a0901",
|
|
530
|
+
"builtAt": "2026-11-22T07:17:16.330Z",
|
|
531
531
|
"records": [
|
|
532
532
|
{
|
|
533
533
|
"id": "appointments.count",
|
|
@@ -22593,12 +22593,12 @@ const CAPABILITY_DATA = {
|
|
|
22593
22593
|
"status": "tested"
|
|
22594
22594
|
},
|
|
22595
22595
|
{
|
|
22596
|
-
"id": "
|
|
22597
|
-
"resource": "
|
|
22596
|
+
"id": "organizational_resources.count",
|
|
22597
|
+
"resource": "organizational_resources",
|
|
22598
22598
|
"udfCapable": false,
|
|
22599
22599
|
"operation": "count",
|
|
22600
22600
|
"kind": "primitive",
|
|
22601
|
-
"endpoint": "
|
|
22601
|
+
"endpoint": "POST /V1.0/OrganizationalResources/query/count",
|
|
22602
22602
|
"effect": "read",
|
|
22603
22603
|
"flags": [],
|
|
22604
22604
|
"dryRun": false,
|
|
@@ -22628,7 +22628,7 @@ const CAPABILITY_DATA = {
|
|
|
22628
22628
|
"drops": []
|
|
22629
22629
|
},
|
|
22630
22630
|
"examples": [
|
|
22631
|
-
"await client.
|
|
22631
|
+
"await invoke(client, 'organizational_resources.count', [{ filter: [{ field: 'organizationalLevelAssociationID', op: 'eq', value: 7 }] }])"
|
|
22632
22632
|
],
|
|
22633
22633
|
"permissions": "unknown",
|
|
22634
22634
|
"pagination": {
|
|
@@ -22639,96 +22639,30 @@ const CAPABILITY_DATA = {
|
|
|
22639
22639
|
"preset": "retry-ffb3a9cb"
|
|
22640
22640
|
},
|
|
22641
22641
|
"errors": {
|
|
22642
|
-
"set":
|
|
22642
|
+
"set": 6
|
|
22643
22643
|
},
|
|
22644
22644
|
"metadata": {
|
|
22645
|
-
"purpose": "Count
|
|
22646
|
-
"usage": "Unwraps queryCount; returns a plain number.",
|
|
22645
|
+
"purpose": "Count OrganizationalResource membership records matching a JSON filter.",
|
|
22646
|
+
"usage": "Unwraps queryCount; returns a plain number. Organizational Structure activation and API-user/module permissions determine availability. The organization association and member resource do not establish company ownership. An empty result is inconclusive about tenant-wide absence. This resource is read-only.",
|
|
22647
22647
|
"preferredWhen": null,
|
|
22648
|
-
"related": [
|
|
22649
|
-
"product_vendors.query"
|
|
22650
|
-
],
|
|
22648
|
+
"related": [],
|
|
22651
22649
|
"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."
|
|
22652
22650
|
},
|
|
22653
22651
|
"compact": null,
|
|
22654
22652
|
"status": "tested"
|
|
22655
22653
|
},
|
|
22656
22654
|
{
|
|
22657
|
-
"id": "
|
|
22658
|
-
"resource": "
|
|
22659
|
-
"udfCapable": false,
|
|
22660
|
-
"operation": "create",
|
|
22661
|
-
"kind": "primitive",
|
|
22662
|
-
"endpoint": "POST /V1.0/Products/{parentId}/Vendors",
|
|
22663
|
-
"effect": "write",
|
|
22664
|
-
"flags": [],
|
|
22665
|
-
"dryRun": true,
|
|
22666
|
-
"envelope": "OperationResultModel",
|
|
22667
|
-
"inputSchema": {
|
|
22668
|
-
"parentId": {
|
|
22669
|
-
"type": "string | number",
|
|
22670
|
-
"required": true,
|
|
22671
|
-
"description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
|
|
22672
|
-
},
|
|
22673
|
-
"data": {
|
|
22674
|
-
"type": "object",
|
|
22675
|
-
"required": true,
|
|
22676
|
-
"description": "The record payload (vendor model fields)."
|
|
22677
|
-
}
|
|
22678
|
-
},
|
|
22679
|
-
"inputSchemaStrict": true,
|
|
22680
|
-
"outputSchema": {
|
|
22681
|
-
"type": "OperationResultModel",
|
|
22682
|
-
"drops": []
|
|
22683
|
-
},
|
|
22684
|
-
"examples": [
|
|
22685
|
-
"await client.productVendors.create('example-value', { name: 'example' }, { dryRun: true })"
|
|
22686
|
-
],
|
|
22687
|
-
"permissions": "unknown",
|
|
22688
|
-
"pagination": {
|
|
22689
|
-
"mode": "none"
|
|
22690
|
-
},
|
|
22691
|
-
"resolution": null,
|
|
22692
|
-
"retry": {
|
|
22693
|
-
"preset": "retry-c5657094"
|
|
22694
|
-
},
|
|
22695
|
-
"errors": {
|
|
22696
|
-
"set": 1
|
|
22697
|
-
},
|
|
22698
|
-
"metadata": {
|
|
22699
|
-
"purpose": "Create a product vendor.",
|
|
22700
|
-
"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.",
|
|
22701
|
-
"preferredWhen": "Only for a record that does not exist yet; prefer update for an id you already have.",
|
|
22702
|
-
"related": [
|
|
22703
|
-
"product_vendors.update"
|
|
22704
|
-
],
|
|
22705
|
-
"deleteBoundary": {
|
|
22706
|
-
"resource": "product_vendors",
|
|
22707
|
-
"note": "the vendor defines no DELETE for product_vendors (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.",
|
|
22708
|
-
"proof": "spec-derived"
|
|
22709
|
-
},
|
|
22710
|
-
"accountWide": true
|
|
22711
|
-
},
|
|
22712
|
-
"compact": null,
|
|
22713
|
-
"status": "tested"
|
|
22714
|
-
},
|
|
22715
|
-
{
|
|
22716
|
-
"id": "product_vendors.get",
|
|
22717
|
-
"resource": "product_vendors",
|
|
22655
|
+
"id": "organizational_resources.get",
|
|
22656
|
+
"resource": "organizational_resources",
|
|
22718
22657
|
"udfCapable": false,
|
|
22719
22658
|
"operation": "get",
|
|
22720
22659
|
"kind": "primitive",
|
|
22721
|
-
"endpoint": "GET /V1.0/
|
|
22660
|
+
"endpoint": "GET /V1.0/OrganizationalResources/{id}",
|
|
22722
22661
|
"effect": "read",
|
|
22723
22662
|
"flags": [],
|
|
22724
22663
|
"dryRun": false,
|
|
22725
|
-
"envelope": "ItemQueryResultModel[
|
|
22664
|
+
"envelope": "ItemQueryResultModel[OrganizationalResourceModel,BusinessDivisionSubdivisionResource]",
|
|
22726
22665
|
"inputSchema": {
|
|
22727
|
-
"parentId": {
|
|
22728
|
-
"type": "string | number",
|
|
22729
|
-
"required": true,
|
|
22730
|
-
"description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
|
|
22731
|
-
},
|
|
22732
22666
|
"id": {
|
|
22733
22667
|
"type": "string | number",
|
|
22734
22668
|
"required": true,
|
|
@@ -22749,11 +22683,11 @@ const CAPABILITY_DATA = {
|
|
|
22749
22683
|
},
|
|
22750
22684
|
"inputSchemaStrict": true,
|
|
22751
22685
|
"outputSchema": {
|
|
22752
|
-
"type": "ItemQueryResultModel[
|
|
22686
|
+
"type": "ItemQueryResultModel[OrganizationalResourceModel,BusinessDivisionSubdivisionResource]",
|
|
22753
22687
|
"drops": []
|
|
22754
22688
|
},
|
|
22755
22689
|
"examples": [
|
|
22756
|
-
"await client.
|
|
22690
|
+
"await client.organizationalResources.get('example-value')"
|
|
22757
22691
|
],
|
|
22758
22692
|
"permissions": "unknown",
|
|
22759
22693
|
"pagination": {
|
|
@@ -22767,24 +22701,22 @@ const CAPABILITY_DATA = {
|
|
|
22767
22701
|
"set": 3
|
|
22768
22702
|
},
|
|
22769
22703
|
"metadata": {
|
|
22770
|
-
"purpose": "Get one
|
|
22771
|
-
"usage": "item: null on the 200 body maps to NotFoundError (vendor not-found signal).
|
|
22772
|
-
"preferredWhen": "
|
|
22773
|
-
"related": [
|
|
22774
|
-
|
|
22775
|
-
],
|
|
22776
|
-
"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 product_vendors.query with includeFields."
|
|
22704
|
+
"purpose": "Get one OrganizationalResource by id.",
|
|
22705
|
+
"usage": "item: null on the 200 body maps to NotFoundError (vendor not-found signal). Organizational Structure activation and API-user/module permissions determine availability. The organization association and member resource do not establish company ownership. An empty result is inconclusive about tenant-wide absence. This resource is read-only.",
|
|
22706
|
+
"preferredWhen": "Use the OrganizationalResources record id for the global item read; bound discovery queries by organizationalLevelAssociationID. operations.fetchByIds currently refuses this parent-associated resource; use the registered global get or a filtered query.",
|
|
22707
|
+
"related": [],
|
|
22708
|
+
"args": "args[0] is the record id (safe integer or decimal string; use the string form above Number.MAX_SAFE_INTEGER). Item GET returns the FULL vendor model — the vendor documents no field selection on single-record reads. For a slim record use an organizational_resources.query with includeFields."
|
|
22777
22709
|
},
|
|
22778
22710
|
"compact": null,
|
|
22779
22711
|
"status": "tested"
|
|
22780
22712
|
},
|
|
22781
22713
|
{
|
|
22782
|
-
"id": "
|
|
22783
|
-
"resource": "
|
|
22714
|
+
"id": "organizational_resources.getEntityInfo",
|
|
22715
|
+
"resource": "organizational_resources",
|
|
22784
22716
|
"udfCapable": false,
|
|
22785
22717
|
"operation": "getEntityInfo",
|
|
22786
22718
|
"kind": "primitive",
|
|
22787
|
-
"endpoint": "GET /V1.0/
|
|
22719
|
+
"endpoint": "GET /V1.0/OrganizationalResources/entityInformation",
|
|
22788
22720
|
"effect": "read",
|
|
22789
22721
|
"flags": [],
|
|
22790
22722
|
"dryRun": false,
|
|
@@ -22796,7 +22728,7 @@ const CAPABILITY_DATA = {
|
|
|
22796
22728
|
"drops": []
|
|
22797
22729
|
},
|
|
22798
22730
|
"examples": [
|
|
22799
|
-
"await client.
|
|
22731
|
+
"await client.organizationalResources.getEntityInfo()"
|
|
22800
22732
|
],
|
|
22801
22733
|
"permissions": "unknown",
|
|
22802
22734
|
"pagination": {
|
|
@@ -22807,26 +22739,24 @@ const CAPABILITY_DATA = {
|
|
|
22807
22739
|
"preset": "retry-ffb3a9cb"
|
|
22808
22740
|
},
|
|
22809
22741
|
"errors": {
|
|
22810
|
-
"set":
|
|
22742
|
+
"set": 6
|
|
22811
22743
|
},
|
|
22812
22744
|
"metadata": {
|
|
22813
|
-
"purpose": "Get the
|
|
22814
|
-
"usage": "Unwraps info{}; drives client-side capability checks.",
|
|
22745
|
+
"purpose": "Get the OrganizationalResource capability metadata (canCreate/canUpdate/hasUserDefinedFields/...).",
|
|
22746
|
+
"usage": "Unwraps info{}; drives client-side capability checks. Organizational Structure activation and API-user/module permissions determine availability. The organization association and member resource do not establish company ownership. An empty result is inconclusive about tenant-wide absence. This resource is read-only.",
|
|
22815
22747
|
"preferredWhen": null,
|
|
22816
|
-
"related": [
|
|
22817
|
-
"product_vendors.getFieldInfo"
|
|
22818
|
-
]
|
|
22748
|
+
"related": []
|
|
22819
22749
|
},
|
|
22820
22750
|
"compact": null,
|
|
22821
22751
|
"status": "tested"
|
|
22822
22752
|
},
|
|
22823
22753
|
{
|
|
22824
|
-
"id": "
|
|
22825
|
-
"resource": "
|
|
22754
|
+
"id": "organizational_resources.getFieldInfo",
|
|
22755
|
+
"resource": "organizational_resources",
|
|
22826
22756
|
"udfCapable": false,
|
|
22827
22757
|
"operation": "getFieldInfo",
|
|
22828
22758
|
"kind": "primitive",
|
|
22829
|
-
"endpoint": "GET /V1.0/
|
|
22759
|
+
"endpoint": "GET /V1.0/OrganizationalResources/entityInformation/fields",
|
|
22830
22760
|
"effect": "read",
|
|
22831
22761
|
"flags": [],
|
|
22832
22762
|
"dryRun": false,
|
|
@@ -22838,7 +22768,7 @@ const CAPABILITY_DATA = {
|
|
|
22838
22768
|
"drops": []
|
|
22839
22769
|
},
|
|
22840
22770
|
"examples": [
|
|
22841
|
-
"await client.
|
|
22771
|
+
"await client.organizationalResources.getFieldInfo()"
|
|
22842
22772
|
],
|
|
22843
22773
|
"permissions": "unknown",
|
|
22844
22774
|
"pagination": {
|
|
@@ -22849,27 +22779,24 @@ const CAPABILITY_DATA = {
|
|
|
22849
22779
|
"preset": "retry-ffb3a9cb"
|
|
22850
22780
|
},
|
|
22851
22781
|
"errors": {
|
|
22852
|
-
"set":
|
|
22782
|
+
"set": 6
|
|
22853
22783
|
},
|
|
22854
22784
|
"metadata": {
|
|
22855
|
-
"purpose": "Get the
|
|
22785
|
+
"purpose": "Get the OrganizationalResource field catalog (types, picklists, required, maxLength) — the full raw field dump (the largest read of the info trio; compact discovery: operations.fieldCatalog).",
|
|
22856
22786
|
"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.",
|
|
22857
|
-
"preferredWhen":
|
|
22858
|
-
"related": [
|
|
22859
|
-
"product_vendors.getEntityInfo",
|
|
22860
|
-
"product_vendors.getUdfInfo"
|
|
22861
|
-
]
|
|
22787
|
+
"preferredWhen": "Use when full raw field details are needed. Organizational Structure activation and API-user/module permissions determine availability. The organization association and member resource do not establish company ownership. An empty result is inconclusive about tenant-wide absence. This resource is read-only.",
|
|
22788
|
+
"related": []
|
|
22862
22789
|
},
|
|
22863
22790
|
"compact": null,
|
|
22864
22791
|
"status": "tested"
|
|
22865
22792
|
},
|
|
22866
22793
|
{
|
|
22867
|
-
"id": "
|
|
22868
|
-
"resource": "
|
|
22794
|
+
"id": "organizational_resources.getUdfInfo",
|
|
22795
|
+
"resource": "organizational_resources",
|
|
22869
22796
|
"udfCapable": false,
|
|
22870
22797
|
"operation": "getUdfInfo",
|
|
22871
22798
|
"kind": "primitive",
|
|
22872
|
-
"endpoint": "GET /V1.0/
|
|
22799
|
+
"endpoint": "GET /V1.0/OrganizationalResources/entityInformation/userDefinedFields",
|
|
22873
22800
|
"effect": "read",
|
|
22874
22801
|
"flags": [],
|
|
22875
22802
|
"dryRun": false,
|
|
@@ -22881,7 +22808,7 @@ const CAPABILITY_DATA = {
|
|
|
22881
22808
|
"drops": []
|
|
22882
22809
|
},
|
|
22883
22810
|
"examples": [
|
|
22884
|
-
"await client.
|
|
22811
|
+
"await client.organizationalResources.getUdfInfo()"
|
|
22885
22812
|
],
|
|
22886
22813
|
"permissions": "unknown",
|
|
22887
22814
|
"pagination": {
|
|
@@ -22892,30 +22819,78 @@ const CAPABILITY_DATA = {
|
|
|
22892
22819
|
"preset": "retry-ffb3a9cb"
|
|
22893
22820
|
},
|
|
22894
22821
|
"errors": {
|
|
22895
|
-
"set":
|
|
22822
|
+
"set": 6
|
|
22896
22823
|
},
|
|
22897
22824
|
"metadata": {
|
|
22898
|
-
"purpose": "Get the
|
|
22899
|
-
"usage": "Unwraps fields[]; only meaningful where the entity is UDF-capable. (entity is not UDF-capable; catalog is expected empty).",
|
|
22825
|
+
"purpose": "Get the OrganizationalResource user-defined-field catalog.",
|
|
22826
|
+
"usage": "Unwraps fields[]; only meaningful where the entity is UDF-capable. (entity is not UDF-capable; catalog is expected empty). Organizational Structure activation and API-user/module permissions determine availability. The organization association and member resource do not establish company ownership. An empty result is inconclusive about tenant-wide absence. This resource is read-only.",
|
|
22900
22827
|
"preferredWhen": null,
|
|
22828
|
+
"related": []
|
|
22829
|
+
},
|
|
22830
|
+
"compact": null,
|
|
22831
|
+
"status": "tested"
|
|
22832
|
+
},
|
|
22833
|
+
{
|
|
22834
|
+
"id": "organizational_resources.listByParent",
|
|
22835
|
+
"resource": "organizational_resources",
|
|
22836
|
+
"udfCapable": false,
|
|
22837
|
+
"operation": "listByParent",
|
|
22838
|
+
"kind": "primitive",
|
|
22839
|
+
"endpoint": "GET /V1.0/OrganizationalLevelAssociations/{parentId}/Resources",
|
|
22840
|
+
"effect": "read",
|
|
22841
|
+
"flags": [],
|
|
22842
|
+
"dryRun": false,
|
|
22843
|
+
"envelope": "QueryActionResult[OrganizationalResourceModel,BusinessDivisionSubdivisionResource]",
|
|
22844
|
+
"inputSchema": {
|
|
22845
|
+
"parentId": {
|
|
22846
|
+
"type": "string | number",
|
|
22847
|
+
"required": true,
|
|
22848
|
+
"description": "The documented parent route id; no filter, limit, or caller cursor is accepted."
|
|
22849
|
+
}
|
|
22850
|
+
},
|
|
22851
|
+
"inputSchemaStrict": true,
|
|
22852
|
+
"outputSchema": {
|
|
22853
|
+
"type": "QueryActionResult[OrganizationalResourceModel,BusinessDivisionSubdivisionResource]",
|
|
22854
|
+
"drops": []
|
|
22855
|
+
},
|
|
22856
|
+
"examples": [
|
|
22857
|
+
"await invoke(client, 'organizational_resources.listByParent', [7])"
|
|
22858
|
+
],
|
|
22859
|
+
"permissions": "unknown",
|
|
22860
|
+
"pagination": {
|
|
22861
|
+
"mode": "none"
|
|
22862
|
+
},
|
|
22863
|
+
"resolution": null,
|
|
22864
|
+
"retry": {
|
|
22865
|
+
"preset": "retry-ffb3a9cb"
|
|
22866
|
+
},
|
|
22867
|
+
"errors": {
|
|
22868
|
+
"set": 11
|
|
22869
|
+
},
|
|
22870
|
+
"metadata": {
|
|
22871
|
+
"purpose": "Read one native parent-scoped staff-association page.",
|
|
22872
|
+
"usage": "One vendor-controlled native page, with no supported filter or limit argument. Returns items and hasMore; no raw cursor is served or followed. Use the global query with a total limit and an explicit organizationalLevelAssociationID filter for a complete bounded query within its caps; exact scoped/global membership or visibility parity is unproven. API-user permissions and enabled features remain conditional. Staff associations do not establish company ownership. Organizational Structure activation controls availability. Returned rows must match the requested parent through the documented int32 organizationalLevelAssociationID field. Under that model a route parent above the signed int32 range can only yield a valid empty page. An empty page does not establish tenant-wide absence.",
|
|
22873
|
+
"args": "args[0] is the route parent ID, a non-negative signed int64 integer. Use a decimal string above Number.MAX_SAFE_INTEGER. Each returned row has its own independent int64 ID.",
|
|
22874
|
+
"preferredWhen": "Use when the documented native parent collection is required; global get remains single-record-id only.",
|
|
22901
22875
|
"related": [
|
|
22902
|
-
"
|
|
22876
|
+
"organizational_resources.query",
|
|
22877
|
+
"organizational_resources.get"
|
|
22903
22878
|
]
|
|
22904
22879
|
},
|
|
22905
22880
|
"compact": null,
|
|
22906
22881
|
"status": "tested"
|
|
22907
22882
|
},
|
|
22908
22883
|
{
|
|
22909
|
-
"id": "
|
|
22910
|
-
"resource": "
|
|
22884
|
+
"id": "organizational_resources.query",
|
|
22885
|
+
"resource": "organizational_resources",
|
|
22911
22886
|
"udfCapable": false,
|
|
22912
22887
|
"operation": "query",
|
|
22913
22888
|
"kind": "primitive",
|
|
22914
|
-
"endpoint": "GET|POST /V1.0/
|
|
22889
|
+
"endpoint": "GET|POST /V1.0/OrganizationalResources/query",
|
|
22915
22890
|
"effect": "read",
|
|
22916
22891
|
"flags": [],
|
|
22917
22892
|
"dryRun": false,
|
|
22918
|
-
"envelope": "QueryActionResult[
|
|
22893
|
+
"envelope": "QueryActionResult[OrganizationalResourceModel,BusinessDivisionSubdivisionResource]",
|
|
22919
22894
|
"inputSchema": {
|
|
22920
22895
|
"params": {
|
|
22921
22896
|
"type": "object",
|
|
@@ -22979,11 +22954,11 @@ const CAPABILITY_DATA = {
|
|
|
22979
22954
|
},
|
|
22980
22955
|
"inputSchemaStrict": true,
|
|
22981
22956
|
"outputSchema": {
|
|
22982
|
-
"type": "QueryActionResult[
|
|
22957
|
+
"type": "QueryActionResult[OrganizationalResourceModel,BusinessDivisionSubdivisionResource]",
|
|
22983
22958
|
"drops": []
|
|
22984
22959
|
},
|
|
22985
22960
|
"examples": [
|
|
22986
|
-
"await client.
|
|
22961
|
+
"await invoke(client, 'organizational_resources.query', [{ filter: [{ field: 'organizationalLevelAssociationID', op: 'eq', value: 7 }], limit: 25 }])"
|
|
22987
22962
|
],
|
|
22988
22963
|
"permissions": "unknown",
|
|
22989
22964
|
"pagination": {
|
|
@@ -23001,152 +22976,573 @@ const CAPABILITY_DATA = {
|
|
|
23001
22976
|
"preset": "retry-ffb3a9cb"
|
|
23002
22977
|
},
|
|
23003
22978
|
"errors": {
|
|
23004
|
-
"set":
|
|
22979
|
+
"set": 11
|
|
23005
22980
|
},
|
|
23006
22981
|
"metadata": {
|
|
23007
|
-
"purpose": "Query
|
|
23008
|
-
"usage": "Server-side pagination: one call walks the vendor cursor internally and preserves the initial HTTP method until the limit is met or the cursor is null. By default, each POST carries the same QueryModel body (IncludeFields, MaxRecords and the original filter). The vendor honours IncludeFields on POST continuations and uses its own continuation page size. With `via: 'get'`, the SDK follows the GET cursor with the original search parameters. Cursors must stay on the configured origin; 1000-page guard (hasMore stays true at the guard). queryAll is the unbounded raw walk — only when you need the ENTIRE set and accept a large payload; default to the bounded query op. noteChars: N (integer >= 1) is an opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose — the same set the server wraps): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result (zero wire — response-side only). latest: N returns the N highest-id rows (id-descending): the vendor has no sort parameter — this is the only ordering channel, and a date window in `filter` narrows the cost; count-anchored — C ≤ 2500 → one count + a ≤6-page walk of the matching set, C > 2500 → count probes + an id-threshold window (≤64 probes; LATEST_THRESHOLD_UNRESOLVED on budget exhaustion), a blind count → a bounded walk with the blind-surface stamp (LATEST_WINDOW_INCOMPLETE on a truncated walk).
|
|
22982
|
+
"purpose": "Query OrganizationalResource records with a JSON filter.",
|
|
22983
|
+
"usage": "Server-side pagination: one call walks the vendor cursor internally and preserves the initial HTTP method until the limit is met or the cursor is null. By default, each POST carries the same QueryModel body (IncludeFields, MaxRecords and the original filter). The vendor honours IncludeFields on POST continuations and uses its own continuation page size. With `via: 'get'`, the SDK follows the GET cursor with the original search parameters. Cursors must stay on the configured origin; 1000-page guard (hasMore stays true at the guard). queryAll is the unbounded raw walk — only when you need the ENTIRE set and accept a large payload; default to the bounded query op. noteChars: N (integer >= 1) is an opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose — the same set the server wraps): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result (zero wire — response-side only). latest: N returns the N highest-id rows (id-descending): the vendor has no sort parameter — this is the only ordering channel, and a date window in `filter` narrows the cost; count-anchored — C ≤ 2500 → one count + a ≤6-page walk of the matching set, C > 2500 → count probes + an id-threshold window (≤64 probes; LATEST_THRESHOLD_UNRESOLVED on budget exhaustion), a blind count → a bounded walk with the blind-surface stamp (LATEST_WINDOW_INCOMPLETE on a truncated walk). Explicit walk.maxRows independently sets the TOTAL returned-row cap (including export-sized walks); the ordinary limit is still validated in 1..2500 and only bounds the internal page size for this form. hasMore and truncated remain true at the page guard or while a cursor or unserved fetched rows remain. Self-resource prefixes are accepted in filter fields and includeFields; dotted UDF names are always refused before metadata or vendor requests, never rewritten to another tenant UDF. Organizational Structure activation and API-user/module permissions determine availability. The organization association and member resource do not establish company ownership. An empty result is inconclusive about tenant-wide absence. This resource is read-only. Query remains global; filter with organizationalLevelAssociationID eq the association id to select its members.",
|
|
23009
22984
|
"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).",
|
|
23010
|
-
"related": [
|
|
23011
|
-
"product_vendors.resolve"
|
|
23012
|
-
],
|
|
22985
|
+
"related": [],
|
|
23013
22986
|
"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."
|
|
23014
22987
|
},
|
|
23015
22988
|
"compact": null,
|
|
23016
22989
|
"status": "tested"
|
|
23017
22990
|
},
|
|
23018
22991
|
{
|
|
23019
|
-
"id": "product_vendors.
|
|
23020
|
-
"resource": "product_vendors",
|
|
23021
|
-
"udfCapable": false,
|
|
23022
|
-
"operation": "resolve",
|
|
23023
|
-
"kind": "helper",
|
|
23024
|
-
"endpoint": null,
|
|
23025
|
-
"effect": "read",
|
|
23026
|
-
"flags": [],
|
|
23027
|
-
"dryRun": false,
|
|
23028
|
-
"envelope": null,
|
|
23029
|
-
"inputSchema": {
|
|
23030
|
-
"identifier": {
|
|
23031
|
-
"type": "string | number",
|
|
23032
|
-
"required": true,
|
|
23033
|
-
"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)."
|
|
23034
|
-
},
|
|
23035
|
-
"opts": {
|
|
23036
|
-
"type": "object",
|
|
23037
|
-
"required": false,
|
|
23038
|
-
"description": "ResolutionOpts — { expand?: boolean } (return the full record; a no-op where the Summary is a structural alias).",
|
|
23039
|
-
"properties": [
|
|
23040
|
-
{
|
|
23041
|
-
"name": "expand",
|
|
23042
|
-
"type": "boolean",
|
|
23043
|
-
"optional": true
|
|
23044
|
-
}
|
|
23045
|
-
]
|
|
23046
|
-
}
|
|
23047
|
-
},
|
|
23048
|
-
"inputSchemaStrict": true,
|
|
23049
|
-
"outputSchema": {
|
|
23050
|
-
"type": "ProductVendorsSummary",
|
|
23051
|
-
"drops": []
|
|
23052
|
-
},
|
|
23053
|
-
"examples": [
|
|
23054
|
-
"await client.productVendors.resolve('example-value')"
|
|
23055
|
-
],
|
|
23056
|
-
"permissions": "unknown",
|
|
23057
|
-
"pagination": {
|
|
23058
|
-
"mode": "none"
|
|
23059
|
-
},
|
|
23060
|
-
"resolution": {
|
|
23061
|
-
"basis": "server-filter",
|
|
23062
|
-
"maxScanRecords": 500,
|
|
23063
|
-
"maxScanPages": 4
|
|
23064
|
-
},
|
|
23065
|
-
"retry": {
|
|
23066
|
-
"preset": "retry-ffb3a9cb"
|
|
23067
|
-
},
|
|
23068
|
-
"errors": {
|
|
23069
|
-
"set": 5
|
|
23070
|
-
},
|
|
23071
|
-
"metadata": {
|
|
23072
|
-
"purpose": "Resolve a product vendor from a numeric id (the direct fetch) only — this resource has no searchable text field, so a non-numeric identifier throws a config error.",
|
|
23073
|
-
"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.",
|
|
23074
|
-
"preferredWhen": null,
|
|
23075
|
-
"related": [
|
|
23076
|
-
"product_vendors.get"
|
|
23077
|
-
]
|
|
23078
|
-
},
|
|
23079
|
-
"compact": "ProductVendorsSummary",
|
|
23080
|
-
"status": "tested"
|
|
23081
|
-
},
|
|
23082
|
-
{
|
|
23083
|
-
"id": "product_vendors.update",
|
|
22992
|
+
"id": "product_vendors.count",
|
|
23084
22993
|
"resource": "product_vendors",
|
|
23085
22994
|
"udfCapable": false,
|
|
23086
|
-
"operation": "update",
|
|
23087
|
-
"kind": "primitive",
|
|
23088
|
-
"endpoint": "PUT|PATCH /V1.0/Products/{parentId}/Vendors",
|
|
23089
|
-
"effect": "write",
|
|
23090
|
-
"flags": [
|
|
23091
|
-
"idempotent"
|
|
23092
|
-
],
|
|
23093
|
-
"dryRun": true,
|
|
23094
|
-
"envelope": "OperationResultModel",
|
|
23095
|
-
"inputSchema": {
|
|
23096
|
-
"parentId": {
|
|
23097
|
-
"type": "string | number",
|
|
23098
|
-
"required": true,
|
|
23099
|
-
"description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
|
|
23100
|
-
},
|
|
23101
|
-
"id": {
|
|
23102
|
-
"type": "string | number",
|
|
23103
|
-
"required": true,
|
|
23104
|
-
"description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
|
|
23105
|
-
},
|
|
23106
|
-
"data": {
|
|
23107
|
-
"type": "object",
|
|
23108
|
-
"required": true,
|
|
23109
|
-
"description": "The record payload (vendor model fields)."
|
|
23110
|
-
}
|
|
23111
|
-
},
|
|
23112
|
-
"inputSchemaStrict": true,
|
|
23113
|
-
"outputSchema": {
|
|
23114
|
-
"type": "OperationResultModel",
|
|
23115
|
-
"drops": []
|
|
23116
|
-
},
|
|
23117
|
-
"examples": [
|
|
23118
|
-
"await client.productVendors.update('example-value', 'example-value', { name: 'example' }, { dryRun: true })"
|
|
23119
|
-
],
|
|
23120
|
-
"permissions": "unknown",
|
|
23121
|
-
"pagination": {
|
|
23122
|
-
"mode": "none"
|
|
23123
|
-
},
|
|
23124
|
-
"resolution": null,
|
|
23125
|
-
"retry": {
|
|
23126
|
-
"preset": "retry-85897a3a"
|
|
23127
|
-
},
|
|
23128
|
-
"errors": {
|
|
23129
|
-
"set": 1
|
|
23130
|
-
},
|
|
23131
|
-
"metadata": {
|
|
23132
|
-
"purpose": "Update a product vendor.",
|
|
23133
|
-
"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.",
|
|
23134
|
-
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
23135
|
-
"related": [
|
|
23136
|
-
"product_vendors.get"
|
|
23137
|
-
],
|
|
23138
|
-
"accountWide": true
|
|
23139
|
-
},
|
|
23140
|
-
"compact": null,
|
|
23141
|
-
"status": "tested"
|
|
23142
|
-
},
|
|
23143
|
-
{
|
|
23144
|
-
"id": "products.count",
|
|
23145
|
-
"resource": "products",
|
|
23146
|
-
"udfCapable": true,
|
|
23147
22995
|
"operation": "count",
|
|
23148
22996
|
"kind": "primitive",
|
|
23149
|
-
"endpoint": "GET|POST /V1.0/
|
|
22997
|
+
"endpoint": "GET|POST /V1.0/ProductVendors/query/count",
|
|
22998
|
+
"effect": "read",
|
|
22999
|
+
"flags": [],
|
|
23000
|
+
"dryRun": false,
|
|
23001
|
+
"envelope": "QueryCountResultModel",
|
|
23002
|
+
"inputSchema": {
|
|
23003
|
+
"params": {
|
|
23004
|
+
"type": "object",
|
|
23005
|
+
"required": false,
|
|
23006
|
+
"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.",
|
|
23007
|
+
"properties": [
|
|
23008
|
+
{
|
|
23009
|
+
"name": "filter",
|
|
23010
|
+
"type": "FilterCondition[]",
|
|
23011
|
+
"optional": true
|
|
23012
|
+
},
|
|
23013
|
+
{
|
|
23014
|
+
"name": "fieldCheck",
|
|
23015
|
+
"type": "boolean",
|
|
23016
|
+
"optional": true
|
|
23017
|
+
}
|
|
23018
|
+
]
|
|
23019
|
+
}
|
|
23020
|
+
},
|
|
23021
|
+
"inputSchemaStrict": true,
|
|
23022
|
+
"outputSchema": {
|
|
23023
|
+
"type": "QueryCountResultModel",
|
|
23024
|
+
"drops": []
|
|
23025
|
+
},
|
|
23026
|
+
"examples": [
|
|
23027
|
+
"await client.productVendors.count({ filter: [{ field: 'name', op: 'eq', value: 'example' }] })"
|
|
23028
|
+
],
|
|
23029
|
+
"permissions": "unknown",
|
|
23030
|
+
"pagination": {
|
|
23031
|
+
"mode": "none"
|
|
23032
|
+
},
|
|
23033
|
+
"resolution": null,
|
|
23034
|
+
"retry": {
|
|
23035
|
+
"preset": "retry-ffb3a9cb"
|
|
23036
|
+
},
|
|
23037
|
+
"errors": {
|
|
23038
|
+
"set": 0
|
|
23039
|
+
},
|
|
23040
|
+
"metadata": {
|
|
23041
|
+
"purpose": "Count product vendor records matching a JSON filter.",
|
|
23042
|
+
"usage": "Unwraps queryCount; returns a plain number.",
|
|
23043
|
+
"preferredWhen": null,
|
|
23044
|
+
"related": [
|
|
23045
|
+
"product_vendors.query"
|
|
23046
|
+
],
|
|
23047
|
+
"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."
|
|
23048
|
+
},
|
|
23049
|
+
"compact": null,
|
|
23050
|
+
"status": "tested"
|
|
23051
|
+
},
|
|
23052
|
+
{
|
|
23053
|
+
"id": "product_vendors.create",
|
|
23054
|
+
"resource": "product_vendors",
|
|
23055
|
+
"udfCapable": false,
|
|
23056
|
+
"operation": "create",
|
|
23057
|
+
"kind": "primitive",
|
|
23058
|
+
"endpoint": "POST /V1.0/Products/{parentId}/Vendors",
|
|
23059
|
+
"effect": "write",
|
|
23060
|
+
"flags": [],
|
|
23061
|
+
"dryRun": true,
|
|
23062
|
+
"envelope": "OperationResultModel",
|
|
23063
|
+
"inputSchema": {
|
|
23064
|
+
"parentId": {
|
|
23065
|
+
"type": "string | number",
|
|
23066
|
+
"required": true,
|
|
23067
|
+
"description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
|
|
23068
|
+
},
|
|
23069
|
+
"data": {
|
|
23070
|
+
"type": "object",
|
|
23071
|
+
"required": true,
|
|
23072
|
+
"description": "The record payload (vendor model fields)."
|
|
23073
|
+
}
|
|
23074
|
+
},
|
|
23075
|
+
"inputSchemaStrict": true,
|
|
23076
|
+
"outputSchema": {
|
|
23077
|
+
"type": "OperationResultModel",
|
|
23078
|
+
"drops": []
|
|
23079
|
+
},
|
|
23080
|
+
"examples": [
|
|
23081
|
+
"await client.productVendors.create('example-value', { name: 'example' }, { dryRun: true })"
|
|
23082
|
+
],
|
|
23083
|
+
"permissions": "unknown",
|
|
23084
|
+
"pagination": {
|
|
23085
|
+
"mode": "none"
|
|
23086
|
+
},
|
|
23087
|
+
"resolution": null,
|
|
23088
|
+
"retry": {
|
|
23089
|
+
"preset": "retry-c5657094"
|
|
23090
|
+
},
|
|
23091
|
+
"errors": {
|
|
23092
|
+
"set": 1
|
|
23093
|
+
},
|
|
23094
|
+
"metadata": {
|
|
23095
|
+
"purpose": "Create a product vendor.",
|
|
23096
|
+
"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.",
|
|
23097
|
+
"preferredWhen": "Only for a record that does not exist yet; prefer update for an id you already have.",
|
|
23098
|
+
"related": [
|
|
23099
|
+
"product_vendors.update"
|
|
23100
|
+
],
|
|
23101
|
+
"deleteBoundary": {
|
|
23102
|
+
"resource": "product_vendors",
|
|
23103
|
+
"note": "the vendor defines no DELETE for product_vendors (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.",
|
|
23104
|
+
"proof": "spec-derived"
|
|
23105
|
+
},
|
|
23106
|
+
"accountWide": true
|
|
23107
|
+
},
|
|
23108
|
+
"compact": null,
|
|
23109
|
+
"status": "tested"
|
|
23110
|
+
},
|
|
23111
|
+
{
|
|
23112
|
+
"id": "product_vendors.get",
|
|
23113
|
+
"resource": "product_vendors",
|
|
23114
|
+
"udfCapable": false,
|
|
23115
|
+
"operation": "get",
|
|
23116
|
+
"kind": "primitive",
|
|
23117
|
+
"endpoint": "GET /V1.0/Products/{parentId}/Vendors/{id}",
|
|
23118
|
+
"effect": "read",
|
|
23119
|
+
"flags": [],
|
|
23120
|
+
"dryRun": false,
|
|
23121
|
+
"envelope": "ItemQueryResultModel[ProductVendorModel,ProductVendor]",
|
|
23122
|
+
"inputSchema": {
|
|
23123
|
+
"parentId": {
|
|
23124
|
+
"type": "string | number",
|
|
23125
|
+
"required": true,
|
|
23126
|
+
"description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
|
|
23127
|
+
},
|
|
23128
|
+
"id": {
|
|
23129
|
+
"type": "string | number",
|
|
23130
|
+
"required": true,
|
|
23131
|
+
"description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
|
|
23132
|
+
},
|
|
23133
|
+
"opts": {
|
|
23134
|
+
"type": "object",
|
|
23135
|
+
"required": false,
|
|
23136
|
+
"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.",
|
|
23137
|
+
"properties": [
|
|
23138
|
+
{
|
|
23139
|
+
"name": "fresh",
|
|
23140
|
+
"type": "boolean",
|
|
23141
|
+
"optional": true
|
|
23142
|
+
}
|
|
23143
|
+
]
|
|
23144
|
+
}
|
|
23145
|
+
},
|
|
23146
|
+
"inputSchemaStrict": true,
|
|
23147
|
+
"outputSchema": {
|
|
23148
|
+
"type": "ItemQueryResultModel[ProductVendorModel,ProductVendor]",
|
|
23149
|
+
"drops": []
|
|
23150
|
+
},
|
|
23151
|
+
"examples": [
|
|
23152
|
+
"await client.productVendors.get('example-value', 'example-value')"
|
|
23153
|
+
],
|
|
23154
|
+
"permissions": "unknown",
|
|
23155
|
+
"pagination": {
|
|
23156
|
+
"mode": "none"
|
|
23157
|
+
},
|
|
23158
|
+
"resolution": null,
|
|
23159
|
+
"retry": {
|
|
23160
|
+
"preset": "retry-ffb3a9cb"
|
|
23161
|
+
},
|
|
23162
|
+
"errors": {
|
|
23163
|
+
"set": 3
|
|
23164
|
+
},
|
|
23165
|
+
"metadata": {
|
|
23166
|
+
"purpose": "Get one ProductVendors by id.",
|
|
23167
|
+
"usage": "item: null on the 200 body maps to NotFoundError (vendor not-found signal). Parent-scoped: parentId + id.",
|
|
23168
|
+
"preferredWhen": "Preferred when the numeric id is already known; product_vendors.resolve is for a field value.",
|
|
23169
|
+
"related": [
|
|
23170
|
+
"product_vendors.resolve"
|
|
23171
|
+
],
|
|
23172
|
+
"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 product_vendors.query with includeFields."
|
|
23173
|
+
},
|
|
23174
|
+
"compact": null,
|
|
23175
|
+
"status": "tested"
|
|
23176
|
+
},
|
|
23177
|
+
{
|
|
23178
|
+
"id": "product_vendors.getEntityInfo",
|
|
23179
|
+
"resource": "product_vendors",
|
|
23180
|
+
"udfCapable": false,
|
|
23181
|
+
"operation": "getEntityInfo",
|
|
23182
|
+
"kind": "primitive",
|
|
23183
|
+
"endpoint": "GET /V1.0/ProductVendors/entityInformation",
|
|
23184
|
+
"effect": "read",
|
|
23185
|
+
"flags": [],
|
|
23186
|
+
"dryRun": false,
|
|
23187
|
+
"envelope": "EntityInformationResultModel",
|
|
23188
|
+
"inputSchema": {},
|
|
23189
|
+
"inputSchemaStrict": true,
|
|
23190
|
+
"outputSchema": {
|
|
23191
|
+
"type": "EntityInformationResultModel",
|
|
23192
|
+
"drops": []
|
|
23193
|
+
},
|
|
23194
|
+
"examples": [
|
|
23195
|
+
"await client.productVendors.getEntityInfo()"
|
|
23196
|
+
],
|
|
23197
|
+
"permissions": "unknown",
|
|
23198
|
+
"pagination": {
|
|
23199
|
+
"mode": "none"
|
|
23200
|
+
},
|
|
23201
|
+
"resolution": null,
|
|
23202
|
+
"retry": {
|
|
23203
|
+
"preset": "retry-ffb3a9cb"
|
|
23204
|
+
},
|
|
23205
|
+
"errors": {
|
|
23206
|
+
"set": 0
|
|
23207
|
+
},
|
|
23208
|
+
"metadata": {
|
|
23209
|
+
"purpose": "Get the ProductVendors capability metadata (canCreate/canUpdate/hasUserDefinedFields/...).",
|
|
23210
|
+
"usage": "Unwraps info{}; drives client-side capability checks.",
|
|
23211
|
+
"preferredWhen": null,
|
|
23212
|
+
"related": [
|
|
23213
|
+
"product_vendors.getFieldInfo"
|
|
23214
|
+
]
|
|
23215
|
+
},
|
|
23216
|
+
"compact": null,
|
|
23217
|
+
"status": "tested"
|
|
23218
|
+
},
|
|
23219
|
+
{
|
|
23220
|
+
"id": "product_vendors.getFieldInfo",
|
|
23221
|
+
"resource": "product_vendors",
|
|
23222
|
+
"udfCapable": false,
|
|
23223
|
+
"operation": "getFieldInfo",
|
|
23224
|
+
"kind": "primitive",
|
|
23225
|
+
"endpoint": "GET /V1.0/ProductVendors/entityInformation/fields",
|
|
23226
|
+
"effect": "read",
|
|
23227
|
+
"flags": [],
|
|
23228
|
+
"dryRun": false,
|
|
23229
|
+
"envelope": "FieldInformationResultModel",
|
|
23230
|
+
"inputSchema": {},
|
|
23231
|
+
"inputSchemaStrict": true,
|
|
23232
|
+
"outputSchema": {
|
|
23233
|
+
"type": "FieldInformationResultModel",
|
|
23234
|
+
"drops": []
|
|
23235
|
+
},
|
|
23236
|
+
"examples": [
|
|
23237
|
+
"await client.productVendors.getFieldInfo()"
|
|
23238
|
+
],
|
|
23239
|
+
"permissions": "unknown",
|
|
23240
|
+
"pagination": {
|
|
23241
|
+
"mode": "none"
|
|
23242
|
+
},
|
|
23243
|
+
"resolution": null,
|
|
23244
|
+
"retry": {
|
|
23245
|
+
"preset": "retry-ffb3a9cb"
|
|
23246
|
+
},
|
|
23247
|
+
"errors": {
|
|
23248
|
+
"set": 0
|
|
23249
|
+
},
|
|
23250
|
+
"metadata": {
|
|
23251
|
+
"purpose": "Get the ProductVendors field catalog (types, picklists, required, maxLength) — the full raw field dump (the largest read of the info trio; compact discovery: operations.fieldCatalog).",
|
|
23252
|
+
"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.",
|
|
23253
|
+
"preferredWhen": null,
|
|
23254
|
+
"related": [
|
|
23255
|
+
"product_vendors.getEntityInfo",
|
|
23256
|
+
"product_vendors.getUdfInfo"
|
|
23257
|
+
]
|
|
23258
|
+
},
|
|
23259
|
+
"compact": null,
|
|
23260
|
+
"status": "tested"
|
|
23261
|
+
},
|
|
23262
|
+
{
|
|
23263
|
+
"id": "product_vendors.getUdfInfo",
|
|
23264
|
+
"resource": "product_vendors",
|
|
23265
|
+
"udfCapable": false,
|
|
23266
|
+
"operation": "getUdfInfo",
|
|
23267
|
+
"kind": "primitive",
|
|
23268
|
+
"endpoint": "GET /V1.0/ProductVendors/entityInformation/userDefinedFields",
|
|
23269
|
+
"effect": "read",
|
|
23270
|
+
"flags": [],
|
|
23271
|
+
"dryRun": false,
|
|
23272
|
+
"envelope": "UserDefinedFieldInformationResultModel",
|
|
23273
|
+
"inputSchema": {},
|
|
23274
|
+
"inputSchemaStrict": true,
|
|
23275
|
+
"outputSchema": {
|
|
23276
|
+
"type": "UserDefinedFieldInformationResultModel",
|
|
23277
|
+
"drops": []
|
|
23278
|
+
},
|
|
23279
|
+
"examples": [
|
|
23280
|
+
"await client.productVendors.getUdfInfo()"
|
|
23281
|
+
],
|
|
23282
|
+
"permissions": "unknown",
|
|
23283
|
+
"pagination": {
|
|
23284
|
+
"mode": "none"
|
|
23285
|
+
},
|
|
23286
|
+
"resolution": null,
|
|
23287
|
+
"retry": {
|
|
23288
|
+
"preset": "retry-ffb3a9cb"
|
|
23289
|
+
},
|
|
23290
|
+
"errors": {
|
|
23291
|
+
"set": 0
|
|
23292
|
+
},
|
|
23293
|
+
"metadata": {
|
|
23294
|
+
"purpose": "Get the ProductVendors user-defined-field catalog.",
|
|
23295
|
+
"usage": "Unwraps fields[]; only meaningful where the entity is UDF-capable. (entity is not UDF-capable; catalog is expected empty).",
|
|
23296
|
+
"preferredWhen": null,
|
|
23297
|
+
"related": [
|
|
23298
|
+
"product_vendors.getFieldInfo"
|
|
23299
|
+
]
|
|
23300
|
+
},
|
|
23301
|
+
"compact": null,
|
|
23302
|
+
"status": "tested"
|
|
23303
|
+
},
|
|
23304
|
+
{
|
|
23305
|
+
"id": "product_vendors.query",
|
|
23306
|
+
"resource": "product_vendors",
|
|
23307
|
+
"udfCapable": false,
|
|
23308
|
+
"operation": "query",
|
|
23309
|
+
"kind": "primitive",
|
|
23310
|
+
"endpoint": "GET|POST /V1.0/ProductVendors/query",
|
|
23311
|
+
"effect": "read",
|
|
23312
|
+
"flags": [],
|
|
23313
|
+
"dryRun": false,
|
|
23314
|
+
"envelope": "QueryActionResult[<Model>,<Entity>]",
|
|
23315
|
+
"inputSchema": {
|
|
23316
|
+
"params": {
|
|
23317
|
+
"type": "object",
|
|
23318
|
+
"required": false,
|
|
23319
|
+
"description": "The query params object (CLOSED — unknown keys are refused pre-request with a typed error naming the key + the valid keys): { filter?: FilterCondition[], limit?: number (total cap, default 500, max 2500 — NOT a page size), latest?: number (1-2500; the N highest-id rows — the vendor has no sort; count-probe + id-threshold semantics, see docs/API.md §4; the same-process latest-walk count probes are briefly cached per client — a 30 s TTL, cleared on a write through this client (a probe in flight across the write is discarded by the cache's invalidation epoch); the plain count op and aggregate stay fresh; limit and latest may coexist only when limit >= latest), noteChars?: number (integer >= 1; opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result), includeFields?: string[], fieldCheck?: boolean (default true: every includeFields NAME and every filter condition FIELD NAME is checked pre-request against the live field set (the vendored spec when that read faults — the resource's plan-pinned live-only fields, metadata.liveOnlyFields, are exempt from the vendored refusal: the live entity carries them and the vendor model omits them (e.g. time_entries postedDate/postedOnTime) — a truly unknown name is still refused); a refusal costs zero QUERY wire — the query POST and the count probe that anchors latest are never issued, a COLD fieldCache performs one authority metadata GET first (zero on a warm one); the one udf:true condition per query is exempt (a tenant UDF name is absent from the vendored spec by definition); false disables both name checks, never the shape/grammar checks; the count verb's bag is name-checked the same way and carries the same fieldCheck opt-out; a direct queryBounded/queryAll call is not checked (no bag contract there)), names?: boolean (absent = the client's labels option — OFF by default (the label pass costs a field-catalog read + a capped number of cold name reads per call (several ids of one table share one batched read); the MCP server (iit-mcp-autotask) enables the client labels option when it re-pins to this version (downstream)); true adds the row label siblings: picklist <field>Label (statusLabel), <fk>Name for companyID/contractID/ticketID/roleID/billingCodeID/productID/vendorID (a company)/configurationItemCategoryID/*ResourceID (contractIDName, productIDName, assignedResourceIDName) — null, never missing, when the field is keyed with a null value, a 0 id (except companyID/vendorID 0, which name the tenant owner's own company) or an unresolved value (a picklist 0 is labelled when the picklist defines it); a names summary appears only when something was left unlabelled (the uncached name-read cap, an id a batched name read did not return, or an unresolved picklist value); false = raw ids, ~30% smaller on a full tickets row), via?: \"post\" | \"get\" (vendor GET has a 2048-char cap), acknowledgeUnscoped?: boolean (query verb only; a walk expected to read over 500 rows with no id scope in the filter is guarded — one pre-flight <resource>.count, and a count over 500 refuses with the typed SCOPE_REQUIRED before the walk; true walks the unscoped set anyway; a count that fails or is blind lets the walk run and the result's scopeNote says so), walk?: object (walk.maxRows: positive integer — (D6): the walk's TOTAL row cap — serves at most maxRows rows in total; the page size stays min(500, limit), so one vendor page may fetch more rows than maxRows and the surplus is sliced off (fetched, not served); the result's truncated flag — false only when the cursor is exhausted, true iff more rows exist past the cap (so an exact-multiple count with a live next page reports true); not combinable with latest) }. Filter grammar: 13 operators (eq, noteq, gt, gte, lt, lte, beginsWith, endsWith, contains, exist, notExist, in, notIn; in/notIn: array or \"1,2,3\") + and/or grouping (no not-group); field names in vendor API casing (via operations.fieldCatalog); caps: 500 OR-conditions / 1 UDF / 8000 chars.",
|
|
23320
|
+
"properties": [
|
|
23321
|
+
{
|
|
23322
|
+
"name": "filter",
|
|
23323
|
+
"type": "FilterCondition[]",
|
|
23324
|
+
"optional": true
|
|
23325
|
+
},
|
|
23326
|
+
{
|
|
23327
|
+
"name": "limit",
|
|
23328
|
+
"type": "number",
|
|
23329
|
+
"optional": true,
|
|
23330
|
+
"default": 500
|
|
23331
|
+
},
|
|
23332
|
+
{
|
|
23333
|
+
"name": "latest",
|
|
23334
|
+
"type": "number",
|
|
23335
|
+
"optional": true
|
|
23336
|
+
},
|
|
23337
|
+
{
|
|
23338
|
+
"name": "noteChars",
|
|
23339
|
+
"type": "number",
|
|
23340
|
+
"optional": true
|
|
23341
|
+
},
|
|
23342
|
+
{
|
|
23343
|
+
"name": "includeFields",
|
|
23344
|
+
"type": "string[]",
|
|
23345
|
+
"optional": true
|
|
23346
|
+
},
|
|
23347
|
+
{
|
|
23348
|
+
"name": "fieldCheck",
|
|
23349
|
+
"type": "boolean",
|
|
23350
|
+
"optional": true,
|
|
23351
|
+
"default": true
|
|
23352
|
+
},
|
|
23353
|
+
{
|
|
23354
|
+
"name": "names",
|
|
23355
|
+
"type": "boolean",
|
|
23356
|
+
"optional": true
|
|
23357
|
+
},
|
|
23358
|
+
{
|
|
23359
|
+
"name": "via",
|
|
23360
|
+
"type": "\"post\" | \"get\"",
|
|
23361
|
+
"optional": true
|
|
23362
|
+
},
|
|
23363
|
+
{
|
|
23364
|
+
"name": "acknowledgeUnscoped",
|
|
23365
|
+
"type": "boolean",
|
|
23366
|
+
"optional": true
|
|
23367
|
+
},
|
|
23368
|
+
{
|
|
23369
|
+
"name": "walk",
|
|
23370
|
+
"type": "object",
|
|
23371
|
+
"optional": true
|
|
23372
|
+
}
|
|
23373
|
+
]
|
|
23374
|
+
}
|
|
23375
|
+
},
|
|
23376
|
+
"inputSchemaStrict": true,
|
|
23377
|
+
"outputSchema": {
|
|
23378
|
+
"type": "QueryActionResult[<Model>,<Entity>]",
|
|
23379
|
+
"drops": []
|
|
23380
|
+
},
|
|
23381
|
+
"examples": [
|
|
23382
|
+
"await client.productVendors.query({ filter: [{ field: 'name', op: 'eq', value: 'example' }], limit: 500 })"
|
|
23383
|
+
],
|
|
23384
|
+
"permissions": "unknown",
|
|
23385
|
+
"pagination": {
|
|
23386
|
+
"mode": "cursor",
|
|
23387
|
+
"vendorDefault": 10,
|
|
23388
|
+
"vendorMax": 500,
|
|
23389
|
+
"pageGuard": 1000,
|
|
23390
|
+
"queryBounded": {
|
|
23391
|
+
"default": 500,
|
|
23392
|
+
"max": 2500
|
|
23393
|
+
}
|
|
23394
|
+
},
|
|
23395
|
+
"resolution": null,
|
|
23396
|
+
"retry": {
|
|
23397
|
+
"preset": "retry-ffb3a9cb"
|
|
23398
|
+
},
|
|
23399
|
+
"errors": {
|
|
23400
|
+
"set": 4
|
|
23401
|
+
},
|
|
23402
|
+
"metadata": {
|
|
23403
|
+
"purpose": "Query ProductVendors records with a JSON filter.",
|
|
23404
|
+
"usage": "Server-side pagination: one call walks the vendor cursor internally and preserves the initial HTTP method until the limit is met or the cursor is null. By default, each POST carries the same QueryModel body (IncludeFields, MaxRecords and the original filter). The vendor honours IncludeFields on POST continuations and uses its own continuation page size. With `via: 'get'`, the SDK follows the GET cursor with the original search parameters. Cursors must stay on the configured origin; 1000-page guard (hasMore stays true at the guard). queryAll is the unbounded raw walk — only when you need the ENTIRE set and accept a large payload; default to the bounded query op. noteChars: N (integer >= 1) is an opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose — the same set the server wraps): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result (zero wire — response-side only). latest: N returns the N highest-id rows (id-descending): the vendor has no sort parameter — this is the only ordering channel, and a date window in `filter` narrows the cost; count-anchored — C ≤ 2500 → one count + a ≤6-page walk of the matching set, C > 2500 → count probes + an id-threshold window (≤64 probes; LATEST_THRESHOLD_UNRESOLVED on budget exhaustion), a blind count → a bounded walk with the blind-surface stamp (LATEST_WINDOW_INCOMPLETE on a truncated walk). Parent-scoped entity: the query stays global (filter with productID 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.",
|
|
23405
|
+
"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).",
|
|
23406
|
+
"related": [
|
|
23407
|
+
"product_vendors.resolve"
|
|
23408
|
+
],
|
|
23409
|
+
"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."
|
|
23410
|
+
},
|
|
23411
|
+
"compact": null,
|
|
23412
|
+
"status": "tested"
|
|
23413
|
+
},
|
|
23414
|
+
{
|
|
23415
|
+
"id": "product_vendors.resolve",
|
|
23416
|
+
"resource": "product_vendors",
|
|
23417
|
+
"udfCapable": false,
|
|
23418
|
+
"operation": "resolve",
|
|
23419
|
+
"kind": "helper",
|
|
23420
|
+
"endpoint": null,
|
|
23421
|
+
"effect": "read",
|
|
23422
|
+
"flags": [],
|
|
23423
|
+
"dryRun": false,
|
|
23424
|
+
"envelope": null,
|
|
23425
|
+
"inputSchema": {
|
|
23426
|
+
"identifier": {
|
|
23427
|
+
"type": "string | number",
|
|
23428
|
+
"required": true,
|
|
23429
|
+
"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)."
|
|
23430
|
+
},
|
|
23431
|
+
"opts": {
|
|
23432
|
+
"type": "object",
|
|
23433
|
+
"required": false,
|
|
23434
|
+
"description": "ResolutionOpts — { expand?: boolean } (return the full record; a no-op where the Summary is a structural alias).",
|
|
23435
|
+
"properties": [
|
|
23436
|
+
{
|
|
23437
|
+
"name": "expand",
|
|
23438
|
+
"type": "boolean",
|
|
23439
|
+
"optional": true
|
|
23440
|
+
}
|
|
23441
|
+
]
|
|
23442
|
+
}
|
|
23443
|
+
},
|
|
23444
|
+
"inputSchemaStrict": true,
|
|
23445
|
+
"outputSchema": {
|
|
23446
|
+
"type": "ProductVendorsSummary",
|
|
23447
|
+
"drops": []
|
|
23448
|
+
},
|
|
23449
|
+
"examples": [
|
|
23450
|
+
"await client.productVendors.resolve('example-value')"
|
|
23451
|
+
],
|
|
23452
|
+
"permissions": "unknown",
|
|
23453
|
+
"pagination": {
|
|
23454
|
+
"mode": "none"
|
|
23455
|
+
},
|
|
23456
|
+
"resolution": {
|
|
23457
|
+
"basis": "server-filter",
|
|
23458
|
+
"maxScanRecords": 500,
|
|
23459
|
+
"maxScanPages": 4
|
|
23460
|
+
},
|
|
23461
|
+
"retry": {
|
|
23462
|
+
"preset": "retry-ffb3a9cb"
|
|
23463
|
+
},
|
|
23464
|
+
"errors": {
|
|
23465
|
+
"set": 5
|
|
23466
|
+
},
|
|
23467
|
+
"metadata": {
|
|
23468
|
+
"purpose": "Resolve a product vendor from a numeric id (the direct fetch) only — this resource has no searchable text field, so a non-numeric identifier throws a config error.",
|
|
23469
|
+
"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.",
|
|
23470
|
+
"preferredWhen": null,
|
|
23471
|
+
"related": [
|
|
23472
|
+
"product_vendors.get"
|
|
23473
|
+
]
|
|
23474
|
+
},
|
|
23475
|
+
"compact": "ProductVendorsSummary",
|
|
23476
|
+
"status": "tested"
|
|
23477
|
+
},
|
|
23478
|
+
{
|
|
23479
|
+
"id": "product_vendors.update",
|
|
23480
|
+
"resource": "product_vendors",
|
|
23481
|
+
"udfCapable": false,
|
|
23482
|
+
"operation": "update",
|
|
23483
|
+
"kind": "primitive",
|
|
23484
|
+
"endpoint": "PUT|PATCH /V1.0/Products/{parentId}/Vendors",
|
|
23485
|
+
"effect": "write",
|
|
23486
|
+
"flags": [
|
|
23487
|
+
"idempotent"
|
|
23488
|
+
],
|
|
23489
|
+
"dryRun": true,
|
|
23490
|
+
"envelope": "OperationResultModel",
|
|
23491
|
+
"inputSchema": {
|
|
23492
|
+
"parentId": {
|
|
23493
|
+
"type": "string | number",
|
|
23494
|
+
"required": true,
|
|
23495
|
+
"description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
|
|
23496
|
+
},
|
|
23497
|
+
"id": {
|
|
23498
|
+
"type": "string | number",
|
|
23499
|
+
"required": true,
|
|
23500
|
+
"description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
|
|
23501
|
+
},
|
|
23502
|
+
"data": {
|
|
23503
|
+
"type": "object",
|
|
23504
|
+
"required": true,
|
|
23505
|
+
"description": "The record payload (vendor model fields)."
|
|
23506
|
+
}
|
|
23507
|
+
},
|
|
23508
|
+
"inputSchemaStrict": true,
|
|
23509
|
+
"outputSchema": {
|
|
23510
|
+
"type": "OperationResultModel",
|
|
23511
|
+
"drops": []
|
|
23512
|
+
},
|
|
23513
|
+
"examples": [
|
|
23514
|
+
"await client.productVendors.update('example-value', 'example-value', { name: 'example' }, { dryRun: true })"
|
|
23515
|
+
],
|
|
23516
|
+
"permissions": "unknown",
|
|
23517
|
+
"pagination": {
|
|
23518
|
+
"mode": "none"
|
|
23519
|
+
},
|
|
23520
|
+
"resolution": null,
|
|
23521
|
+
"retry": {
|
|
23522
|
+
"preset": "retry-85897a3a"
|
|
23523
|
+
},
|
|
23524
|
+
"errors": {
|
|
23525
|
+
"set": 1
|
|
23526
|
+
},
|
|
23527
|
+
"metadata": {
|
|
23528
|
+
"purpose": "Update a product vendor.",
|
|
23529
|
+
"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.",
|
|
23530
|
+
"preferredWhen": "Preferred over create or delete when the record exists and only some fields change.",
|
|
23531
|
+
"related": [
|
|
23532
|
+
"product_vendors.get"
|
|
23533
|
+
],
|
|
23534
|
+
"accountWide": true
|
|
23535
|
+
},
|
|
23536
|
+
"compact": null,
|
|
23537
|
+
"status": "tested"
|
|
23538
|
+
},
|
|
23539
|
+
{
|
|
23540
|
+
"id": "products.count",
|
|
23541
|
+
"resource": "products",
|
|
23542
|
+
"udfCapable": true,
|
|
23543
|
+
"operation": "count",
|
|
23544
|
+
"kind": "primitive",
|
|
23545
|
+
"endpoint": "GET|POST /V1.0/Products/query/count",
|
|
23150
23546
|
"effect": "read",
|
|
23151
23547
|
"flags": [],
|
|
23152
23548
|
"dryRun": false,
|
|
@@ -26721,7 +27117,483 @@ const CAPABILITY_DATA = {
|
|
|
26721
27117
|
"drops": []
|
|
26722
27118
|
},
|
|
26723
27119
|
"examples": [
|
|
26724
|
-
"await invoke(client, 'resource_attachments.count', [{ filter: [{ field: 'resourceID', op: 'eq', value: 7 }] }])"
|
|
27120
|
+
"await invoke(client, 'resource_attachments.count', [{ filter: [{ field: 'resourceID', op: 'eq', value: 7 }] }])"
|
|
27121
|
+
],
|
|
27122
|
+
"permissions": "unknown",
|
|
27123
|
+
"pagination": {
|
|
27124
|
+
"mode": "none"
|
|
27125
|
+
},
|
|
27126
|
+
"resolution": null,
|
|
27127
|
+
"retry": {
|
|
27128
|
+
"preset": "retry-ffb3a9cb"
|
|
27129
|
+
},
|
|
27130
|
+
"errors": {
|
|
27131
|
+
"set": 0
|
|
27132
|
+
},
|
|
27133
|
+
"metadata": {
|
|
27134
|
+
"purpose": "Count resource attachment records matching a JSON filter. Use resourceID for parent scope.",
|
|
27135
|
+
"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.",
|
|
27136
|
+
"preferredWhen": null,
|
|
27137
|
+
"related": [
|
|
27138
|
+
"resource_attachments.query"
|
|
27139
|
+
],
|
|
27140
|
+
"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.",
|
|
27141
|
+
"untrustedFields": [
|
|
27142
|
+
"title"
|
|
27143
|
+
]
|
|
27144
|
+
},
|
|
27145
|
+
"compact": null,
|
|
27146
|
+
"status": "tested"
|
|
27147
|
+
},
|
|
27148
|
+
{
|
|
27149
|
+
"id": "resource_attachments.create",
|
|
27150
|
+
"resource": "resource_attachments",
|
|
27151
|
+
"udfCapable": false,
|
|
27152
|
+
"operation": "create",
|
|
27153
|
+
"kind": "primitive",
|
|
27154
|
+
"endpoint": "POST /V1.0/Resources/{parentId}/Attachments",
|
|
27155
|
+
"effect": "write",
|
|
27156
|
+
"flags": [],
|
|
27157
|
+
"dryRun": true,
|
|
27158
|
+
"envelope": "OperationResultModel",
|
|
27159
|
+
"inputSchema": {
|
|
27160
|
+
"parentId": {
|
|
27161
|
+
"type": "string | number",
|
|
27162
|
+
"required": true,
|
|
27163
|
+
"description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
|
|
27164
|
+
},
|
|
27165
|
+
"data": {
|
|
27166
|
+
"type": "object",
|
|
27167
|
+
"required": true,
|
|
27168
|
+
"description": "The record payload (vendor model fields)."
|
|
27169
|
+
}
|
|
27170
|
+
},
|
|
27171
|
+
"inputSchemaStrict": true,
|
|
27172
|
+
"outputSchema": {
|
|
27173
|
+
"type": "OperationResultModel",
|
|
27174
|
+
"drops": []
|
|
27175
|
+
},
|
|
27176
|
+
"examples": [
|
|
27177
|
+
"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 });"
|
|
27178
|
+
],
|
|
27179
|
+
"permissions": "unknown",
|
|
27180
|
+
"pagination": {
|
|
27181
|
+
"mode": "none"
|
|
27182
|
+
},
|
|
27183
|
+
"resolution": null,
|
|
27184
|
+
"retry": {
|
|
27185
|
+
"preset": "retry-c5657094"
|
|
27186
|
+
},
|
|
27187
|
+
"errors": {
|
|
27188
|
+
"set": 1
|
|
27189
|
+
},
|
|
27190
|
+
"metadata": {
|
|
27191
|
+
"purpose": "Create a file attachment under a resource.",
|
|
27192
|
+
"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.",
|
|
27193
|
+
"preferredWhen": "Add a new attachment; existing attachments cannot be updated. Replace through separately governed delete and create actions.",
|
|
27194
|
+
"related": [
|
|
27195
|
+
"resource_attachments.get"
|
|
27196
|
+
],
|
|
27197
|
+
"argNotes": {
|
|
27198
|
+
"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."
|
|
27199
|
+
},
|
|
27200
|
+
"untrustedFields": [
|
|
27201
|
+
"title"
|
|
27202
|
+
],
|
|
27203
|
+
"createRequirements": {
|
|
27204
|
+
"requires": {
|
|
27205
|
+
"allOf": [
|
|
27206
|
+
"attachmentType",
|
|
27207
|
+
"fullPath",
|
|
27208
|
+
"title",
|
|
27209
|
+
"publish",
|
|
27210
|
+
"data"
|
|
27211
|
+
]
|
|
27212
|
+
},
|
|
27213
|
+
"requiresByValue": [
|
|
27214
|
+
{
|
|
27215
|
+
"field": "attachmentType",
|
|
27216
|
+
"value": "FILE_ATTACHMENT",
|
|
27217
|
+
"requires": {
|
|
27218
|
+
"allOf": [
|
|
27219
|
+
"data"
|
|
27220
|
+
]
|
|
27221
|
+
}
|
|
27222
|
+
}
|
|
27223
|
+
]
|
|
27224
|
+
}
|
|
27225
|
+
},
|
|
27226
|
+
"compact": null,
|
|
27227
|
+
"status": "tested"
|
|
27228
|
+
},
|
|
27229
|
+
{
|
|
27230
|
+
"id": "resource_attachments.delete",
|
|
27231
|
+
"resource": "resource_attachments",
|
|
27232
|
+
"udfCapable": false,
|
|
27233
|
+
"operation": "delete",
|
|
27234
|
+
"kind": "primitive",
|
|
27235
|
+
"endpoint": "DELETE /V1.0/Resources/{parentId}/Attachments/{id}",
|
|
27236
|
+
"effect": "destructive",
|
|
27237
|
+
"flags": [
|
|
27238
|
+
"idempotent",
|
|
27239
|
+
"requiresApproval"
|
|
27240
|
+
],
|
|
27241
|
+
"dryRun": true,
|
|
27242
|
+
"envelope": "OperationResultModel (attachment entities: the deleted attachment model is returned, not OperationResultModel)",
|
|
27243
|
+
"inputSchema": {
|
|
27244
|
+
"parentId": {
|
|
27245
|
+
"type": "string | number",
|
|
27246
|
+
"required": true,
|
|
27247
|
+
"description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
|
|
27248
|
+
},
|
|
27249
|
+
"id": {
|
|
27250
|
+
"type": "string | number",
|
|
27251
|
+
"required": true,
|
|
27252
|
+
"description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
|
|
27253
|
+
}
|
|
27254
|
+
},
|
|
27255
|
+
"inputSchemaStrict": true,
|
|
27256
|
+
"outputSchema": {
|
|
27257
|
+
"type": "OperationResultModel (attachment entities: the deleted attachment model is returned, not OperationResultModel)",
|
|
27258
|
+
"drops": []
|
|
27259
|
+
},
|
|
27260
|
+
"examples": [
|
|
27261
|
+
"await invoke(client, 'resource_attachments.delete', [7, 3], { confirm: 'resource_attachments.delete' })"
|
|
27262
|
+
],
|
|
27263
|
+
"permissions": "unknown",
|
|
27264
|
+
"pagination": {
|
|
27265
|
+
"mode": "none"
|
|
27266
|
+
},
|
|
27267
|
+
"resolution": null,
|
|
27268
|
+
"retry": {
|
|
27269
|
+
"preset": "retry-1849870d"
|
|
27270
|
+
},
|
|
27271
|
+
"errors": {
|
|
27272
|
+
"set": 2
|
|
27273
|
+
},
|
|
27274
|
+
"metadata": {
|
|
27275
|
+
"purpose": "Delete an attachment under a resource.",
|
|
27276
|
+
"usage": "Irreversible; dry-run validates the target id first. Parent-scoped: parentId + id.",
|
|
27277
|
+
"preferredWhen": null,
|
|
27278
|
+
"related": [
|
|
27279
|
+
"resource_attachments.get"
|
|
27280
|
+
],
|
|
27281
|
+
"untrustedFields": [
|
|
27282
|
+
"title"
|
|
27283
|
+
]
|
|
27284
|
+
},
|
|
27285
|
+
"compact": null,
|
|
27286
|
+
"status": "tested"
|
|
27287
|
+
},
|
|
27288
|
+
{
|
|
27289
|
+
"id": "resource_attachments.get",
|
|
27290
|
+
"resource": "resource_attachments",
|
|
27291
|
+
"udfCapable": false,
|
|
27292
|
+
"operation": "get",
|
|
27293
|
+
"kind": "primitive",
|
|
27294
|
+
"endpoint": "GET /V1.0/Resources/{parentId}/Attachments/{id}",
|
|
27295
|
+
"effect": "read",
|
|
27296
|
+
"flags": [],
|
|
27297
|
+
"dryRun": false,
|
|
27298
|
+
"envelope": "ResourceAttachmentModel",
|
|
27299
|
+
"inputSchema": {
|
|
27300
|
+
"parentId": {
|
|
27301
|
+
"type": "string | number",
|
|
27302
|
+
"required": true,
|
|
27303
|
+
"description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
|
|
27304
|
+
},
|
|
27305
|
+
"id": {
|
|
27306
|
+
"type": "string | number",
|
|
27307
|
+
"required": true,
|
|
27308
|
+
"description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
|
|
27309
|
+
},
|
|
27310
|
+
"opts": {
|
|
27311
|
+
"type": "object",
|
|
27312
|
+
"required": false,
|
|
27313
|
+
"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.",
|
|
27314
|
+
"properties": [
|
|
27315
|
+
{
|
|
27316
|
+
"name": "fresh",
|
|
27317
|
+
"type": "boolean",
|
|
27318
|
+
"optional": true
|
|
27319
|
+
}
|
|
27320
|
+
]
|
|
27321
|
+
}
|
|
27322
|
+
},
|
|
27323
|
+
"inputSchemaStrict": true,
|
|
27324
|
+
"outputSchema": {
|
|
27325
|
+
"type": "ResourceAttachmentModel",
|
|
27326
|
+
"drops": []
|
|
27327
|
+
},
|
|
27328
|
+
"examples": [
|
|
27329
|
+
"await client.resourceAttachments.get(7, 3)"
|
|
27330
|
+
],
|
|
27331
|
+
"permissions": "unknown",
|
|
27332
|
+
"pagination": {
|
|
27333
|
+
"mode": "none"
|
|
27334
|
+
},
|
|
27335
|
+
"resolution": null,
|
|
27336
|
+
"retry": {
|
|
27337
|
+
"preset": "retry-ffb3a9cb"
|
|
27338
|
+
},
|
|
27339
|
+
"errors": {
|
|
27340
|
+
"set": 3
|
|
27341
|
+
},
|
|
27342
|
+
"metadata": {
|
|
27343
|
+
"purpose": "Get one ResourceAttachment by id.",
|
|
27344
|
+
"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.",
|
|
27345
|
+
"preferredWhen": "Use a known attachment id; query the scoped collection to discover ids.",
|
|
27346
|
+
"related": [
|
|
27347
|
+
"resource_attachments.query"
|
|
27348
|
+
],
|
|
27349
|
+
"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.",
|
|
27350
|
+
"untrustedFields": [
|
|
27351
|
+
"title"
|
|
27352
|
+
]
|
|
27353
|
+
},
|
|
27354
|
+
"compact": null,
|
|
27355
|
+
"status": "tested"
|
|
27356
|
+
},
|
|
27357
|
+
{
|
|
27358
|
+
"id": "resource_attachments.getEntityInfo",
|
|
27359
|
+
"resource": "resource_attachments",
|
|
27360
|
+
"udfCapable": false,
|
|
27361
|
+
"operation": "getEntityInfo",
|
|
27362
|
+
"kind": "primitive",
|
|
27363
|
+
"endpoint": "GET /V1.0/ResourceAttachments/entityInformation",
|
|
27364
|
+
"effect": "read",
|
|
27365
|
+
"flags": [],
|
|
27366
|
+
"dryRun": false,
|
|
27367
|
+
"envelope": "EntityInformationResultModel",
|
|
27368
|
+
"inputSchema": {},
|
|
27369
|
+
"inputSchemaStrict": true,
|
|
27370
|
+
"outputSchema": {
|
|
27371
|
+
"type": "EntityInformationResultModel",
|
|
27372
|
+
"drops": []
|
|
27373
|
+
},
|
|
27374
|
+
"examples": [
|
|
27375
|
+
"await client.resourceAttachments.getEntityInfo()"
|
|
27376
|
+
],
|
|
27377
|
+
"permissions": "unknown",
|
|
27378
|
+
"pagination": {
|
|
27379
|
+
"mode": "none"
|
|
27380
|
+
},
|
|
27381
|
+
"resolution": null,
|
|
27382
|
+
"retry": {
|
|
27383
|
+
"preset": "retry-ffb3a9cb"
|
|
27384
|
+
},
|
|
27385
|
+
"errors": {
|
|
27386
|
+
"set": 0
|
|
27387
|
+
},
|
|
27388
|
+
"metadata": {
|
|
27389
|
+
"purpose": "Get the ResourceAttachment capability metadata (canCreate/canUpdate/hasUserDefinedFields/...).",
|
|
27390
|
+
"usage": "Unwraps info{}; drives client-side capability checks.",
|
|
27391
|
+
"preferredWhen": null,
|
|
27392
|
+
"related": [
|
|
27393
|
+
"resource_attachments.getFieldInfo"
|
|
27394
|
+
],
|
|
27395
|
+
"untrustedFields": [
|
|
27396
|
+
"title"
|
|
27397
|
+
]
|
|
27398
|
+
},
|
|
27399
|
+
"compact": null,
|
|
27400
|
+
"status": "tested"
|
|
27401
|
+
},
|
|
27402
|
+
{
|
|
27403
|
+
"id": "resource_attachments.getFieldInfo",
|
|
27404
|
+
"resource": "resource_attachments",
|
|
27405
|
+
"udfCapable": false,
|
|
27406
|
+
"operation": "getFieldInfo",
|
|
27407
|
+
"kind": "primitive",
|
|
27408
|
+
"endpoint": "GET /V1.0/ResourceAttachments/entityInformation/fields",
|
|
27409
|
+
"effect": "read",
|
|
27410
|
+
"flags": [],
|
|
27411
|
+
"dryRun": false,
|
|
27412
|
+
"envelope": "FieldInformationResultModel",
|
|
27413
|
+
"inputSchema": {},
|
|
27414
|
+
"inputSchemaStrict": true,
|
|
27415
|
+
"outputSchema": {
|
|
27416
|
+
"type": "FieldInformationResultModel",
|
|
27417
|
+
"drops": []
|
|
27418
|
+
},
|
|
27419
|
+
"examples": [
|
|
27420
|
+
"await client.resourceAttachments.getFieldInfo()"
|
|
27421
|
+
],
|
|
27422
|
+
"permissions": "unknown",
|
|
27423
|
+
"pagination": {
|
|
27424
|
+
"mode": "none"
|
|
27425
|
+
},
|
|
27426
|
+
"resolution": null,
|
|
27427
|
+
"retry": {
|
|
27428
|
+
"preset": "retry-ffb3a9cb"
|
|
27429
|
+
},
|
|
27430
|
+
"errors": {
|
|
27431
|
+
"set": 0
|
|
27432
|
+
},
|
|
27433
|
+
"metadata": {
|
|
27434
|
+
"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).",
|
|
27435
|
+
"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.",
|
|
27436
|
+
"preferredWhen": null,
|
|
27437
|
+
"related": [
|
|
27438
|
+
"resource_attachments.getEntityInfo"
|
|
27439
|
+
],
|
|
27440
|
+
"untrustedFields": [
|
|
27441
|
+
"title"
|
|
27442
|
+
]
|
|
27443
|
+
},
|
|
27444
|
+
"compact": null,
|
|
27445
|
+
"status": "tested"
|
|
27446
|
+
},
|
|
27447
|
+
{
|
|
27448
|
+
"id": "resource_attachments.query",
|
|
27449
|
+
"resource": "resource_attachments",
|
|
27450
|
+
"udfCapable": false,
|
|
27451
|
+
"operation": "query",
|
|
27452
|
+
"kind": "primitive",
|
|
27453
|
+
"endpoint": "GET|POST /V1.0/ResourceAttachments/query",
|
|
27454
|
+
"effect": "read",
|
|
27455
|
+
"flags": [],
|
|
27456
|
+
"dryRun": false,
|
|
27457
|
+
"envelope": "QueryActionResult[<Model>,<Entity>]",
|
|
27458
|
+
"inputSchema": {
|
|
27459
|
+
"params": {
|
|
27460
|
+
"type": "object",
|
|
27461
|
+
"required": false,
|
|
27462
|
+
"description": "The query params object (CLOSED — unknown keys are refused pre-request with a typed error naming the key + the valid keys): { filter?: FilterCondition[], limit?: number (total cap, default 500, max 2500 — NOT a page size), latest?: number (1-2500; the N highest-id rows — the vendor has no sort; count-probe + id-threshold semantics, see docs/API.md §4; the same-process latest-walk count probes are briefly cached per client — a 30 s TTL, cleared on a write through this client (a probe in flight across the write is discarded by the cache's invalidation epoch); the plain count op and aggregate stay fresh; limit and latest may coexist only when limit >= latest), noteChars?: number (integer >= 1; opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result), includeFields?: string[], fieldCheck?: boolean (default true: every includeFields NAME and every filter condition FIELD NAME is checked pre-request against the live field set (the vendored spec when that read faults — the resource's plan-pinned live-only fields, metadata.liveOnlyFields, are exempt from the vendored refusal: the live entity carries them and the vendor model omits them (e.g. time_entries postedDate/postedOnTime) — a truly unknown name is still refused); a refusal costs zero QUERY wire — the query POST and the count probe that anchors latest are never issued, a COLD fieldCache performs one authority metadata GET first (zero on a warm one); the one udf:true condition per query is exempt (a tenant UDF name is absent from the vendored spec by definition); false disables both name checks, never the shape/grammar checks; the count verb's bag is name-checked the same way and carries the same fieldCheck opt-out; a direct queryBounded/queryAll call is not checked (no bag contract there)), names?: boolean (absent = the client's labels option — OFF by default (the label pass costs a field-catalog read + a capped number of cold name reads per call (several ids of one table share one batched read); the MCP server (iit-mcp-autotask) enables the client labels option when it re-pins to this version (downstream)); true adds the row label siblings: picklist <field>Label (statusLabel), <fk>Name for companyID/contractID/ticketID/roleID/billingCodeID/productID/vendorID (a company)/configurationItemCategoryID/*ResourceID (contractIDName, productIDName, assignedResourceIDName) — null, never missing, when the field is keyed with a null value, a 0 id (except companyID/vendorID 0, which name the tenant owner's own company) or an unresolved value (a picklist 0 is labelled when the picklist defines it); a names summary appears only when something was left unlabelled (the uncached name-read cap, an id a batched name read did not return, or an unresolved picklist value); false = raw ids, ~30% smaller on a full tickets row), via?: \"post\" | \"get\" (vendor GET has a 2048-char cap), acknowledgeUnscoped?: boolean (query verb only; a walk expected to read over 500 rows with no id scope in the filter is guarded — one pre-flight <resource>.count, and a count over 500 refuses with the typed SCOPE_REQUIRED before the walk; true walks the unscoped set anyway; a count that fails or is blind lets the walk run and the result's scopeNote says so), walk?: object (walk.maxRows: positive integer — (D6): the walk's TOTAL row cap — serves at most maxRows rows in total; the page size stays min(500, limit), so one vendor page may fetch more rows than maxRows and the surplus is sliced off (fetched, not served); the result's truncated flag — false only when the cursor is exhausted, true iff more rows exist past the cap (so an exact-multiple count with a live next page reports true); not combinable with latest) }. Filter grammar: 13 operators (eq, noteq, gt, gte, lt, lte, beginsWith, endsWith, contains, exist, notExist, in, notIn; in/notIn: array or \"1,2,3\") + and/or grouping (no not-group); field names in vendor API casing (via operations.fieldCatalog); caps: 500 OR-conditions / 1 UDF / 8000 chars.",
|
|
27463
|
+
"properties": [
|
|
27464
|
+
{
|
|
27465
|
+
"name": "filter",
|
|
27466
|
+
"type": "FilterCondition[]",
|
|
27467
|
+
"optional": true
|
|
27468
|
+
},
|
|
27469
|
+
{
|
|
27470
|
+
"name": "limit",
|
|
27471
|
+
"type": "number",
|
|
27472
|
+
"optional": true,
|
|
27473
|
+
"default": 500
|
|
27474
|
+
},
|
|
27475
|
+
{
|
|
27476
|
+
"name": "latest",
|
|
27477
|
+
"type": "number",
|
|
27478
|
+
"optional": true
|
|
27479
|
+
},
|
|
27480
|
+
{
|
|
27481
|
+
"name": "noteChars",
|
|
27482
|
+
"type": "number",
|
|
27483
|
+
"optional": true
|
|
27484
|
+
},
|
|
27485
|
+
{
|
|
27486
|
+
"name": "includeFields",
|
|
27487
|
+
"type": "string[]",
|
|
27488
|
+
"optional": true
|
|
27489
|
+
},
|
|
27490
|
+
{
|
|
27491
|
+
"name": "fieldCheck",
|
|
27492
|
+
"type": "boolean",
|
|
27493
|
+
"optional": true,
|
|
27494
|
+
"default": true
|
|
27495
|
+
},
|
|
27496
|
+
{
|
|
27497
|
+
"name": "names",
|
|
27498
|
+
"type": "boolean",
|
|
27499
|
+
"optional": true
|
|
27500
|
+
},
|
|
27501
|
+
{
|
|
27502
|
+
"name": "via",
|
|
27503
|
+
"type": "\"post\" | \"get\"",
|
|
27504
|
+
"optional": true
|
|
27505
|
+
},
|
|
27506
|
+
{
|
|
27507
|
+
"name": "acknowledgeUnscoped",
|
|
27508
|
+
"type": "boolean",
|
|
27509
|
+
"optional": true
|
|
27510
|
+
},
|
|
27511
|
+
{
|
|
27512
|
+
"name": "walk",
|
|
27513
|
+
"type": "object",
|
|
27514
|
+
"optional": true
|
|
27515
|
+
}
|
|
27516
|
+
]
|
|
27517
|
+
}
|
|
27518
|
+
},
|
|
27519
|
+
"inputSchemaStrict": true,
|
|
27520
|
+
"outputSchema": {
|
|
27521
|
+
"type": "QueryActionResult[<Model>,<Entity>]",
|
|
27522
|
+
"drops": []
|
|
27523
|
+
},
|
|
27524
|
+
"examples": [
|
|
27525
|
+
"await invoke(client, 'resource_attachments.query', [{ filter: [{ field: 'resourceID', op: 'eq', value: 7 }], limit: 25 }])"
|
|
27526
|
+
],
|
|
27527
|
+
"permissions": "unknown",
|
|
27528
|
+
"pagination": {
|
|
27529
|
+
"mode": "cursor",
|
|
27530
|
+
"vendorDefault": 10,
|
|
27531
|
+
"vendorMax": 500,
|
|
27532
|
+
"pageGuard": 1000,
|
|
27533
|
+
"queryBounded": {
|
|
27534
|
+
"default": 500,
|
|
27535
|
+
"max": 2500
|
|
27536
|
+
}
|
|
27537
|
+
},
|
|
27538
|
+
"resolution": null,
|
|
27539
|
+
"retry": {
|
|
27540
|
+
"preset": "retry-ffb3a9cb"
|
|
27541
|
+
},
|
|
27542
|
+
"errors": {
|
|
27543
|
+
"set": 4
|
|
27544
|
+
},
|
|
27545
|
+
"metadata": {
|
|
27546
|
+
"purpose": "Query ResourceAttachment records with a JSON filter.",
|
|
27547
|
+
"usage": "Server-side pagination: one call walks the vendor cursor internally and preserves the initial HTTP method until the limit is met or the cursor is null. By default, each POST carries the same QueryModel body (IncludeFields, MaxRecords and the original filter). The vendor honours IncludeFields on POST continuations and uses its own continuation page size. With `via: 'get'`, the SDK follows the GET cursor with the original search parameters. Cursors must stay on the configured origin; 1000-page guard (hasMore stays true at the guard). queryAll is the unbounded raw walk — only when you need the ENTIRE set and accept a large payload; default to the bounded query op. noteChars: N (integer >= 1) is an opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose — the same set the server wraps): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result (zero wire — response-side only). latest: N returns the N highest-id rows (id-descending): the vendor has no sort parameter — this is the only ordering channel, and a date window in `filter` narrows the cost; count-anchored — C ≤ 2500 → one count + a ≤6-page walk of the matching set, C > 2500 → count probes + an id-threshold window (≤64 probes; LATEST_THRESHOLD_UNRESOLVED on budget exhaustion), a blind count → a bounded walk with the blind-surface stamp (LATEST_WINDOW_INCOMPLETE on a truncated walk). 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.",
|
|
27548
|
+
"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).",
|
|
27549
|
+
"related": [
|
|
27550
|
+
"resource_attachments.get"
|
|
27551
|
+
],
|
|
27552
|
+
"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.",
|
|
27553
|
+
"untrustedFields": [
|
|
27554
|
+
"title"
|
|
27555
|
+
]
|
|
27556
|
+
},
|
|
27557
|
+
"compact": null,
|
|
27558
|
+
"status": "tested"
|
|
27559
|
+
},
|
|
27560
|
+
{
|
|
27561
|
+
"id": "resource_daily_availabilities.count",
|
|
27562
|
+
"resource": "resource_daily_availabilities",
|
|
27563
|
+
"udfCapable": false,
|
|
27564
|
+
"operation": "count",
|
|
27565
|
+
"kind": "primitive",
|
|
27566
|
+
"endpoint": "POST /V1.0/ResourceDailyAvailabilities/query/count",
|
|
27567
|
+
"effect": "read",
|
|
27568
|
+
"flags": [],
|
|
27569
|
+
"dryRun": false,
|
|
27570
|
+
"envelope": "QueryCountResultModel",
|
|
27571
|
+
"inputSchema": {
|
|
27572
|
+
"params": {
|
|
27573
|
+
"type": "object",
|
|
27574
|
+
"required": false,
|
|
27575
|
+
"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.",
|
|
27576
|
+
"properties": [
|
|
27577
|
+
{
|
|
27578
|
+
"name": "filter",
|
|
27579
|
+
"type": "FilterCondition[]",
|
|
27580
|
+
"optional": true
|
|
27581
|
+
},
|
|
27582
|
+
{
|
|
27583
|
+
"name": "fieldCheck",
|
|
27584
|
+
"type": "boolean",
|
|
27585
|
+
"optional": true
|
|
27586
|
+
}
|
|
27587
|
+
]
|
|
27588
|
+
}
|
|
27589
|
+
},
|
|
27590
|
+
"inputSchemaStrict": true,
|
|
27591
|
+
"outputSchema": {
|
|
27592
|
+
"type": "QueryCountResultModel",
|
|
27593
|
+
"drops": []
|
|
27594
|
+
},
|
|
27595
|
+
"examples": [
|
|
27596
|
+
"await invoke(client, 'resource_daily_availabilities.count', [{ filter: [{ field: 'resourceID', op: 'eq', value: 7 }] }])"
|
|
26725
27597
|
],
|
|
26726
27598
|
"permissions": "unknown",
|
|
26727
27599
|
"pagination": {
|
|
@@ -26732,53 +27604,58 @@ const CAPABILITY_DATA = {
|
|
|
26732
27604
|
"preset": "retry-ffb3a9cb"
|
|
26733
27605
|
},
|
|
26734
27606
|
"errors": {
|
|
26735
|
-
"set":
|
|
27607
|
+
"set": 6
|
|
26736
27608
|
},
|
|
26737
27609
|
"metadata": {
|
|
26738
|
-
"purpose": "Count resource
|
|
26739
|
-
"usage": "Unwraps queryCount; returns a plain number.
|
|
27610
|
+
"purpose": "Count resource daily availability records matching a JSON filter.",
|
|
27611
|
+
"usage": "Unwraps queryCount; returns a plain number. Availability depends on API-user permissions and feature activation; an empty query is inconclusive about inventory. Weekly Billable Hours Goal activation controls weeklyBillableHoursGoal query/filter/update support; inactive features can return null and forbid filtering or updates. Use weeklyBillableHoursGoal and travelAvailability from exposed field metadata, not the misspellings weeklyBillableGoalHours/travelAvailablity in official prose. Resource administration is account-wide; resourceID is a staff parent, not company ownership. This SDK slice exposes reads only; availability updates remain tracked separately.",
|
|
26740
27612
|
"preferredWhen": null,
|
|
26741
|
-
"related": [
|
|
26742
|
-
"resource_attachments.query"
|
|
26743
|
-
],
|
|
27613
|
+
"related": [],
|
|
26744
27614
|
"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.",
|
|
26745
27615
|
"untrustedFields": [
|
|
26746
|
-
"
|
|
27616
|
+
"travelAvailability"
|
|
26747
27617
|
]
|
|
26748
27618
|
},
|
|
26749
27619
|
"compact": null,
|
|
26750
27620
|
"status": "tested"
|
|
26751
27621
|
},
|
|
26752
27622
|
{
|
|
26753
|
-
"id": "
|
|
26754
|
-
"resource": "
|
|
27623
|
+
"id": "resource_daily_availabilities.get",
|
|
27624
|
+
"resource": "resource_daily_availabilities",
|
|
26755
27625
|
"udfCapable": false,
|
|
26756
|
-
"operation": "
|
|
27626
|
+
"operation": "get",
|
|
26757
27627
|
"kind": "primitive",
|
|
26758
|
-
"endpoint": "
|
|
26759
|
-
"effect": "
|
|
27628
|
+
"endpoint": "GET /V1.0/ResourceDailyAvailabilities/{id}",
|
|
27629
|
+
"effect": "read",
|
|
26760
27630
|
"flags": [],
|
|
26761
|
-
"dryRun":
|
|
26762
|
-
"envelope": "
|
|
27631
|
+
"dryRun": false,
|
|
27632
|
+
"envelope": "ItemQueryResultModel[ResourceDailyAvailabilityModel,ResourceDailyAvailability]",
|
|
26763
27633
|
"inputSchema": {
|
|
26764
|
-
"
|
|
27634
|
+
"id": {
|
|
26765
27635
|
"type": "string | number",
|
|
26766
27636
|
"required": true,
|
|
26767
|
-
"description": "The
|
|
27637
|
+
"description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
|
|
26768
27638
|
},
|
|
26769
|
-
"
|
|
27639
|
+
"opts": {
|
|
26770
27640
|
"type": "object",
|
|
26771
|
-
"required":
|
|
26772
|
-
"description": "The
|
|
27641
|
+
"required": false,
|
|
27642
|
+
"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.",
|
|
27643
|
+
"properties": [
|
|
27644
|
+
{
|
|
27645
|
+
"name": "fresh",
|
|
27646
|
+
"type": "boolean",
|
|
27647
|
+
"optional": true
|
|
27648
|
+
}
|
|
27649
|
+
]
|
|
26773
27650
|
}
|
|
26774
27651
|
},
|
|
26775
27652
|
"inputSchemaStrict": true,
|
|
26776
27653
|
"outputSchema": {
|
|
26777
|
-
"type": "
|
|
27654
|
+
"type": "ItemQueryResultModel[ResourceDailyAvailabilityModel,ResourceDailyAvailability]",
|
|
26778
27655
|
"drops": []
|
|
26779
27656
|
},
|
|
26780
27657
|
"examples": [
|
|
26781
|
-
"
|
|
27658
|
+
"await client.resourceDailyAvailabilities.get('example-value')"
|
|
26782
27659
|
],
|
|
26783
27660
|
"permissions": "unknown",
|
|
26784
27661
|
"pagination": {
|
|
@@ -26786,83 +27663,46 @@ const CAPABILITY_DATA = {
|
|
|
26786
27663
|
},
|
|
26787
27664
|
"resolution": null,
|
|
26788
27665
|
"retry": {
|
|
26789
|
-
"preset": "retry-
|
|
27666
|
+
"preset": "retry-ffb3a9cb"
|
|
26790
27667
|
},
|
|
26791
27668
|
"errors": {
|
|
26792
|
-
"set":
|
|
27669
|
+
"set": 3
|
|
26793
27670
|
},
|
|
26794
27671
|
"metadata": {
|
|
26795
|
-
"purpose": "
|
|
26796
|
-
"usage": "
|
|
26797
|
-
"preferredWhen": "
|
|
27672
|
+
"purpose": "Get one ResourceDailyAvailability by id.",
|
|
27673
|
+
"usage": "item: null on the 200 body maps to NotFoundError (vendor not-found signal). Availability depends on API-user permissions and feature activation; an empty query is inconclusive about inventory. Weekly Billable Hours Goal activation controls weeklyBillableHoursGoal query/filter/update support; inactive features can return null and forbid filtering or updates. Use weeklyBillableHoursGoal and travelAvailability from exposed field metadata, not the misspellings weeklyBillableGoalHours/travelAvailablity in official prose. Resource administration is account-wide; resourceID is a staff parent, not company ownership. This SDK slice exposes reads only; availability updates remain tracked separately.",
|
|
27674
|
+
"preferredWhen": "Use the global item read when the availability row ID is known. Discover rows for a staff member with resource_daily_availabilities.query filtered by resourceID, or use resource_daily_availabilities.listByParent for one native page. operations.fetchByIds currently refuses this parent-associated resource.",
|
|
26798
27675
|
"related": [
|
|
26799
|
-
"
|
|
27676
|
+
"resource_daily_availabilities.query",
|
|
27677
|
+
"resource_daily_availabilities.listByParent"
|
|
26800
27678
|
],
|
|
26801
|
-
"
|
|
26802
|
-
"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."
|
|
26803
|
-
},
|
|
27679
|
+
"args": "args[0] is the record id (safe integer or decimal string; use the string form above Number.MAX_SAFE_INTEGER). Item GET returns the FULL vendor model — the vendor documents no field selection on single-record reads. For a slim record use a resource_daily_availabilities.query with includeFields.",
|
|
26804
27680
|
"untrustedFields": [
|
|
26805
|
-
"
|
|
26806
|
-
]
|
|
26807
|
-
"createRequirements": {
|
|
26808
|
-
"requires": {
|
|
26809
|
-
"allOf": [
|
|
26810
|
-
"attachmentType",
|
|
26811
|
-
"fullPath",
|
|
26812
|
-
"title",
|
|
26813
|
-
"publish",
|
|
26814
|
-
"data"
|
|
26815
|
-
]
|
|
26816
|
-
},
|
|
26817
|
-
"requiresByValue": [
|
|
26818
|
-
{
|
|
26819
|
-
"field": "attachmentType",
|
|
26820
|
-
"value": "FILE_ATTACHMENT",
|
|
26821
|
-
"requires": {
|
|
26822
|
-
"allOf": [
|
|
26823
|
-
"data"
|
|
26824
|
-
]
|
|
26825
|
-
}
|
|
26826
|
-
}
|
|
26827
|
-
]
|
|
26828
|
-
}
|
|
27681
|
+
"travelAvailability"
|
|
27682
|
+
]
|
|
26829
27683
|
},
|
|
26830
27684
|
"compact": null,
|
|
26831
27685
|
"status": "tested"
|
|
26832
27686
|
},
|
|
26833
27687
|
{
|
|
26834
|
-
"id": "
|
|
26835
|
-
"resource": "
|
|
27688
|
+
"id": "resource_daily_availabilities.getEntityInfo",
|
|
27689
|
+
"resource": "resource_daily_availabilities",
|
|
26836
27690
|
"udfCapable": false,
|
|
26837
|
-
"operation": "
|
|
27691
|
+
"operation": "getEntityInfo",
|
|
26838
27692
|
"kind": "primitive",
|
|
26839
|
-
"endpoint": "
|
|
26840
|
-
"effect": "
|
|
26841
|
-
"flags": [
|
|
26842
|
-
|
|
26843
|
-
|
|
26844
|
-
|
|
26845
|
-
"dryRun": true,
|
|
26846
|
-
"envelope": "OperationResultModel (attachment entities: the deleted attachment model is returned, not OperationResultModel)",
|
|
26847
|
-
"inputSchema": {
|
|
26848
|
-
"parentId": {
|
|
26849
|
-
"type": "string | number",
|
|
26850
|
-
"required": true,
|
|
26851
|
-
"description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
|
|
26852
|
-
},
|
|
26853
|
-
"id": {
|
|
26854
|
-
"type": "string | number",
|
|
26855
|
-
"required": true,
|
|
26856
|
-
"description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
|
|
26857
|
-
}
|
|
26858
|
-
},
|
|
27693
|
+
"endpoint": "GET /V1.0/ResourceDailyAvailabilities/entityInformation",
|
|
27694
|
+
"effect": "read",
|
|
27695
|
+
"flags": [],
|
|
27696
|
+
"dryRun": false,
|
|
27697
|
+
"envelope": "EntityInformationResultModel",
|
|
27698
|
+
"inputSchema": {},
|
|
26859
27699
|
"inputSchemaStrict": true,
|
|
26860
27700
|
"outputSchema": {
|
|
26861
|
-
"type": "
|
|
27701
|
+
"type": "EntityInformationResultModel",
|
|
26862
27702
|
"drops": []
|
|
26863
27703
|
},
|
|
26864
27704
|
"examples": [
|
|
26865
|
-
"await
|
|
27705
|
+
"await client.resourceDailyAvailabilities.getEntityInfo()"
|
|
26866
27706
|
],
|
|
26867
27707
|
"permissions": "unknown",
|
|
26868
27708
|
"pagination": {
|
|
@@ -26870,67 +27710,42 @@ const CAPABILITY_DATA = {
|
|
|
26870
27710
|
},
|
|
26871
27711
|
"resolution": null,
|
|
26872
27712
|
"retry": {
|
|
26873
|
-
"preset": "retry-
|
|
27713
|
+
"preset": "retry-ffb3a9cb"
|
|
26874
27714
|
},
|
|
26875
27715
|
"errors": {
|
|
26876
|
-
"set":
|
|
27716
|
+
"set": 6
|
|
26877
27717
|
},
|
|
26878
27718
|
"metadata": {
|
|
26879
|
-
"purpose": "
|
|
26880
|
-
"usage": "
|
|
27719
|
+
"purpose": "Get the ResourceDailyAvailability capability metadata (canCreate/canUpdate/hasUserDefinedFields/...).",
|
|
27720
|
+
"usage": "Unwraps info{}; drives client-side capability checks. Availability depends on API-user permissions and feature activation; an empty query is inconclusive about inventory. Weekly Billable Hours Goal activation controls weeklyBillableHoursGoal query/filter/update support; inactive features can return null and forbid filtering or updates. Use weeklyBillableHoursGoal and travelAvailability from exposed field metadata, not the misspellings weeklyBillableGoalHours/travelAvailablity in official prose. Resource administration is account-wide; resourceID is a staff parent, not company ownership. This SDK slice exposes reads only; availability updates remain tracked separately.",
|
|
26881
27721
|
"preferredWhen": null,
|
|
26882
|
-
"related": [
|
|
26883
|
-
"resource_attachments.get"
|
|
26884
|
-
],
|
|
27722
|
+
"related": [],
|
|
26885
27723
|
"untrustedFields": [
|
|
26886
|
-
"
|
|
27724
|
+
"travelAvailability"
|
|
26887
27725
|
]
|
|
26888
27726
|
},
|
|
26889
27727
|
"compact": null,
|
|
26890
27728
|
"status": "tested"
|
|
26891
27729
|
},
|
|
26892
27730
|
{
|
|
26893
|
-
"id": "
|
|
26894
|
-
"resource": "
|
|
27731
|
+
"id": "resource_daily_availabilities.getFieldInfo",
|
|
27732
|
+
"resource": "resource_daily_availabilities",
|
|
26895
27733
|
"udfCapable": false,
|
|
26896
|
-
"operation": "
|
|
27734
|
+
"operation": "getFieldInfo",
|
|
26897
27735
|
"kind": "primitive",
|
|
26898
|
-
"endpoint": "GET /V1.0/
|
|
27736
|
+
"endpoint": "GET /V1.0/ResourceDailyAvailabilities/entityInformation/fields",
|
|
26899
27737
|
"effect": "read",
|
|
26900
27738
|
"flags": [],
|
|
26901
27739
|
"dryRun": false,
|
|
26902
|
-
"envelope": "
|
|
26903
|
-
"inputSchema": {
|
|
26904
|
-
"parentId": {
|
|
26905
|
-
"type": "string | number",
|
|
26906
|
-
"required": true,
|
|
26907
|
-
"description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
|
|
26908
|
-
},
|
|
26909
|
-
"id": {
|
|
26910
|
-
"type": "string | number",
|
|
26911
|
-
"required": true,
|
|
26912
|
-
"description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
|
|
26913
|
-
},
|
|
26914
|
-
"opts": {
|
|
26915
|
-
"type": "object",
|
|
26916
|
-
"required": false,
|
|
26917
|
-
"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.",
|
|
26918
|
-
"properties": [
|
|
26919
|
-
{
|
|
26920
|
-
"name": "fresh",
|
|
26921
|
-
"type": "boolean",
|
|
26922
|
-
"optional": true
|
|
26923
|
-
}
|
|
26924
|
-
]
|
|
26925
|
-
}
|
|
26926
|
-
},
|
|
27740
|
+
"envelope": "FieldInformationResultModel",
|
|
27741
|
+
"inputSchema": {},
|
|
26927
27742
|
"inputSchemaStrict": true,
|
|
26928
27743
|
"outputSchema": {
|
|
26929
|
-
"type": "
|
|
27744
|
+
"type": "FieldInformationResultModel",
|
|
26930
27745
|
"drops": []
|
|
26931
27746
|
},
|
|
26932
27747
|
"examples": [
|
|
26933
|
-
"await client.
|
|
27748
|
+
"await client.resourceDailyAvailabilities.getFieldInfo()"
|
|
26934
27749
|
],
|
|
26935
27750
|
"permissions": "unknown",
|
|
26936
27751
|
"pagination": {
|
|
@@ -26941,42 +27756,39 @@ const CAPABILITY_DATA = {
|
|
|
26941
27756
|
"preset": "retry-ffb3a9cb"
|
|
26942
27757
|
},
|
|
26943
27758
|
"errors": {
|
|
26944
|
-
"set":
|
|
27759
|
+
"set": 6
|
|
26945
27760
|
},
|
|
26946
27761
|
"metadata": {
|
|
26947
|
-
"purpose": "Get
|
|
26948
|
-
"usage": "
|
|
26949
|
-
"preferredWhen": "
|
|
26950
|
-
"related": [
|
|
26951
|
-
"resource_attachments.query"
|
|
26952
|
-
],
|
|
26953
|
-
"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.",
|
|
27762
|
+
"purpose": "Get the ResourceDailyAvailability field catalog (types, picklists, required, maxLength) — the full raw field dump (the largest read of the info trio; compact discovery: operations.fieldCatalog).",
|
|
27763
|
+
"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.",
|
|
27764
|
+
"preferredWhen": "Availability depends on API-user permissions and feature activation; an empty query is inconclusive about inventory. Weekly Billable Hours Goal activation controls weeklyBillableHoursGoal query/filter/update support; inactive features can return null and forbid filtering or updates. Use weeklyBillableHoursGoal and travelAvailability from exposed field metadata, not the misspellings weeklyBillableGoalHours/travelAvailablity in official prose. Resource administration is account-wide; resourceID is a staff parent, not company ownership. This SDK slice exposes reads only; availability updates remain tracked separately.",
|
|
27765
|
+
"related": [],
|
|
26954
27766
|
"untrustedFields": [
|
|
26955
|
-
"
|
|
27767
|
+
"travelAvailability"
|
|
26956
27768
|
]
|
|
26957
27769
|
},
|
|
26958
27770
|
"compact": null,
|
|
26959
27771
|
"status": "tested"
|
|
26960
27772
|
},
|
|
26961
27773
|
{
|
|
26962
|
-
"id": "
|
|
26963
|
-
"resource": "
|
|
27774
|
+
"id": "resource_daily_availabilities.getUdfInfo",
|
|
27775
|
+
"resource": "resource_daily_availabilities",
|
|
26964
27776
|
"udfCapable": false,
|
|
26965
|
-
"operation": "
|
|
27777
|
+
"operation": "getUdfInfo",
|
|
26966
27778
|
"kind": "primitive",
|
|
26967
|
-
"endpoint": "GET /V1.0/
|
|
27779
|
+
"endpoint": "GET /V1.0/ResourceDailyAvailabilities/entityInformation/userDefinedFields",
|
|
26968
27780
|
"effect": "read",
|
|
26969
27781
|
"flags": [],
|
|
26970
27782
|
"dryRun": false,
|
|
26971
|
-
"envelope": "
|
|
27783
|
+
"envelope": "UserDefinedFieldInformationResultModel",
|
|
26972
27784
|
"inputSchema": {},
|
|
26973
27785
|
"inputSchemaStrict": true,
|
|
26974
27786
|
"outputSchema": {
|
|
26975
|
-
"type": "
|
|
27787
|
+
"type": "UserDefinedFieldInformationResultModel",
|
|
26976
27788
|
"drops": []
|
|
26977
27789
|
},
|
|
26978
27790
|
"examples": [
|
|
26979
|
-
"await client.
|
|
27791
|
+
"await client.resourceDailyAvailabilities.getUdfInfo()"
|
|
26980
27792
|
],
|
|
26981
27793
|
"permissions": "unknown",
|
|
26982
27794
|
"pagination": {
|
|
@@ -26987,41 +27799,45 @@ const CAPABILITY_DATA = {
|
|
|
26987
27799
|
"preset": "retry-ffb3a9cb"
|
|
26988
27800
|
},
|
|
26989
27801
|
"errors": {
|
|
26990
|
-
"set":
|
|
27802
|
+
"set": 6
|
|
26991
27803
|
},
|
|
26992
27804
|
"metadata": {
|
|
26993
|
-
"purpose": "Get the
|
|
26994
|
-
"usage": "Unwraps
|
|
27805
|
+
"purpose": "Get the ResourceDailyAvailability user-defined-field catalog.",
|
|
27806
|
+
"usage": "Unwraps fields[]; only meaningful where the entity is UDF-capable. (entity is not UDF-capable; catalog is expected empty). Availability depends on API-user permissions and feature activation; an empty query is inconclusive about inventory. Weekly Billable Hours Goal activation controls weeklyBillableHoursGoal query/filter/update support; inactive features can return null and forbid filtering or updates. Use weeklyBillableHoursGoal and travelAvailability from exposed field metadata, not the misspellings weeklyBillableGoalHours/travelAvailablity in official prose. Resource administration is account-wide; resourceID is a staff parent, not company ownership. This SDK slice exposes reads only; availability updates remain tracked separately.",
|
|
26995
27807
|
"preferredWhen": null,
|
|
26996
|
-
"related": [
|
|
26997
|
-
"resource_attachments.getFieldInfo"
|
|
26998
|
-
],
|
|
27808
|
+
"related": [],
|
|
26999
27809
|
"untrustedFields": [
|
|
27000
|
-
"
|
|
27810
|
+
"travelAvailability"
|
|
27001
27811
|
]
|
|
27002
27812
|
},
|
|
27003
27813
|
"compact": null,
|
|
27004
27814
|
"status": "tested"
|
|
27005
27815
|
},
|
|
27006
27816
|
{
|
|
27007
|
-
"id": "
|
|
27008
|
-
"resource": "
|
|
27817
|
+
"id": "resource_daily_availabilities.listByParent",
|
|
27818
|
+
"resource": "resource_daily_availabilities",
|
|
27009
27819
|
"udfCapable": false,
|
|
27010
|
-
"operation": "
|
|
27820
|
+
"operation": "listByParent",
|
|
27011
27821
|
"kind": "primitive",
|
|
27012
|
-
"endpoint": "GET /V1.0/
|
|
27822
|
+
"endpoint": "GET /V1.0/Resources/{parentId}/DailyAvailabilities",
|
|
27013
27823
|
"effect": "read",
|
|
27014
27824
|
"flags": [],
|
|
27015
27825
|
"dryRun": false,
|
|
27016
|
-
"envelope": "
|
|
27017
|
-
"inputSchema": {
|
|
27826
|
+
"envelope": "QueryActionResult[ResourceDailyAvailabilityModel,ResourceDailyAvailability]",
|
|
27827
|
+
"inputSchema": {
|
|
27828
|
+
"parentId": {
|
|
27829
|
+
"type": "string | number",
|
|
27830
|
+
"required": true,
|
|
27831
|
+
"description": "The documented parent route id; no filter, limit, or caller cursor is accepted."
|
|
27832
|
+
}
|
|
27833
|
+
},
|
|
27018
27834
|
"inputSchemaStrict": true,
|
|
27019
27835
|
"outputSchema": {
|
|
27020
|
-
"type": "
|
|
27836
|
+
"type": "QueryActionResult[ResourceDailyAvailabilityModel,ResourceDailyAvailability]",
|
|
27021
27837
|
"drops": []
|
|
27022
27838
|
},
|
|
27023
27839
|
"examples": [
|
|
27024
|
-
"await client.
|
|
27840
|
+
"await invoke(client, 'resource_daily_availabilities.listByParent', [7])"
|
|
27025
27841
|
],
|
|
27026
27842
|
"permissions": "unknown",
|
|
27027
27843
|
"pagination": {
|
|
@@ -27032,33 +27848,35 @@ const CAPABILITY_DATA = {
|
|
|
27032
27848
|
"preset": "retry-ffb3a9cb"
|
|
27033
27849
|
},
|
|
27034
27850
|
"errors": {
|
|
27035
|
-
"set":
|
|
27851
|
+
"set": 11
|
|
27036
27852
|
},
|
|
27037
27853
|
"metadata": {
|
|
27038
|
-
"purpose": "
|
|
27039
|
-
"usage": "
|
|
27040
|
-
"
|
|
27854
|
+
"purpose": "Read one native parent-scoped staff-association page.",
|
|
27855
|
+
"usage": "One vendor-controlled native page, with no supported filter or limit argument. Returns items and hasMore; no raw cursor is served or followed. Use the global query with a total limit and an explicit resourceID filter for a complete bounded query within its caps; exact scoped/global membership or visibility parity is unproven. API-user permissions and enabled features remain conditional. Staff associations do not establish company ownership. Returned rows must match the requested parent through the documented int32 resourceID field. Under that model a route parent above the signed int32 range can only yield a valid empty page. An empty page does not establish tenant-wide absence.",
|
|
27856
|
+
"args": "args[0] is the route parent ID, a non-negative signed int64 integer. Use a decimal string above Number.MAX_SAFE_INTEGER. Each returned row has its own independent int64 ID.",
|
|
27857
|
+
"preferredWhen": "Use when the documented native parent collection is required; global get remains single-record-id only.",
|
|
27041
27858
|
"related": [
|
|
27042
|
-
"
|
|
27859
|
+
"resource_daily_availabilities.query",
|
|
27860
|
+
"resource_daily_availabilities.get"
|
|
27043
27861
|
],
|
|
27044
27862
|
"untrustedFields": [
|
|
27045
|
-
"
|
|
27863
|
+
"travelAvailability"
|
|
27046
27864
|
]
|
|
27047
27865
|
},
|
|
27048
27866
|
"compact": null,
|
|
27049
27867
|
"status": "tested"
|
|
27050
27868
|
},
|
|
27051
27869
|
{
|
|
27052
|
-
"id": "
|
|
27053
|
-
"resource": "
|
|
27870
|
+
"id": "resource_daily_availabilities.query",
|
|
27871
|
+
"resource": "resource_daily_availabilities",
|
|
27054
27872
|
"udfCapable": false,
|
|
27055
27873
|
"operation": "query",
|
|
27056
27874
|
"kind": "primitive",
|
|
27057
|
-
"endpoint": "GET|POST /V1.0/
|
|
27875
|
+
"endpoint": "GET|POST /V1.0/ResourceDailyAvailabilities/query",
|
|
27058
27876
|
"effect": "read",
|
|
27059
27877
|
"flags": [],
|
|
27060
27878
|
"dryRun": false,
|
|
27061
|
-
"envelope": "QueryActionResult[
|
|
27879
|
+
"envelope": "QueryActionResult[ResourceDailyAvailabilityModel,ResourceDailyAvailability]",
|
|
27062
27880
|
"inputSchema": {
|
|
27063
27881
|
"params": {
|
|
27064
27882
|
"type": "object",
|
|
@@ -27122,11 +27940,11 @@ const CAPABILITY_DATA = {
|
|
|
27122
27940
|
},
|
|
27123
27941
|
"inputSchemaStrict": true,
|
|
27124
27942
|
"outputSchema": {
|
|
27125
|
-
"type": "QueryActionResult[
|
|
27943
|
+
"type": "QueryActionResult[ResourceDailyAvailabilityModel,ResourceDailyAvailability]",
|
|
27126
27944
|
"drops": []
|
|
27127
27945
|
},
|
|
27128
27946
|
"examples": [
|
|
27129
|
-
"await invoke(client, '
|
|
27947
|
+
"await invoke(client, 'resource_daily_availabilities.query', [{ filter: [{ field: 'resourceID', op: 'eq', value: 7 }], limit: 25 }])"
|
|
27130
27948
|
],
|
|
27131
27949
|
"permissions": "unknown",
|
|
27132
27950
|
"pagination": {
|
|
@@ -27144,18 +27962,16 @@ const CAPABILITY_DATA = {
|
|
|
27144
27962
|
"preset": "retry-ffb3a9cb"
|
|
27145
27963
|
},
|
|
27146
27964
|
"errors": {
|
|
27147
|
-
"set":
|
|
27965
|
+
"set": 11
|
|
27148
27966
|
},
|
|
27149
27967
|
"metadata": {
|
|
27150
|
-
"purpose": "Query
|
|
27151
|
-
"usage": "Server-side pagination: one call walks the vendor cursor internally and preserves the initial HTTP method until the limit is met or the cursor is null. By default, each POST carries the same QueryModel body (IncludeFields, MaxRecords and the original filter). The vendor honours IncludeFields on POST continuations and uses its own continuation page size. With `via: 'get'`, the SDK follows the GET cursor with the original search parameters. Cursors must stay on the configured origin; 1000-page guard (hasMore stays true at the guard). queryAll is the unbounded raw walk — only when you need the ENTIRE set and accept a large payload; default to the bounded query op. noteChars: N (integer >= 1) is an opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose — the same set the server wraps): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result (zero wire — response-side only). latest: N returns the N highest-id rows (id-descending): the vendor has no sort parameter — this is the only ordering channel, and a date window in `filter` narrows the cost; count-anchored — C ≤ 2500 → one count + a ≤6-page walk of the matching set, C > 2500 → count probes + an id-threshold window (≤64 probes; LATEST_THRESHOLD_UNRESOLVED on budget exhaustion), a blind count → a bounded walk with the blind-surface stamp (LATEST_WINDOW_INCOMPLETE on a truncated walk).
|
|
27968
|
+
"purpose": "Query ResourceDailyAvailability records with a JSON filter.",
|
|
27969
|
+
"usage": "Server-side pagination: one call walks the vendor cursor internally and preserves the initial HTTP method until the limit is met or the cursor is null. By default, each POST carries the same QueryModel body (IncludeFields, MaxRecords and the original filter). The vendor honours IncludeFields on POST continuations and uses its own continuation page size. With `via: 'get'`, the SDK follows the GET cursor with the original search parameters. Cursors must stay on the configured origin; 1000-page guard (hasMore stays true at the guard). queryAll is the unbounded raw walk — only when you need the ENTIRE set and accept a large payload; default to the bounded query op. noteChars: N (integer >= 1) is an opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose — the same set the server wraps): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result (zero wire — response-side only). latest: N returns the N highest-id rows (id-descending): the vendor has no sort parameter — this is the only ordering channel, and a date window in `filter` narrows the cost; count-anchored — C ≤ 2500 → one count + a ≤6-page walk of the matching set, C > 2500 → count probes + an id-threshold window (≤64 probes; LATEST_THRESHOLD_UNRESOLVED on budget exhaustion), a blind count → a bounded walk with the blind-surface stamp (LATEST_WINDOW_INCOMPLETE on a truncated walk). Explicit walk.maxRows independently sets the TOTAL returned-row cap (including export-sized walks); the ordinary limit is still validated in 1..2500 and only bounds the internal page size for this form. hasMore and truncated remain true at the page guard or while a cursor or unserved fetched rows remain. Self-resource prefixes are accepted in filter fields and includeFields; dotted UDF names are always refused before metadata or vendor requests, never rewritten to another tenant UDF. Global reads: filter with resourceID eq <parentId> to select a staff resource. Availability depends on API-user permissions and feature activation; an empty query is inconclusive about inventory. Weekly Billable Hours Goal activation controls weeklyBillableHoursGoal query/filter/update support; inactive features can return null and forbid filtering or updates. Use weeklyBillableHoursGoal and travelAvailability from exposed field metadata, not the misspellings weeklyBillableGoalHours/travelAvailablity in official prose. Resource administration is account-wide; resourceID is a staff parent, not company ownership. This SDK slice exposes reads only; availability updates remain tracked separately.",
|
|
27152
27970
|
"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).",
|
|
27153
|
-
"related": [
|
|
27154
|
-
"resource_attachments.get"
|
|
27155
|
-
],
|
|
27971
|
+
"related": [],
|
|
27156
27972
|
"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.",
|
|
27157
27973
|
"untrustedFields": [
|
|
27158
|
-
"
|
|
27974
|
+
"travelAvailability"
|
|
27159
27975
|
]
|
|
27160
27976
|
},
|
|
27161
27977
|
"compact": null,
|
|
@@ -30559,7 +31375,7 @@ const CAPABILITY_DATA = {
|
|
|
30559
31375
|
"preset": "retry-ffb3a9cb"
|
|
30560
31376
|
},
|
|
30561
31377
|
"errors": {
|
|
30562
|
-
"set":
|
|
31378
|
+
"set": 12
|
|
30563
31379
|
},
|
|
30564
31380
|
"metadata": {
|
|
30565
31381
|
"purpose": "Get a resource's workload in a single call: its open tickets (rows + the exact open totals), its task assignments and the tasks behind them, its time-off balances and requests.",
|
|
@@ -34765,7 +35581,7 @@ const CAPABILITY_DATA = {
|
|
|
34765
35581
|
"preset": "retry-ffb3a9cb"
|
|
34766
35582
|
},
|
|
34767
35583
|
"errors": {
|
|
34768
|
-
"set":
|
|
35584
|
+
"set": 13
|
|
34769
35585
|
},
|
|
34770
35586
|
"metadata": {
|
|
34771
35587
|
"purpose": "Get a service call with its tickets, tasks and resource assignments in a single call — the assignment join runs through the call's task row ids (serviceCallTaskID).",
|
|
@@ -44239,7 +45055,7 @@ const CAPABILITY_DATA = {
|
|
|
44239
45055
|
"preset": "retry-ffb3a9cb"
|
|
44240
45056
|
},
|
|
44241
45057
|
"errors": {
|
|
44242
|
-
"set":
|
|
45058
|
+
"set": 14
|
|
44243
45059
|
},
|
|
44244
45060
|
"metadata": {
|
|
44245
45061
|
"purpose": "The ONE posted-state read: a bounded read over the inclusive dateWorked window [from, to] (UTC 'YYYY-MM-DD' days) with the posted/unposted split derived from the billing_items.timeEntryID join — never a postedDate read (the TimeEntry entity has no postedDate; postedDate exist|notExist 500s). Approval is NOT consulted (the vendor never populates billingApprovalDateTime yet bills those entries). The no-window form is gone: read with no dateWorked filter goes through time_entries.query.",
|
|
@@ -47905,8 +48721,8 @@ const CAPABILITY_DATA = {
|
|
|
47905
48721
|
]
|
|
47906
48722
|
},
|
|
47907
48723
|
"A": {
|
|
47908
|
-
"planHash": "
|
|
47909
|
-
"builtAt": "2026-11-
|
|
48724
|
+
"planHash": "51888554f455b96e13c50591342fa516b095065762430b783201ac7a995a0901",
|
|
48725
|
+
"builtAt": "2026-11-22T07:17:16.330Z",
|
|
47910
48726
|
"records": [
|
|
47911
48727
|
{
|
|
47912
48728
|
"id": "attachment_info.count",
|
|
@@ -48559,7 +49375,7 @@ const CAPABILITY_DATA = {
|
|
|
48559
49375
|
"preset": "retry-ffb3a9cb"
|
|
48560
49376
|
},
|
|
48561
49377
|
"errors": {
|
|
48562
|
-
"set":
|
|
49378
|
+
"set": 15
|
|
48563
49379
|
},
|
|
48564
49380
|
"metadata": {
|
|
48565
49381
|
"purpose": "Get everything the node knows about one company in a single call: the company record, its locations, contacts and notes, its open tickets, and its projects — every part separately reported with caps.",
|
|
@@ -48748,7 +49564,7 @@ const CAPABILITY_DATA = {
|
|
|
48748
49564
|
"preset": "retry-ffb3a9cb"
|
|
48749
49565
|
},
|
|
48750
49566
|
"errors": {
|
|
48751
|
-
"set":
|
|
49567
|
+
"set": 16
|
|
48752
49568
|
},
|
|
48753
49569
|
"metadata": {
|
|
48754
49570
|
"purpose": "Get a company with its primary context records in one call.",
|
|
@@ -49034,7 +49850,7 @@ const CAPABILITY_DATA = {
|
|
|
49034
49850
|
"preset": "retry-ffb3a9cb"
|
|
49035
49851
|
},
|
|
49036
49852
|
"errors": {
|
|
49037
|
-
"set":
|
|
49853
|
+
"set": 16
|
|
49038
49854
|
},
|
|
49039
49855
|
"metadata": {
|
|
49040
49856
|
"purpose": "Plan a CRM write: from partial company/contact details, find the company, its locations and the location to link a contact to, duplicate contacts, the required fields still missing (with how to get each) and the next atomic write to preview.",
|
|
@@ -49788,7 +50604,7 @@ const CAPABILITY_DATA = {
|
|
|
49788
50604
|
"preset": "retry-ffb3a9cb"
|
|
49789
50605
|
},
|
|
49790
50606
|
"errors": {
|
|
49791
|
-
"set":
|
|
50607
|
+
"set": 17
|
|
49792
50608
|
},
|
|
49793
50609
|
"metadata": {
|
|
49794
50610
|
"purpose": "One call for a company's unbilled work: its posted billing items (per source), the time behind them (joined through the company's tickets and tasks — time entries carry no companyID), the per-ticket rollup, the unposted anti-join section, ex-tax totals + hours, and the billing-vs-time warnings",
|
|
@@ -59094,7 +59910,7 @@ const CAPABILITY_DATA = {
|
|
|
59094
59910
|
"preset": "retry-ffb3a9cb"
|
|
59095
59911
|
},
|
|
59096
59912
|
"errors": {
|
|
59097
|
-
"set":
|
|
59913
|
+
"set": 16
|
|
59098
59914
|
},
|
|
59099
59915
|
"metadata": {
|
|
59100
59916
|
"purpose": "Get a configuration item with its primary context records in one call.",
|
|
@@ -59487,7 +60303,7 @@ const CAPABILITY_DATA = {
|
|
|
59487
60303
|
"preset": "retry-ffb3a9cb"
|
|
59488
60304
|
},
|
|
59489
60305
|
"errors": {
|
|
59490
|
-
"set":
|
|
60306
|
+
"set": 17
|
|
59491
60307
|
},
|
|
59492
60308
|
"metadata": {
|
|
59493
60309
|
"purpose": "Get the full profile of one configuration item in a single call: the item, its type, category and product records, its notes, related items, billing-product associations and subscriptions (software/licence terms keyed by configurationItemID).",
|
|
@@ -61075,7 +61891,7 @@ const CAPABILITY_DATA = {
|
|
|
61075
61891
|
"preset": "retry-ffb3a9cb"
|
|
61076
61892
|
},
|
|
61077
61893
|
"errors": {
|
|
61078
|
-
"set":
|
|
61894
|
+
"set": 12
|
|
61079
61895
|
},
|
|
61080
61896
|
"metadata": {
|
|
61081
61897
|
"purpose": "Get a contact with its company and its open tickets in a single call: the contact (the parent-scoped root read, or row when the contact has no company FK), its company, and its open tickets — every part separately reported.",
|
|
@@ -61263,7 +62079,7 @@ const CAPABILITY_DATA = {
|
|
|
61263
62079
|
"preset": "retry-ffb3a9cb"
|
|
61264
62080
|
},
|
|
61265
62081
|
"errors": {
|
|
61266
|
-
"set":
|
|
62082
|
+
"set": 16
|
|
61267
62083
|
},
|
|
61268
62084
|
"metadata": {
|
|
61269
62085
|
"purpose": "Get a contact with its primary context records in one call. (under a company)",
|
|
@@ -72203,7 +73019,7 @@ const CAPABILITY_DATA = {
|
|
|
72203
73019
|
"preset": "retry-ffb3a9cb"
|
|
72204
73020
|
},
|
|
72205
73021
|
"errors": {
|
|
72206
|
-
"set":
|
|
73022
|
+
"set": 13
|
|
72207
73023
|
},
|
|
72208
73024
|
"metadata": {
|
|
72209
73025
|
"purpose": "Get a contract with its services, billing rules, recent charges and service units in a single call — the charges part is the N newest (the count-anchored `latest` 50).",
|
|
@@ -72579,7 +73395,7 @@ const CAPABILITY_DATA = {
|
|
|
72579
73395
|
"preset": "retry-ffb3a9cb"
|
|
72580
73396
|
},
|
|
72581
73397
|
"errors": {
|
|
72582
|
-
"set":
|
|
73398
|
+
"set": 17
|
|
72583
73399
|
},
|
|
72584
73400
|
"metadata": {
|
|
72585
73401
|
"purpose": "Get the Line of Business chain for one contract in a single call: the association, the OrganizationalLevel2 (the customizable 'Line of Business' label) and the OrganizationalLevel1 (the division).",
|
|
@@ -72729,7 +73545,7 @@ const CAPABILITY_DATA = {
|
|
|
72729
73545
|
"preset": "retry-ffb3a9cb"
|
|
72730
73546
|
},
|
|
72731
73547
|
"errors": {
|
|
72732
|
-
"set":
|
|
73548
|
+
"set": 17
|
|
72733
73549
|
},
|
|
72734
73550
|
"metadata": {
|
|
72735
73551
|
"purpose": "One call for a contract's profit-and-loss over a date window: monthly revenue (invoiced vs expected-but-unbilled), labour cost through an audited four-rung rate ladder, tooling/recurring/expense costs, break-even hours, the ticketCategory activity fold, the costliest tickets, suspected miscoded time, open/renewal items, and 11 built-in data-quality warnings",
|
|
@@ -73321,7 +74137,7 @@ const CAPABILITY_DATA = {
|
|
|
73321
74137
|
"preset": "retry-c5657094"
|
|
73322
74138
|
},
|
|
73323
74139
|
"errors": {
|
|
73324
|
-
"set":
|
|
74140
|
+
"set": 18
|
|
73325
74141
|
},
|
|
73326
74142
|
"metadata": {
|
|
73327
74143
|
"purpose": "Create a product-location inventory item.",
|
|
@@ -73657,7 +74473,7 @@ const CAPABILITY_DATA = {
|
|
|
73657
74473
|
"preset": "retry-ffb3a9cb"
|
|
73658
74474
|
},
|
|
73659
74475
|
"errors": {
|
|
73660
|
-
"set":
|
|
74476
|
+
"set": 19
|
|
73661
74477
|
},
|
|
73662
74478
|
"metadata": {
|
|
73663
74479
|
"purpose": "Query InventoryItem records with a JSON filter.",
|
|
@@ -73715,7 +74531,7 @@ const CAPABILITY_DATA = {
|
|
|
73715
74531
|
"preset": "retry-c5657094"
|
|
73716
74532
|
},
|
|
73717
74533
|
"errors": {
|
|
73718
|
-
"set":
|
|
74534
|
+
"set": 18
|
|
73719
74535
|
},
|
|
73720
74536
|
"metadata": {
|
|
73721
74537
|
"purpose": "Update writable inventory item fields with collection PATCH.",
|
|
@@ -73833,7 +74649,7 @@ const CAPABILITY_DATA = {
|
|
|
73833
74649
|
"preset": "retry-c5657094"
|
|
73834
74650
|
},
|
|
73835
74651
|
"errors": {
|
|
73836
|
-
"set":
|
|
74652
|
+
"set": 20
|
|
73837
74653
|
},
|
|
73838
74654
|
"metadata": {
|
|
73839
74655
|
"purpose": "Create an inventory location.",
|
|
@@ -74159,7 +74975,7 @@ const CAPABILITY_DATA = {
|
|
|
74159
74975
|
"preset": "retry-ffb3a9cb"
|
|
74160
74976
|
},
|
|
74161
74977
|
"errors": {
|
|
74162
|
-
"set":
|
|
74978
|
+
"set": 11
|
|
74163
74979
|
},
|
|
74164
74980
|
"metadata": {
|
|
74165
74981
|
"purpose": "Query InventoryLocation records with a JSON filter.",
|
|
@@ -79488,7 +80304,7 @@ const CAPABILITY_DATA = {
|
|
|
79488
80304
|
"preset": "retry-ffb3a9cb"
|
|
79489
80305
|
},
|
|
79490
80306
|
"errors": {
|
|
79491
|
-
"set":
|
|
80307
|
+
"set": 16
|
|
79492
80308
|
},
|
|
79493
80309
|
"metadata": {
|
|
79494
80310
|
"purpose": "Get a project with its primary context records in one call.",
|
|
@@ -82095,7 +82911,7 @@ const CAPABILITY_DATA = {
|
|
|
82095
82911
|
"preset": "retry-ffb3a9cb"
|
|
82096
82912
|
},
|
|
82097
82913
|
"errors": {
|
|
82098
|
-
"set":
|
|
82914
|
+
"set": 13
|
|
82099
82915
|
},
|
|
82100
82916
|
"metadata": {
|
|
82101
82917
|
"purpose": "Get a quote with its line items in a single call — the items part is the bounded quoteID-filtered query.",
|
|
@@ -83039,7 +83855,7 @@ const CAPABILITY_DATA = {
|
|
|
83039
83855
|
"preset": "retry-c5657094"
|
|
83040
83856
|
},
|
|
83041
83857
|
"errors": {
|
|
83042
|
-
"set":
|
|
83858
|
+
"set": 20
|
|
83043
83859
|
},
|
|
83044
83860
|
"metadata": {
|
|
83045
83861
|
"purpose": "Create an attachment under a task.",
|
|
@@ -83382,7 +84198,7 @@ const CAPABILITY_DATA = {
|
|
|
83382
84198
|
"preset": "retry-ffb3a9cb"
|
|
83383
84199
|
},
|
|
83384
84200
|
"errors": {
|
|
83385
|
-
"set":
|
|
84201
|
+
"set": 11
|
|
83386
84202
|
},
|
|
83387
84203
|
"metadata": {
|
|
83388
84204
|
"purpose": "Query TaskAttachment records with a JSON filter.",
|
|
@@ -92686,7 +93502,7 @@ const CAPABILITY_DATA = {
|
|
|
92686
93502
|
"preset": "retry-ffb3a9cb"
|
|
92687
93503
|
},
|
|
92688
93504
|
"errors": {
|
|
92689
|
-
"set":
|
|
93505
|
+
"set": 17
|
|
92690
93506
|
},
|
|
92691
93507
|
"metadata": {
|
|
92692
93508
|
"purpose": "Get the full context of one ticket in a single call: the ticket, its company, contact, assigned resource and project, plus its notes, time entries, attachment metadata and (opt-in) histories — every part separately reported.",
|
|
@@ -92891,7 +93707,7 @@ const CAPABILITY_DATA = {
|
|
|
92891
93707
|
"preset": "retry-ffb3a9cb"
|
|
92892
93708
|
},
|
|
92893
93709
|
"errors": {
|
|
92894
|
-
"set":
|
|
93710
|
+
"set": 16
|
|
92895
93711
|
},
|
|
92896
93712
|
"metadata": {
|
|
92897
93713
|
"purpose": "Get a ticket with its primary context records in one call.",
|
|
@@ -93210,7 +94026,7 @@ const CAPABILITY_DATA = {
|
|
|
93210
94026
|
"preset": "retry-ffb3a9cb"
|
|
93211
94027
|
},
|
|
93212
94028
|
"errors": {
|
|
93213
|
-
"set":
|
|
94029
|
+
"set": 17
|
|
93214
94030
|
},
|
|
93215
94031
|
"metadata": {
|
|
93216
94032
|
"purpose": "Get the full Line of Business chain for one ticket in a single call: the association, the OrganizationalLevel2 (the customizable 'Line of Business' label) and the OrganizationalLevel1 (the division).",
|
|
@@ -93648,7 +94464,7 @@ const CAPABILITY_DATA = {
|
|
|
93648
94464
|
"preset": "retry-ffb3a9cb"
|
|
93649
94465
|
},
|
|
93650
94466
|
"errors": {
|
|
93651
|
-
"set":
|
|
94467
|
+
"set": 16
|
|
93652
94468
|
},
|
|
93653
94469
|
"metadata": {
|
|
93654
94470
|
"purpose": "Run the SLA health check for a ticket (numeric ticket id).",
|
|
@@ -93843,7 +94659,7 @@ const CAPABILITY_DATA = {
|
|
|
93843
94659
|
"preset": "retry-ffb3a9cb"
|
|
93844
94660
|
},
|
|
93845
94661
|
"errors": {
|
|
93846
|
-
"set":
|
|
94662
|
+
"set": 16
|
|
93847
94663
|
},
|
|
93848
94664
|
"metadata": {
|
|
93849
94665
|
"purpose": "Get a one-call summary of a ticket (numeric ticket id).",
|
|
@@ -93953,7 +94769,7 @@ const CAPABILITY_DATA = {
|
|
|
93953
94769
|
"preset": "retry-ffb3a9cb"
|
|
93954
94770
|
},
|
|
93955
94771
|
"errors": {
|
|
93956
|
-
"set":
|
|
94772
|
+
"set": 16
|
|
93957
94773
|
},
|
|
93958
94774
|
"metadata": {
|
|
93959
94775
|
"purpose": "Get the event timeline of a ticket (numeric ticket id).",
|
|
@@ -94104,8 +94920,8 @@ const CAPABILITY_DATA = {
|
|
|
94104
94920
|
]
|
|
94105
94921
|
},
|
|
94106
94922
|
"operations": {
|
|
94107
|
-
"planHash": "
|
|
94108
|
-
"builtAt": "2026-11-
|
|
94923
|
+
"planHash": "51888554f455b96e13c50591342fa516b095065762430b783201ac7a995a0901",
|
|
94924
|
+
"builtAt": "2026-11-22T07:17:16.330Z",
|
|
94109
94925
|
"records": [
|
|
94110
94926
|
{
|
|
94111
94927
|
"id": "operations.aggregate",
|
|
@@ -94324,6 +95140,7 @@ const CAPABILITY_DATA = {
|
|
|
94324
95140
|
"timeFormat",
|
|
94325
95141
|
"timeZone",
|
|
94326
95142
|
"title",
|
|
95143
|
+
"travelAvailability",
|
|
94327
95144
|
"travelAvailabilityPct",
|
|
94328
95145
|
"userName",
|
|
94329
95146
|
"valueForDisplay",
|
|
@@ -94516,7 +95333,7 @@ const CAPABILITY_DATA = {
|
|
|
94516
95333
|
"preset": "retry-ffb3a9cb"
|
|
94517
95334
|
},
|
|
94518
95335
|
"errors": {
|
|
94519
|
-
"set":
|
|
95336
|
+
"set": 17
|
|
94520
95337
|
},
|
|
94521
95338
|
"metadata": {
|
|
94522
95339
|
"purpose": "Resolve resource ids to display names in one opt-in call: per-id resources.get reads (never an id-in query) with blind-marked rows for ids the API user cannot resolve served from the read cache (each distinct id fetched at most once per cache lifetime).",
|
|
@@ -94568,7 +95385,7 @@ const CAPABILITY_DATA = {
|
|
|
94568
95385
|
"preset": "retry-ffb3a9cb"
|
|
94569
95386
|
},
|
|
94570
95387
|
"errors": {
|
|
94571
|
-
"set":
|
|
95388
|
+
"set": 17
|
|
94572
95389
|
},
|
|
94573
95390
|
"metadata": {
|
|
94574
95391
|
"purpose": "Fetch up to 500 single records by id across mixed resources in one call (query-first chunked id-in reads with a per-id get fallback), with per-item typed results.",
|
|
@@ -94704,6 +95521,7 @@ const CAPABILITY_DATA = {
|
|
|
94704
95521
|
"timeFormat",
|
|
94705
95522
|
"timeZone",
|
|
94706
95523
|
"title",
|
|
95524
|
+
"travelAvailability",
|
|
94707
95525
|
"travelAvailabilityPct",
|
|
94708
95526
|
"userName",
|
|
94709
95527
|
"valueForDisplay",
|
|
@@ -95360,6 +96178,7 @@ const CAPABILITY_DATA = {
|
|
|
95360
96178
|
"timeFormat",
|
|
95361
96179
|
"timeZone",
|
|
95362
96180
|
"title",
|
|
96181
|
+
"travelAvailability",
|
|
95363
96182
|
"travelAvailabilityPct",
|
|
95364
96183
|
"userName",
|
|
95365
96184
|
"valueForDisplay",
|
|
@@ -95839,6 +96658,7 @@ const CAPABILITY_DATA = {
|
|
|
95839
96658
|
"timeFormat",
|
|
95840
96659
|
"timeZone",
|
|
95841
96660
|
"title",
|
|
96661
|
+
"travelAvailability",
|
|
95842
96662
|
"travelAvailabilityPct",
|
|
95843
96663
|
"userName",
|
|
95844
96664
|
"valueForDisplay",
|