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
package/capabilities.json
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
{
|
|
2
|
-
"generatedAt": "2026-11-
|
|
2
|
+
"generatedAt": "2026-11-22T07:17:16.344Z",
|
|
3
3
|
"groups": {
|
|
4
4
|
"B": {
|
|
5
|
-
"planHash": "
|
|
6
|
-
"builtAt": "2026-11-
|
|
5
|
+
"planHash": "51888554f455b96e13c50591342fa516b095065762430b783201ac7a995a0901",
|
|
6
|
+
"builtAt": "2026-11-22T07:17:16.330Z",
|
|
7
7
|
"records": [
|
|
8
8
|
{
|
|
9
9
|
"id": "appointments.count",
|
|
@@ -22068,6 +22068,402 @@
|
|
|
22068
22068
|
"compact": null,
|
|
22069
22069
|
"status": "tested"
|
|
22070
22070
|
},
|
|
22071
|
+
{
|
|
22072
|
+
"id": "organizational_resources.count",
|
|
22073
|
+
"resource": "organizational_resources",
|
|
22074
|
+
"udfCapable": false,
|
|
22075
|
+
"operation": "count",
|
|
22076
|
+
"kind": "primitive",
|
|
22077
|
+
"endpoint": "POST /V1.0/OrganizationalResources/query/count",
|
|
22078
|
+
"effect": "read",
|
|
22079
|
+
"flags": [],
|
|
22080
|
+
"dryRun": false,
|
|
22081
|
+
"envelope": "QueryCountResultModel",
|
|
22082
|
+
"inputSchema": {
|
|
22083
|
+
"params": {
|
|
22084
|
+
"type": "object",
|
|
22085
|
+
"required": false,
|
|
22086
|
+
"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.",
|
|
22087
|
+
"properties": [
|
|
22088
|
+
{
|
|
22089
|
+
"name": "filter",
|
|
22090
|
+
"type": "FilterCondition[]",
|
|
22091
|
+
"optional": true
|
|
22092
|
+
},
|
|
22093
|
+
{
|
|
22094
|
+
"name": "fieldCheck",
|
|
22095
|
+
"type": "boolean",
|
|
22096
|
+
"optional": true
|
|
22097
|
+
}
|
|
22098
|
+
]
|
|
22099
|
+
}
|
|
22100
|
+
},
|
|
22101
|
+
"inputSchemaStrict": true,
|
|
22102
|
+
"outputSchema": {
|
|
22103
|
+
"type": "QueryCountResultModel",
|
|
22104
|
+
"drops": []
|
|
22105
|
+
},
|
|
22106
|
+
"examples": [
|
|
22107
|
+
"await invoke(client, 'organizational_resources.count', [{ filter: [{ field: 'organizationalLevelAssociationID', op: 'eq', value: 7 }] }])"
|
|
22108
|
+
],
|
|
22109
|
+
"permissions": "unknown",
|
|
22110
|
+
"pagination": {
|
|
22111
|
+
"mode": "none"
|
|
22112
|
+
},
|
|
22113
|
+
"resolution": null,
|
|
22114
|
+
"retry": {
|
|
22115
|
+
"preset": "retry-ffb3a9cb"
|
|
22116
|
+
},
|
|
22117
|
+
"errors": {
|
|
22118
|
+
"set": 6
|
|
22119
|
+
},
|
|
22120
|
+
"metadata": {
|
|
22121
|
+
"purpose": "Count OrganizationalResource membership records matching a JSON filter.",
|
|
22122
|
+
"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.",
|
|
22123
|
+
"preferredWhen": null,
|
|
22124
|
+
"related": [],
|
|
22125
|
+
"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."
|
|
22126
|
+
},
|
|
22127
|
+
"compact": null,
|
|
22128
|
+
"status": "tested"
|
|
22129
|
+
},
|
|
22130
|
+
{
|
|
22131
|
+
"id": "organizational_resources.get",
|
|
22132
|
+
"resource": "organizational_resources",
|
|
22133
|
+
"udfCapable": false,
|
|
22134
|
+
"operation": "get",
|
|
22135
|
+
"kind": "primitive",
|
|
22136
|
+
"endpoint": "GET /V1.0/OrganizationalResources/{id}",
|
|
22137
|
+
"effect": "read",
|
|
22138
|
+
"flags": [],
|
|
22139
|
+
"dryRun": false,
|
|
22140
|
+
"envelope": "ItemQueryResultModel[OrganizationalResourceModel,BusinessDivisionSubdivisionResource]",
|
|
22141
|
+
"inputSchema": {
|
|
22142
|
+
"id": {
|
|
22143
|
+
"type": "string | number",
|
|
22144
|
+
"required": true,
|
|
22145
|
+
"description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
|
|
22146
|
+
},
|
|
22147
|
+
"opts": {
|
|
22148
|
+
"type": "object",
|
|
22149
|
+
"required": false,
|
|
22150
|
+
"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.",
|
|
22151
|
+
"properties": [
|
|
22152
|
+
{
|
|
22153
|
+
"name": "fresh",
|
|
22154
|
+
"type": "boolean",
|
|
22155
|
+
"optional": true
|
|
22156
|
+
}
|
|
22157
|
+
]
|
|
22158
|
+
}
|
|
22159
|
+
},
|
|
22160
|
+
"inputSchemaStrict": true,
|
|
22161
|
+
"outputSchema": {
|
|
22162
|
+
"type": "ItemQueryResultModel[OrganizationalResourceModel,BusinessDivisionSubdivisionResource]",
|
|
22163
|
+
"drops": []
|
|
22164
|
+
},
|
|
22165
|
+
"examples": [
|
|
22166
|
+
"await client.organizationalResources.get('example-value')"
|
|
22167
|
+
],
|
|
22168
|
+
"permissions": "unknown",
|
|
22169
|
+
"pagination": {
|
|
22170
|
+
"mode": "none"
|
|
22171
|
+
},
|
|
22172
|
+
"resolution": null,
|
|
22173
|
+
"retry": {
|
|
22174
|
+
"preset": "retry-ffb3a9cb"
|
|
22175
|
+
},
|
|
22176
|
+
"errors": {
|
|
22177
|
+
"set": 3
|
|
22178
|
+
},
|
|
22179
|
+
"metadata": {
|
|
22180
|
+
"purpose": "Get one OrganizationalResource by id.",
|
|
22181
|
+
"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.",
|
|
22182
|
+
"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.",
|
|
22183
|
+
"related": [],
|
|
22184
|
+
"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."
|
|
22185
|
+
},
|
|
22186
|
+
"compact": null,
|
|
22187
|
+
"status": "tested"
|
|
22188
|
+
},
|
|
22189
|
+
{
|
|
22190
|
+
"id": "organizational_resources.getEntityInfo",
|
|
22191
|
+
"resource": "organizational_resources",
|
|
22192
|
+
"udfCapable": false,
|
|
22193
|
+
"operation": "getEntityInfo",
|
|
22194
|
+
"kind": "primitive",
|
|
22195
|
+
"endpoint": "GET /V1.0/OrganizationalResources/entityInformation",
|
|
22196
|
+
"effect": "read",
|
|
22197
|
+
"flags": [],
|
|
22198
|
+
"dryRun": false,
|
|
22199
|
+
"envelope": "EntityInformationResultModel",
|
|
22200
|
+
"inputSchema": {},
|
|
22201
|
+
"inputSchemaStrict": true,
|
|
22202
|
+
"outputSchema": {
|
|
22203
|
+
"type": "EntityInformationResultModel",
|
|
22204
|
+
"drops": []
|
|
22205
|
+
},
|
|
22206
|
+
"examples": [
|
|
22207
|
+
"await client.organizationalResources.getEntityInfo()"
|
|
22208
|
+
],
|
|
22209
|
+
"permissions": "unknown",
|
|
22210
|
+
"pagination": {
|
|
22211
|
+
"mode": "none"
|
|
22212
|
+
},
|
|
22213
|
+
"resolution": null,
|
|
22214
|
+
"retry": {
|
|
22215
|
+
"preset": "retry-ffb3a9cb"
|
|
22216
|
+
},
|
|
22217
|
+
"errors": {
|
|
22218
|
+
"set": 6
|
|
22219
|
+
},
|
|
22220
|
+
"metadata": {
|
|
22221
|
+
"purpose": "Get the OrganizationalResource capability metadata (canCreate/canUpdate/hasUserDefinedFields/...).",
|
|
22222
|
+
"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.",
|
|
22223
|
+
"preferredWhen": null,
|
|
22224
|
+
"related": []
|
|
22225
|
+
},
|
|
22226
|
+
"compact": null,
|
|
22227
|
+
"status": "tested"
|
|
22228
|
+
},
|
|
22229
|
+
{
|
|
22230
|
+
"id": "organizational_resources.getFieldInfo",
|
|
22231
|
+
"resource": "organizational_resources",
|
|
22232
|
+
"udfCapable": false,
|
|
22233
|
+
"operation": "getFieldInfo",
|
|
22234
|
+
"kind": "primitive",
|
|
22235
|
+
"endpoint": "GET /V1.0/OrganizationalResources/entityInformation/fields",
|
|
22236
|
+
"effect": "read",
|
|
22237
|
+
"flags": [],
|
|
22238
|
+
"dryRun": false,
|
|
22239
|
+
"envelope": "FieldInformationResultModel",
|
|
22240
|
+
"inputSchema": {},
|
|
22241
|
+
"inputSchemaStrict": true,
|
|
22242
|
+
"outputSchema": {
|
|
22243
|
+
"type": "FieldInformationResultModel",
|
|
22244
|
+
"drops": []
|
|
22245
|
+
},
|
|
22246
|
+
"examples": [
|
|
22247
|
+
"await client.organizationalResources.getFieldInfo()"
|
|
22248
|
+
],
|
|
22249
|
+
"permissions": "unknown",
|
|
22250
|
+
"pagination": {
|
|
22251
|
+
"mode": "none"
|
|
22252
|
+
},
|
|
22253
|
+
"resolution": null,
|
|
22254
|
+
"retry": {
|
|
22255
|
+
"preset": "retry-ffb3a9cb"
|
|
22256
|
+
},
|
|
22257
|
+
"errors": {
|
|
22258
|
+
"set": 6
|
|
22259
|
+
},
|
|
22260
|
+
"metadata": {
|
|
22261
|
+
"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).",
|
|
22262
|
+
"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.",
|
|
22263
|
+
"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.",
|
|
22264
|
+
"related": []
|
|
22265
|
+
},
|
|
22266
|
+
"compact": null,
|
|
22267
|
+
"status": "tested"
|
|
22268
|
+
},
|
|
22269
|
+
{
|
|
22270
|
+
"id": "organizational_resources.getUdfInfo",
|
|
22271
|
+
"resource": "organizational_resources",
|
|
22272
|
+
"udfCapable": false,
|
|
22273
|
+
"operation": "getUdfInfo",
|
|
22274
|
+
"kind": "primitive",
|
|
22275
|
+
"endpoint": "GET /V1.0/OrganizationalResources/entityInformation/userDefinedFields",
|
|
22276
|
+
"effect": "read",
|
|
22277
|
+
"flags": [],
|
|
22278
|
+
"dryRun": false,
|
|
22279
|
+
"envelope": "UserDefinedFieldInformationResultModel",
|
|
22280
|
+
"inputSchema": {},
|
|
22281
|
+
"inputSchemaStrict": true,
|
|
22282
|
+
"outputSchema": {
|
|
22283
|
+
"type": "UserDefinedFieldInformationResultModel",
|
|
22284
|
+
"drops": []
|
|
22285
|
+
},
|
|
22286
|
+
"examples": [
|
|
22287
|
+
"await client.organizationalResources.getUdfInfo()"
|
|
22288
|
+
],
|
|
22289
|
+
"permissions": "unknown",
|
|
22290
|
+
"pagination": {
|
|
22291
|
+
"mode": "none"
|
|
22292
|
+
},
|
|
22293
|
+
"resolution": null,
|
|
22294
|
+
"retry": {
|
|
22295
|
+
"preset": "retry-ffb3a9cb"
|
|
22296
|
+
},
|
|
22297
|
+
"errors": {
|
|
22298
|
+
"set": 6
|
|
22299
|
+
},
|
|
22300
|
+
"metadata": {
|
|
22301
|
+
"purpose": "Get the OrganizationalResource user-defined-field catalog.",
|
|
22302
|
+
"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.",
|
|
22303
|
+
"preferredWhen": null,
|
|
22304
|
+
"related": []
|
|
22305
|
+
},
|
|
22306
|
+
"compact": null,
|
|
22307
|
+
"status": "tested"
|
|
22308
|
+
},
|
|
22309
|
+
{
|
|
22310
|
+
"id": "organizational_resources.listByParent",
|
|
22311
|
+
"resource": "organizational_resources",
|
|
22312
|
+
"udfCapable": false,
|
|
22313
|
+
"operation": "listByParent",
|
|
22314
|
+
"kind": "primitive",
|
|
22315
|
+
"endpoint": "GET /V1.0/OrganizationalLevelAssociations/{parentId}/Resources",
|
|
22316
|
+
"effect": "read",
|
|
22317
|
+
"flags": [],
|
|
22318
|
+
"dryRun": false,
|
|
22319
|
+
"envelope": "QueryActionResult[OrganizationalResourceModel,BusinessDivisionSubdivisionResource]",
|
|
22320
|
+
"inputSchema": {
|
|
22321
|
+
"parentId": {
|
|
22322
|
+
"type": "string | number",
|
|
22323
|
+
"required": true,
|
|
22324
|
+
"description": "The documented parent route id; no filter, limit, or caller cursor is accepted."
|
|
22325
|
+
}
|
|
22326
|
+
},
|
|
22327
|
+
"inputSchemaStrict": true,
|
|
22328
|
+
"outputSchema": {
|
|
22329
|
+
"type": "QueryActionResult[OrganizationalResourceModel,BusinessDivisionSubdivisionResource]",
|
|
22330
|
+
"drops": []
|
|
22331
|
+
},
|
|
22332
|
+
"examples": [
|
|
22333
|
+
"await invoke(client, 'organizational_resources.listByParent', [7])"
|
|
22334
|
+
],
|
|
22335
|
+
"permissions": "unknown",
|
|
22336
|
+
"pagination": {
|
|
22337
|
+
"mode": "none"
|
|
22338
|
+
},
|
|
22339
|
+
"resolution": null,
|
|
22340
|
+
"retry": {
|
|
22341
|
+
"preset": "retry-ffb3a9cb"
|
|
22342
|
+
},
|
|
22343
|
+
"errors": {
|
|
22344
|
+
"set": 11
|
|
22345
|
+
},
|
|
22346
|
+
"metadata": {
|
|
22347
|
+
"purpose": "Read one native parent-scoped staff-association page.",
|
|
22348
|
+
"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.",
|
|
22349
|
+
"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.",
|
|
22350
|
+
"preferredWhen": "Use when the documented native parent collection is required; global get remains single-record-id only.",
|
|
22351
|
+
"related": [
|
|
22352
|
+
"organizational_resources.query",
|
|
22353
|
+
"organizational_resources.get"
|
|
22354
|
+
]
|
|
22355
|
+
},
|
|
22356
|
+
"compact": null,
|
|
22357
|
+
"status": "tested"
|
|
22358
|
+
},
|
|
22359
|
+
{
|
|
22360
|
+
"id": "organizational_resources.query",
|
|
22361
|
+
"resource": "organizational_resources",
|
|
22362
|
+
"udfCapable": false,
|
|
22363
|
+
"operation": "query",
|
|
22364
|
+
"kind": "primitive",
|
|
22365
|
+
"endpoint": "GET|POST /V1.0/OrganizationalResources/query",
|
|
22366
|
+
"effect": "read",
|
|
22367
|
+
"flags": [],
|
|
22368
|
+
"dryRun": false,
|
|
22369
|
+
"envelope": "QueryActionResult[OrganizationalResourceModel,BusinessDivisionSubdivisionResource]",
|
|
22370
|
+
"inputSchema": {
|
|
22371
|
+
"params": {
|
|
22372
|
+
"type": "object",
|
|
22373
|
+
"required": false,
|
|
22374
|
+
"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.",
|
|
22375
|
+
"properties": [
|
|
22376
|
+
{
|
|
22377
|
+
"name": "filter",
|
|
22378
|
+
"type": "FilterCondition[]",
|
|
22379
|
+
"optional": true
|
|
22380
|
+
},
|
|
22381
|
+
{
|
|
22382
|
+
"name": "limit",
|
|
22383
|
+
"type": "number",
|
|
22384
|
+
"optional": true,
|
|
22385
|
+
"default": 500
|
|
22386
|
+
},
|
|
22387
|
+
{
|
|
22388
|
+
"name": "latest",
|
|
22389
|
+
"type": "number",
|
|
22390
|
+
"optional": true
|
|
22391
|
+
},
|
|
22392
|
+
{
|
|
22393
|
+
"name": "noteChars",
|
|
22394
|
+
"type": "number",
|
|
22395
|
+
"optional": true
|
|
22396
|
+
},
|
|
22397
|
+
{
|
|
22398
|
+
"name": "includeFields",
|
|
22399
|
+
"type": "string[]",
|
|
22400
|
+
"optional": true
|
|
22401
|
+
},
|
|
22402
|
+
{
|
|
22403
|
+
"name": "fieldCheck",
|
|
22404
|
+
"type": "boolean",
|
|
22405
|
+
"optional": true,
|
|
22406
|
+
"default": true
|
|
22407
|
+
},
|
|
22408
|
+
{
|
|
22409
|
+
"name": "names",
|
|
22410
|
+
"type": "boolean",
|
|
22411
|
+
"optional": true
|
|
22412
|
+
},
|
|
22413
|
+
{
|
|
22414
|
+
"name": "via",
|
|
22415
|
+
"type": "\"post\" | \"get\"",
|
|
22416
|
+
"optional": true
|
|
22417
|
+
},
|
|
22418
|
+
{
|
|
22419
|
+
"name": "acknowledgeUnscoped",
|
|
22420
|
+
"type": "boolean",
|
|
22421
|
+
"optional": true
|
|
22422
|
+
},
|
|
22423
|
+
{
|
|
22424
|
+
"name": "walk",
|
|
22425
|
+
"type": "object",
|
|
22426
|
+
"optional": true
|
|
22427
|
+
}
|
|
22428
|
+
]
|
|
22429
|
+
}
|
|
22430
|
+
},
|
|
22431
|
+
"inputSchemaStrict": true,
|
|
22432
|
+
"outputSchema": {
|
|
22433
|
+
"type": "QueryActionResult[OrganizationalResourceModel,BusinessDivisionSubdivisionResource]",
|
|
22434
|
+
"drops": []
|
|
22435
|
+
},
|
|
22436
|
+
"examples": [
|
|
22437
|
+
"await invoke(client, 'organizational_resources.query', [{ filter: [{ field: 'organizationalLevelAssociationID', op: 'eq', value: 7 }], limit: 25 }])"
|
|
22438
|
+
],
|
|
22439
|
+
"permissions": "unknown",
|
|
22440
|
+
"pagination": {
|
|
22441
|
+
"mode": "cursor",
|
|
22442
|
+
"vendorDefault": 10,
|
|
22443
|
+
"vendorMax": 500,
|
|
22444
|
+
"pageGuard": 1000,
|
|
22445
|
+
"queryBounded": {
|
|
22446
|
+
"default": 500,
|
|
22447
|
+
"max": 2500
|
|
22448
|
+
}
|
|
22449
|
+
},
|
|
22450
|
+
"resolution": null,
|
|
22451
|
+
"retry": {
|
|
22452
|
+
"preset": "retry-ffb3a9cb"
|
|
22453
|
+
},
|
|
22454
|
+
"errors": {
|
|
22455
|
+
"set": 11
|
|
22456
|
+
},
|
|
22457
|
+
"metadata": {
|
|
22458
|
+
"purpose": "Query OrganizationalResource records with a JSON filter.",
|
|
22459
|
+
"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.",
|
|
22460
|
+
"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).",
|
|
22461
|
+
"related": [],
|
|
22462
|
+
"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."
|
|
22463
|
+
},
|
|
22464
|
+
"compact": null,
|
|
22465
|
+
"status": "tested"
|
|
22466
|
+
},
|
|
22071
22467
|
{
|
|
22072
22468
|
"id": "product_vendors.count",
|
|
22073
22469
|
"resource": "product_vendors",
|
|
@@ -26197,7 +26593,483 @@
|
|
|
26197
26593
|
"drops": []
|
|
26198
26594
|
},
|
|
26199
26595
|
"examples": [
|
|
26200
|
-
"await invoke(client, 'resource_attachments.count', [{ filter: [{ field: 'resourceID', op: 'eq', value: 7 }] }])"
|
|
26596
|
+
"await invoke(client, 'resource_attachments.count', [{ filter: [{ field: 'resourceID', op: 'eq', value: 7 }] }])"
|
|
26597
|
+
],
|
|
26598
|
+
"permissions": "unknown",
|
|
26599
|
+
"pagination": {
|
|
26600
|
+
"mode": "none"
|
|
26601
|
+
},
|
|
26602
|
+
"resolution": null,
|
|
26603
|
+
"retry": {
|
|
26604
|
+
"preset": "retry-ffb3a9cb"
|
|
26605
|
+
},
|
|
26606
|
+
"errors": {
|
|
26607
|
+
"set": 0
|
|
26608
|
+
},
|
|
26609
|
+
"metadata": {
|
|
26610
|
+
"purpose": "Count resource attachment records matching a JSON filter. Use resourceID for parent scope.",
|
|
26611
|
+
"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.",
|
|
26612
|
+
"preferredWhen": null,
|
|
26613
|
+
"related": [
|
|
26614
|
+
"resource_attachments.query"
|
|
26615
|
+
],
|
|
26616
|
+
"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.",
|
|
26617
|
+
"untrustedFields": [
|
|
26618
|
+
"title"
|
|
26619
|
+
]
|
|
26620
|
+
},
|
|
26621
|
+
"compact": null,
|
|
26622
|
+
"status": "tested"
|
|
26623
|
+
},
|
|
26624
|
+
{
|
|
26625
|
+
"id": "resource_attachments.create",
|
|
26626
|
+
"resource": "resource_attachments",
|
|
26627
|
+
"udfCapable": false,
|
|
26628
|
+
"operation": "create",
|
|
26629
|
+
"kind": "primitive",
|
|
26630
|
+
"endpoint": "POST /V1.0/Resources/{parentId}/Attachments",
|
|
26631
|
+
"effect": "write",
|
|
26632
|
+
"flags": [],
|
|
26633
|
+
"dryRun": true,
|
|
26634
|
+
"envelope": "OperationResultModel",
|
|
26635
|
+
"inputSchema": {
|
|
26636
|
+
"parentId": {
|
|
26637
|
+
"type": "string | number",
|
|
26638
|
+
"required": true,
|
|
26639
|
+
"description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
|
|
26640
|
+
},
|
|
26641
|
+
"data": {
|
|
26642
|
+
"type": "object",
|
|
26643
|
+
"required": true,
|
|
26644
|
+
"description": "The record payload (vendor model fields)."
|
|
26645
|
+
}
|
|
26646
|
+
},
|
|
26647
|
+
"inputSchemaStrict": true,
|
|
26648
|
+
"outputSchema": {
|
|
26649
|
+
"type": "OperationResultModel",
|
|
26650
|
+
"drops": []
|
|
26651
|
+
},
|
|
26652
|
+
"examples": [
|
|
26653
|
+
"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 });"
|
|
26654
|
+
],
|
|
26655
|
+
"permissions": "unknown",
|
|
26656
|
+
"pagination": {
|
|
26657
|
+
"mode": "none"
|
|
26658
|
+
},
|
|
26659
|
+
"resolution": null,
|
|
26660
|
+
"retry": {
|
|
26661
|
+
"preset": "retry-c5657094"
|
|
26662
|
+
},
|
|
26663
|
+
"errors": {
|
|
26664
|
+
"set": 1
|
|
26665
|
+
},
|
|
26666
|
+
"metadata": {
|
|
26667
|
+
"purpose": "Create a file attachment under a resource.",
|
|
26668
|
+
"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.",
|
|
26669
|
+
"preferredWhen": "Add a new attachment; existing attachments cannot be updated. Replace through separately governed delete and create actions.",
|
|
26670
|
+
"related": [
|
|
26671
|
+
"resource_attachments.get"
|
|
26672
|
+
],
|
|
26673
|
+
"argNotes": {
|
|
26674
|
+
"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."
|
|
26675
|
+
},
|
|
26676
|
+
"untrustedFields": [
|
|
26677
|
+
"title"
|
|
26678
|
+
],
|
|
26679
|
+
"createRequirements": {
|
|
26680
|
+
"requires": {
|
|
26681
|
+
"allOf": [
|
|
26682
|
+
"attachmentType",
|
|
26683
|
+
"fullPath",
|
|
26684
|
+
"title",
|
|
26685
|
+
"publish",
|
|
26686
|
+
"data"
|
|
26687
|
+
]
|
|
26688
|
+
},
|
|
26689
|
+
"requiresByValue": [
|
|
26690
|
+
{
|
|
26691
|
+
"field": "attachmentType",
|
|
26692
|
+
"value": "FILE_ATTACHMENT",
|
|
26693
|
+
"requires": {
|
|
26694
|
+
"allOf": [
|
|
26695
|
+
"data"
|
|
26696
|
+
]
|
|
26697
|
+
}
|
|
26698
|
+
}
|
|
26699
|
+
]
|
|
26700
|
+
}
|
|
26701
|
+
},
|
|
26702
|
+
"compact": null,
|
|
26703
|
+
"status": "tested"
|
|
26704
|
+
},
|
|
26705
|
+
{
|
|
26706
|
+
"id": "resource_attachments.delete",
|
|
26707
|
+
"resource": "resource_attachments",
|
|
26708
|
+
"udfCapable": false,
|
|
26709
|
+
"operation": "delete",
|
|
26710
|
+
"kind": "primitive",
|
|
26711
|
+
"endpoint": "DELETE /V1.0/Resources/{parentId}/Attachments/{id}",
|
|
26712
|
+
"effect": "destructive",
|
|
26713
|
+
"flags": [
|
|
26714
|
+
"idempotent",
|
|
26715
|
+
"requiresApproval"
|
|
26716
|
+
],
|
|
26717
|
+
"dryRun": true,
|
|
26718
|
+
"envelope": "OperationResultModel (attachment entities: the deleted attachment model is returned, not OperationResultModel)",
|
|
26719
|
+
"inputSchema": {
|
|
26720
|
+
"parentId": {
|
|
26721
|
+
"type": "string | number",
|
|
26722
|
+
"required": true,
|
|
26723
|
+
"description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
|
|
26724
|
+
},
|
|
26725
|
+
"id": {
|
|
26726
|
+
"type": "string | number",
|
|
26727
|
+
"required": true,
|
|
26728
|
+
"description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
|
|
26729
|
+
}
|
|
26730
|
+
},
|
|
26731
|
+
"inputSchemaStrict": true,
|
|
26732
|
+
"outputSchema": {
|
|
26733
|
+
"type": "OperationResultModel (attachment entities: the deleted attachment model is returned, not OperationResultModel)",
|
|
26734
|
+
"drops": []
|
|
26735
|
+
},
|
|
26736
|
+
"examples": [
|
|
26737
|
+
"await invoke(client, 'resource_attachments.delete', [7, 3], { confirm: 'resource_attachments.delete' })"
|
|
26738
|
+
],
|
|
26739
|
+
"permissions": "unknown",
|
|
26740
|
+
"pagination": {
|
|
26741
|
+
"mode": "none"
|
|
26742
|
+
},
|
|
26743
|
+
"resolution": null,
|
|
26744
|
+
"retry": {
|
|
26745
|
+
"preset": "retry-1849870d"
|
|
26746
|
+
},
|
|
26747
|
+
"errors": {
|
|
26748
|
+
"set": 2
|
|
26749
|
+
},
|
|
26750
|
+
"metadata": {
|
|
26751
|
+
"purpose": "Delete an attachment under a resource.",
|
|
26752
|
+
"usage": "Irreversible; dry-run validates the target id first. Parent-scoped: parentId + id.",
|
|
26753
|
+
"preferredWhen": null,
|
|
26754
|
+
"related": [
|
|
26755
|
+
"resource_attachments.get"
|
|
26756
|
+
],
|
|
26757
|
+
"untrustedFields": [
|
|
26758
|
+
"title"
|
|
26759
|
+
]
|
|
26760
|
+
},
|
|
26761
|
+
"compact": null,
|
|
26762
|
+
"status": "tested"
|
|
26763
|
+
},
|
|
26764
|
+
{
|
|
26765
|
+
"id": "resource_attachments.get",
|
|
26766
|
+
"resource": "resource_attachments",
|
|
26767
|
+
"udfCapable": false,
|
|
26768
|
+
"operation": "get",
|
|
26769
|
+
"kind": "primitive",
|
|
26770
|
+
"endpoint": "GET /V1.0/Resources/{parentId}/Attachments/{id}",
|
|
26771
|
+
"effect": "read",
|
|
26772
|
+
"flags": [],
|
|
26773
|
+
"dryRun": false,
|
|
26774
|
+
"envelope": "ResourceAttachmentModel",
|
|
26775
|
+
"inputSchema": {
|
|
26776
|
+
"parentId": {
|
|
26777
|
+
"type": "string | number",
|
|
26778
|
+
"required": true,
|
|
26779
|
+
"description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
|
|
26780
|
+
},
|
|
26781
|
+
"id": {
|
|
26782
|
+
"type": "string | number",
|
|
26783
|
+
"required": true,
|
|
26784
|
+
"description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
|
|
26785
|
+
},
|
|
26786
|
+
"opts": {
|
|
26787
|
+
"type": "object",
|
|
26788
|
+
"required": false,
|
|
26789
|
+
"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.",
|
|
26790
|
+
"properties": [
|
|
26791
|
+
{
|
|
26792
|
+
"name": "fresh",
|
|
26793
|
+
"type": "boolean",
|
|
26794
|
+
"optional": true
|
|
26795
|
+
}
|
|
26796
|
+
]
|
|
26797
|
+
}
|
|
26798
|
+
},
|
|
26799
|
+
"inputSchemaStrict": true,
|
|
26800
|
+
"outputSchema": {
|
|
26801
|
+
"type": "ResourceAttachmentModel",
|
|
26802
|
+
"drops": []
|
|
26803
|
+
},
|
|
26804
|
+
"examples": [
|
|
26805
|
+
"await client.resourceAttachments.get(7, 3)"
|
|
26806
|
+
],
|
|
26807
|
+
"permissions": "unknown",
|
|
26808
|
+
"pagination": {
|
|
26809
|
+
"mode": "none"
|
|
26810
|
+
},
|
|
26811
|
+
"resolution": null,
|
|
26812
|
+
"retry": {
|
|
26813
|
+
"preset": "retry-ffb3a9cb"
|
|
26814
|
+
},
|
|
26815
|
+
"errors": {
|
|
26816
|
+
"set": 3
|
|
26817
|
+
},
|
|
26818
|
+
"metadata": {
|
|
26819
|
+
"purpose": "Get one ResourceAttachment by id.",
|
|
26820
|
+
"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.",
|
|
26821
|
+
"preferredWhen": "Use a known attachment id; query the scoped collection to discover ids.",
|
|
26822
|
+
"related": [
|
|
26823
|
+
"resource_attachments.query"
|
|
26824
|
+
],
|
|
26825
|
+
"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.",
|
|
26826
|
+
"untrustedFields": [
|
|
26827
|
+
"title"
|
|
26828
|
+
]
|
|
26829
|
+
},
|
|
26830
|
+
"compact": null,
|
|
26831
|
+
"status": "tested"
|
|
26832
|
+
},
|
|
26833
|
+
{
|
|
26834
|
+
"id": "resource_attachments.getEntityInfo",
|
|
26835
|
+
"resource": "resource_attachments",
|
|
26836
|
+
"udfCapable": false,
|
|
26837
|
+
"operation": "getEntityInfo",
|
|
26838
|
+
"kind": "primitive",
|
|
26839
|
+
"endpoint": "GET /V1.0/ResourceAttachments/entityInformation",
|
|
26840
|
+
"effect": "read",
|
|
26841
|
+
"flags": [],
|
|
26842
|
+
"dryRun": false,
|
|
26843
|
+
"envelope": "EntityInformationResultModel",
|
|
26844
|
+
"inputSchema": {},
|
|
26845
|
+
"inputSchemaStrict": true,
|
|
26846
|
+
"outputSchema": {
|
|
26847
|
+
"type": "EntityInformationResultModel",
|
|
26848
|
+
"drops": []
|
|
26849
|
+
},
|
|
26850
|
+
"examples": [
|
|
26851
|
+
"await client.resourceAttachments.getEntityInfo()"
|
|
26852
|
+
],
|
|
26853
|
+
"permissions": "unknown",
|
|
26854
|
+
"pagination": {
|
|
26855
|
+
"mode": "none"
|
|
26856
|
+
},
|
|
26857
|
+
"resolution": null,
|
|
26858
|
+
"retry": {
|
|
26859
|
+
"preset": "retry-ffb3a9cb"
|
|
26860
|
+
},
|
|
26861
|
+
"errors": {
|
|
26862
|
+
"set": 0
|
|
26863
|
+
},
|
|
26864
|
+
"metadata": {
|
|
26865
|
+
"purpose": "Get the ResourceAttachment capability metadata (canCreate/canUpdate/hasUserDefinedFields/...).",
|
|
26866
|
+
"usage": "Unwraps info{}; drives client-side capability checks.",
|
|
26867
|
+
"preferredWhen": null,
|
|
26868
|
+
"related": [
|
|
26869
|
+
"resource_attachments.getFieldInfo"
|
|
26870
|
+
],
|
|
26871
|
+
"untrustedFields": [
|
|
26872
|
+
"title"
|
|
26873
|
+
]
|
|
26874
|
+
},
|
|
26875
|
+
"compact": null,
|
|
26876
|
+
"status": "tested"
|
|
26877
|
+
},
|
|
26878
|
+
{
|
|
26879
|
+
"id": "resource_attachments.getFieldInfo",
|
|
26880
|
+
"resource": "resource_attachments",
|
|
26881
|
+
"udfCapable": false,
|
|
26882
|
+
"operation": "getFieldInfo",
|
|
26883
|
+
"kind": "primitive",
|
|
26884
|
+
"endpoint": "GET /V1.0/ResourceAttachments/entityInformation/fields",
|
|
26885
|
+
"effect": "read",
|
|
26886
|
+
"flags": [],
|
|
26887
|
+
"dryRun": false,
|
|
26888
|
+
"envelope": "FieldInformationResultModel",
|
|
26889
|
+
"inputSchema": {},
|
|
26890
|
+
"inputSchemaStrict": true,
|
|
26891
|
+
"outputSchema": {
|
|
26892
|
+
"type": "FieldInformationResultModel",
|
|
26893
|
+
"drops": []
|
|
26894
|
+
},
|
|
26895
|
+
"examples": [
|
|
26896
|
+
"await client.resourceAttachments.getFieldInfo()"
|
|
26897
|
+
],
|
|
26898
|
+
"permissions": "unknown",
|
|
26899
|
+
"pagination": {
|
|
26900
|
+
"mode": "none"
|
|
26901
|
+
},
|
|
26902
|
+
"resolution": null,
|
|
26903
|
+
"retry": {
|
|
26904
|
+
"preset": "retry-ffb3a9cb"
|
|
26905
|
+
},
|
|
26906
|
+
"errors": {
|
|
26907
|
+
"set": 0
|
|
26908
|
+
},
|
|
26909
|
+
"metadata": {
|
|
26910
|
+
"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).",
|
|
26911
|
+
"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.",
|
|
26912
|
+
"preferredWhen": null,
|
|
26913
|
+
"related": [
|
|
26914
|
+
"resource_attachments.getEntityInfo"
|
|
26915
|
+
],
|
|
26916
|
+
"untrustedFields": [
|
|
26917
|
+
"title"
|
|
26918
|
+
]
|
|
26919
|
+
},
|
|
26920
|
+
"compact": null,
|
|
26921
|
+
"status": "tested"
|
|
26922
|
+
},
|
|
26923
|
+
{
|
|
26924
|
+
"id": "resource_attachments.query",
|
|
26925
|
+
"resource": "resource_attachments",
|
|
26926
|
+
"udfCapable": false,
|
|
26927
|
+
"operation": "query",
|
|
26928
|
+
"kind": "primitive",
|
|
26929
|
+
"endpoint": "GET|POST /V1.0/ResourceAttachments/query",
|
|
26930
|
+
"effect": "read",
|
|
26931
|
+
"flags": [],
|
|
26932
|
+
"dryRun": false,
|
|
26933
|
+
"envelope": "QueryActionResult[<Model>,<Entity>]",
|
|
26934
|
+
"inputSchema": {
|
|
26935
|
+
"params": {
|
|
26936
|
+
"type": "object",
|
|
26937
|
+
"required": false,
|
|
26938
|
+
"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.",
|
|
26939
|
+
"properties": [
|
|
26940
|
+
{
|
|
26941
|
+
"name": "filter",
|
|
26942
|
+
"type": "FilterCondition[]",
|
|
26943
|
+
"optional": true
|
|
26944
|
+
},
|
|
26945
|
+
{
|
|
26946
|
+
"name": "limit",
|
|
26947
|
+
"type": "number",
|
|
26948
|
+
"optional": true,
|
|
26949
|
+
"default": 500
|
|
26950
|
+
},
|
|
26951
|
+
{
|
|
26952
|
+
"name": "latest",
|
|
26953
|
+
"type": "number",
|
|
26954
|
+
"optional": true
|
|
26955
|
+
},
|
|
26956
|
+
{
|
|
26957
|
+
"name": "noteChars",
|
|
26958
|
+
"type": "number",
|
|
26959
|
+
"optional": true
|
|
26960
|
+
},
|
|
26961
|
+
{
|
|
26962
|
+
"name": "includeFields",
|
|
26963
|
+
"type": "string[]",
|
|
26964
|
+
"optional": true
|
|
26965
|
+
},
|
|
26966
|
+
{
|
|
26967
|
+
"name": "fieldCheck",
|
|
26968
|
+
"type": "boolean",
|
|
26969
|
+
"optional": true,
|
|
26970
|
+
"default": true
|
|
26971
|
+
},
|
|
26972
|
+
{
|
|
26973
|
+
"name": "names",
|
|
26974
|
+
"type": "boolean",
|
|
26975
|
+
"optional": true
|
|
26976
|
+
},
|
|
26977
|
+
{
|
|
26978
|
+
"name": "via",
|
|
26979
|
+
"type": "\"post\" | \"get\"",
|
|
26980
|
+
"optional": true
|
|
26981
|
+
},
|
|
26982
|
+
{
|
|
26983
|
+
"name": "acknowledgeUnscoped",
|
|
26984
|
+
"type": "boolean",
|
|
26985
|
+
"optional": true
|
|
26986
|
+
},
|
|
26987
|
+
{
|
|
26988
|
+
"name": "walk",
|
|
26989
|
+
"type": "object",
|
|
26990
|
+
"optional": true
|
|
26991
|
+
}
|
|
26992
|
+
]
|
|
26993
|
+
}
|
|
26994
|
+
},
|
|
26995
|
+
"inputSchemaStrict": true,
|
|
26996
|
+
"outputSchema": {
|
|
26997
|
+
"type": "QueryActionResult[<Model>,<Entity>]",
|
|
26998
|
+
"drops": []
|
|
26999
|
+
},
|
|
27000
|
+
"examples": [
|
|
27001
|
+
"await invoke(client, 'resource_attachments.query', [{ filter: [{ field: 'resourceID', op: 'eq', value: 7 }], limit: 25 }])"
|
|
27002
|
+
],
|
|
27003
|
+
"permissions": "unknown",
|
|
27004
|
+
"pagination": {
|
|
27005
|
+
"mode": "cursor",
|
|
27006
|
+
"vendorDefault": 10,
|
|
27007
|
+
"vendorMax": 500,
|
|
27008
|
+
"pageGuard": 1000,
|
|
27009
|
+
"queryBounded": {
|
|
27010
|
+
"default": 500,
|
|
27011
|
+
"max": 2500
|
|
27012
|
+
}
|
|
27013
|
+
},
|
|
27014
|
+
"resolution": null,
|
|
27015
|
+
"retry": {
|
|
27016
|
+
"preset": "retry-ffb3a9cb"
|
|
27017
|
+
},
|
|
27018
|
+
"errors": {
|
|
27019
|
+
"set": 4
|
|
27020
|
+
},
|
|
27021
|
+
"metadata": {
|
|
27022
|
+
"purpose": "Query ResourceAttachment records with a JSON filter.",
|
|
27023
|
+
"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.",
|
|
27024
|
+
"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).",
|
|
27025
|
+
"related": [
|
|
27026
|
+
"resource_attachments.get"
|
|
27027
|
+
],
|
|
27028
|
+
"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.",
|
|
27029
|
+
"untrustedFields": [
|
|
27030
|
+
"title"
|
|
27031
|
+
]
|
|
27032
|
+
},
|
|
27033
|
+
"compact": null,
|
|
27034
|
+
"status": "tested"
|
|
27035
|
+
},
|
|
27036
|
+
{
|
|
27037
|
+
"id": "resource_daily_availabilities.count",
|
|
27038
|
+
"resource": "resource_daily_availabilities",
|
|
27039
|
+
"udfCapable": false,
|
|
27040
|
+
"operation": "count",
|
|
27041
|
+
"kind": "primitive",
|
|
27042
|
+
"endpoint": "POST /V1.0/ResourceDailyAvailabilities/query/count",
|
|
27043
|
+
"effect": "read",
|
|
27044
|
+
"flags": [],
|
|
27045
|
+
"dryRun": false,
|
|
27046
|
+
"envelope": "QueryCountResultModel",
|
|
27047
|
+
"inputSchema": {
|
|
27048
|
+
"params": {
|
|
27049
|
+
"type": "object",
|
|
27050
|
+
"required": false,
|
|
27051
|
+
"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.",
|
|
27052
|
+
"properties": [
|
|
27053
|
+
{
|
|
27054
|
+
"name": "filter",
|
|
27055
|
+
"type": "FilterCondition[]",
|
|
27056
|
+
"optional": true
|
|
27057
|
+
},
|
|
27058
|
+
{
|
|
27059
|
+
"name": "fieldCheck",
|
|
27060
|
+
"type": "boolean",
|
|
27061
|
+
"optional": true
|
|
27062
|
+
}
|
|
27063
|
+
]
|
|
27064
|
+
}
|
|
27065
|
+
},
|
|
27066
|
+
"inputSchemaStrict": true,
|
|
27067
|
+
"outputSchema": {
|
|
27068
|
+
"type": "QueryCountResultModel",
|
|
27069
|
+
"drops": []
|
|
27070
|
+
},
|
|
27071
|
+
"examples": [
|
|
27072
|
+
"await invoke(client, 'resource_daily_availabilities.count', [{ filter: [{ field: 'resourceID', op: 'eq', value: 7 }] }])"
|
|
26201
27073
|
],
|
|
26202
27074
|
"permissions": "unknown",
|
|
26203
27075
|
"pagination": {
|
|
@@ -26208,53 +27080,58 @@
|
|
|
26208
27080
|
"preset": "retry-ffb3a9cb"
|
|
26209
27081
|
},
|
|
26210
27082
|
"errors": {
|
|
26211
|
-
"set":
|
|
27083
|
+
"set": 6
|
|
26212
27084
|
},
|
|
26213
27085
|
"metadata": {
|
|
26214
|
-
"purpose": "Count resource
|
|
26215
|
-
"usage": "Unwraps queryCount; returns a plain number.
|
|
27086
|
+
"purpose": "Count resource daily availability records matching a JSON filter.",
|
|
27087
|
+
"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.",
|
|
26216
27088
|
"preferredWhen": null,
|
|
26217
|
-
"related": [
|
|
26218
|
-
"resource_attachments.query"
|
|
26219
|
-
],
|
|
27089
|
+
"related": [],
|
|
26220
27090
|
"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.",
|
|
26221
27091
|
"untrustedFields": [
|
|
26222
|
-
"
|
|
27092
|
+
"travelAvailability"
|
|
26223
27093
|
]
|
|
26224
27094
|
},
|
|
26225
27095
|
"compact": null,
|
|
26226
27096
|
"status": "tested"
|
|
26227
27097
|
},
|
|
26228
27098
|
{
|
|
26229
|
-
"id": "
|
|
26230
|
-
"resource": "
|
|
27099
|
+
"id": "resource_daily_availabilities.get",
|
|
27100
|
+
"resource": "resource_daily_availabilities",
|
|
26231
27101
|
"udfCapable": false,
|
|
26232
|
-
"operation": "
|
|
27102
|
+
"operation": "get",
|
|
26233
27103
|
"kind": "primitive",
|
|
26234
|
-
"endpoint": "
|
|
26235
|
-
"effect": "
|
|
27104
|
+
"endpoint": "GET /V1.0/ResourceDailyAvailabilities/{id}",
|
|
27105
|
+
"effect": "read",
|
|
26236
27106
|
"flags": [],
|
|
26237
|
-
"dryRun":
|
|
26238
|
-
"envelope": "
|
|
27107
|
+
"dryRun": false,
|
|
27108
|
+
"envelope": "ItemQueryResultModel[ResourceDailyAvailabilityModel,ResourceDailyAvailability]",
|
|
26239
27109
|
"inputSchema": {
|
|
26240
|
-
"
|
|
27110
|
+
"id": {
|
|
26241
27111
|
"type": "string | number",
|
|
26242
27112
|
"required": true,
|
|
26243
|
-
"description": "The
|
|
27113
|
+
"description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
|
|
26244
27114
|
},
|
|
26245
|
-
"
|
|
27115
|
+
"opts": {
|
|
26246
27116
|
"type": "object",
|
|
26247
|
-
"required":
|
|
26248
|
-
"description": "The
|
|
27117
|
+
"required": false,
|
|
27118
|
+
"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.",
|
|
27119
|
+
"properties": [
|
|
27120
|
+
{
|
|
27121
|
+
"name": "fresh",
|
|
27122
|
+
"type": "boolean",
|
|
27123
|
+
"optional": true
|
|
27124
|
+
}
|
|
27125
|
+
]
|
|
26249
27126
|
}
|
|
26250
27127
|
},
|
|
26251
27128
|
"inputSchemaStrict": true,
|
|
26252
27129
|
"outputSchema": {
|
|
26253
|
-
"type": "
|
|
27130
|
+
"type": "ItemQueryResultModel[ResourceDailyAvailabilityModel,ResourceDailyAvailability]",
|
|
26254
27131
|
"drops": []
|
|
26255
27132
|
},
|
|
26256
27133
|
"examples": [
|
|
26257
|
-
"
|
|
27134
|
+
"await client.resourceDailyAvailabilities.get('example-value')"
|
|
26258
27135
|
],
|
|
26259
27136
|
"permissions": "unknown",
|
|
26260
27137
|
"pagination": {
|
|
@@ -26262,83 +27139,46 @@
|
|
|
26262
27139
|
},
|
|
26263
27140
|
"resolution": null,
|
|
26264
27141
|
"retry": {
|
|
26265
|
-
"preset": "retry-
|
|
27142
|
+
"preset": "retry-ffb3a9cb"
|
|
26266
27143
|
},
|
|
26267
27144
|
"errors": {
|
|
26268
|
-
"set":
|
|
27145
|
+
"set": 3
|
|
26269
27146
|
},
|
|
26270
27147
|
"metadata": {
|
|
26271
|
-
"purpose": "
|
|
26272
|
-
"usage": "
|
|
26273
|
-
"preferredWhen": "
|
|
27148
|
+
"purpose": "Get one ResourceDailyAvailability by id.",
|
|
27149
|
+
"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.",
|
|
27150
|
+
"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.",
|
|
26274
27151
|
"related": [
|
|
26275
|
-
"
|
|
27152
|
+
"resource_daily_availabilities.query",
|
|
27153
|
+
"resource_daily_availabilities.listByParent"
|
|
26276
27154
|
],
|
|
26277
|
-
"
|
|
26278
|
-
"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."
|
|
26279
|
-
},
|
|
27155
|
+
"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.",
|
|
26280
27156
|
"untrustedFields": [
|
|
26281
|
-
"
|
|
26282
|
-
]
|
|
26283
|
-
"createRequirements": {
|
|
26284
|
-
"requires": {
|
|
26285
|
-
"allOf": [
|
|
26286
|
-
"attachmentType",
|
|
26287
|
-
"fullPath",
|
|
26288
|
-
"title",
|
|
26289
|
-
"publish",
|
|
26290
|
-
"data"
|
|
26291
|
-
]
|
|
26292
|
-
},
|
|
26293
|
-
"requiresByValue": [
|
|
26294
|
-
{
|
|
26295
|
-
"field": "attachmentType",
|
|
26296
|
-
"value": "FILE_ATTACHMENT",
|
|
26297
|
-
"requires": {
|
|
26298
|
-
"allOf": [
|
|
26299
|
-
"data"
|
|
26300
|
-
]
|
|
26301
|
-
}
|
|
26302
|
-
}
|
|
26303
|
-
]
|
|
26304
|
-
}
|
|
27157
|
+
"travelAvailability"
|
|
27158
|
+
]
|
|
26305
27159
|
},
|
|
26306
27160
|
"compact": null,
|
|
26307
27161
|
"status": "tested"
|
|
26308
27162
|
},
|
|
26309
27163
|
{
|
|
26310
|
-
"id": "
|
|
26311
|
-
"resource": "
|
|
27164
|
+
"id": "resource_daily_availabilities.getEntityInfo",
|
|
27165
|
+
"resource": "resource_daily_availabilities",
|
|
26312
27166
|
"udfCapable": false,
|
|
26313
|
-
"operation": "
|
|
27167
|
+
"operation": "getEntityInfo",
|
|
26314
27168
|
"kind": "primitive",
|
|
26315
|
-
"endpoint": "
|
|
26316
|
-
"effect": "
|
|
26317
|
-
"flags": [
|
|
26318
|
-
|
|
26319
|
-
|
|
26320
|
-
|
|
26321
|
-
"dryRun": true,
|
|
26322
|
-
"envelope": "OperationResultModel (attachment entities: the deleted attachment model is returned, not OperationResultModel)",
|
|
26323
|
-
"inputSchema": {
|
|
26324
|
-
"parentId": {
|
|
26325
|
-
"type": "string | number",
|
|
26326
|
-
"required": true,
|
|
26327
|
-
"description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
|
|
26328
|
-
},
|
|
26329
|
-
"id": {
|
|
26330
|
-
"type": "string | number",
|
|
26331
|
-
"required": true,
|
|
26332
|
-
"description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
|
|
26333
|
-
}
|
|
26334
|
-
},
|
|
27169
|
+
"endpoint": "GET /V1.0/ResourceDailyAvailabilities/entityInformation",
|
|
27170
|
+
"effect": "read",
|
|
27171
|
+
"flags": [],
|
|
27172
|
+
"dryRun": false,
|
|
27173
|
+
"envelope": "EntityInformationResultModel",
|
|
27174
|
+
"inputSchema": {},
|
|
26335
27175
|
"inputSchemaStrict": true,
|
|
26336
27176
|
"outputSchema": {
|
|
26337
|
-
"type": "
|
|
27177
|
+
"type": "EntityInformationResultModel",
|
|
26338
27178
|
"drops": []
|
|
26339
27179
|
},
|
|
26340
27180
|
"examples": [
|
|
26341
|
-
"await
|
|
27181
|
+
"await client.resourceDailyAvailabilities.getEntityInfo()"
|
|
26342
27182
|
],
|
|
26343
27183
|
"permissions": "unknown",
|
|
26344
27184
|
"pagination": {
|
|
@@ -26346,67 +27186,42 @@
|
|
|
26346
27186
|
},
|
|
26347
27187
|
"resolution": null,
|
|
26348
27188
|
"retry": {
|
|
26349
|
-
"preset": "retry-
|
|
27189
|
+
"preset": "retry-ffb3a9cb"
|
|
26350
27190
|
},
|
|
26351
27191
|
"errors": {
|
|
26352
|
-
"set":
|
|
27192
|
+
"set": 6
|
|
26353
27193
|
},
|
|
26354
27194
|
"metadata": {
|
|
26355
|
-
"purpose": "
|
|
26356
|
-
"usage": "
|
|
27195
|
+
"purpose": "Get the ResourceDailyAvailability capability metadata (canCreate/canUpdate/hasUserDefinedFields/...).",
|
|
27196
|
+
"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.",
|
|
26357
27197
|
"preferredWhen": null,
|
|
26358
|
-
"related": [
|
|
26359
|
-
"resource_attachments.get"
|
|
26360
|
-
],
|
|
27198
|
+
"related": [],
|
|
26361
27199
|
"untrustedFields": [
|
|
26362
|
-
"
|
|
27200
|
+
"travelAvailability"
|
|
26363
27201
|
]
|
|
26364
27202
|
},
|
|
26365
27203
|
"compact": null,
|
|
26366
27204
|
"status": "tested"
|
|
26367
27205
|
},
|
|
26368
27206
|
{
|
|
26369
|
-
"id": "
|
|
26370
|
-
"resource": "
|
|
27207
|
+
"id": "resource_daily_availabilities.getFieldInfo",
|
|
27208
|
+
"resource": "resource_daily_availabilities",
|
|
26371
27209
|
"udfCapable": false,
|
|
26372
|
-
"operation": "
|
|
27210
|
+
"operation": "getFieldInfo",
|
|
26373
27211
|
"kind": "primitive",
|
|
26374
|
-
"endpoint": "GET /V1.0/
|
|
27212
|
+
"endpoint": "GET /V1.0/ResourceDailyAvailabilities/entityInformation/fields",
|
|
26375
27213
|
"effect": "read",
|
|
26376
27214
|
"flags": [],
|
|
26377
27215
|
"dryRun": false,
|
|
26378
|
-
"envelope": "
|
|
26379
|
-
"inputSchema": {
|
|
26380
|
-
"parentId": {
|
|
26381
|
-
"type": "string | number",
|
|
26382
|
-
"required": true,
|
|
26383
|
-
"description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
|
|
26384
|
-
},
|
|
26385
|
-
"id": {
|
|
26386
|
-
"type": "string | number",
|
|
26387
|
-
"required": true,
|
|
26388
|
-
"description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
|
|
26389
|
-
},
|
|
26390
|
-
"opts": {
|
|
26391
|
-
"type": "object",
|
|
26392
|
-
"required": false,
|
|
26393
|
-
"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.",
|
|
26394
|
-
"properties": [
|
|
26395
|
-
{
|
|
26396
|
-
"name": "fresh",
|
|
26397
|
-
"type": "boolean",
|
|
26398
|
-
"optional": true
|
|
26399
|
-
}
|
|
26400
|
-
]
|
|
26401
|
-
}
|
|
26402
|
-
},
|
|
27216
|
+
"envelope": "FieldInformationResultModel",
|
|
27217
|
+
"inputSchema": {},
|
|
26403
27218
|
"inputSchemaStrict": true,
|
|
26404
27219
|
"outputSchema": {
|
|
26405
|
-
"type": "
|
|
27220
|
+
"type": "FieldInformationResultModel",
|
|
26406
27221
|
"drops": []
|
|
26407
27222
|
},
|
|
26408
27223
|
"examples": [
|
|
26409
|
-
"await client.
|
|
27224
|
+
"await client.resourceDailyAvailabilities.getFieldInfo()"
|
|
26410
27225
|
],
|
|
26411
27226
|
"permissions": "unknown",
|
|
26412
27227
|
"pagination": {
|
|
@@ -26417,42 +27232,39 @@
|
|
|
26417
27232
|
"preset": "retry-ffb3a9cb"
|
|
26418
27233
|
},
|
|
26419
27234
|
"errors": {
|
|
26420
|
-
"set":
|
|
27235
|
+
"set": 6
|
|
26421
27236
|
},
|
|
26422
27237
|
"metadata": {
|
|
26423
|
-
"purpose": "Get
|
|
26424
|
-
"usage": "
|
|
26425
|
-
"preferredWhen": "
|
|
26426
|
-
"related": [
|
|
26427
|
-
"resource_attachments.query"
|
|
26428
|
-
],
|
|
26429
|
-
"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.",
|
|
27238
|
+
"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).",
|
|
27239
|
+
"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.",
|
|
27240
|
+
"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.",
|
|
27241
|
+
"related": [],
|
|
26430
27242
|
"untrustedFields": [
|
|
26431
|
-
"
|
|
27243
|
+
"travelAvailability"
|
|
26432
27244
|
]
|
|
26433
27245
|
},
|
|
26434
27246
|
"compact": null,
|
|
26435
27247
|
"status": "tested"
|
|
26436
27248
|
},
|
|
26437
27249
|
{
|
|
26438
|
-
"id": "
|
|
26439
|
-
"resource": "
|
|
27250
|
+
"id": "resource_daily_availabilities.getUdfInfo",
|
|
27251
|
+
"resource": "resource_daily_availabilities",
|
|
26440
27252
|
"udfCapable": false,
|
|
26441
|
-
"operation": "
|
|
27253
|
+
"operation": "getUdfInfo",
|
|
26442
27254
|
"kind": "primitive",
|
|
26443
|
-
"endpoint": "GET /V1.0/
|
|
27255
|
+
"endpoint": "GET /V1.0/ResourceDailyAvailabilities/entityInformation/userDefinedFields",
|
|
26444
27256
|
"effect": "read",
|
|
26445
27257
|
"flags": [],
|
|
26446
27258
|
"dryRun": false,
|
|
26447
|
-
"envelope": "
|
|
27259
|
+
"envelope": "UserDefinedFieldInformationResultModel",
|
|
26448
27260
|
"inputSchema": {},
|
|
26449
27261
|
"inputSchemaStrict": true,
|
|
26450
27262
|
"outputSchema": {
|
|
26451
|
-
"type": "
|
|
27263
|
+
"type": "UserDefinedFieldInformationResultModel",
|
|
26452
27264
|
"drops": []
|
|
26453
27265
|
},
|
|
26454
27266
|
"examples": [
|
|
26455
|
-
"await client.
|
|
27267
|
+
"await client.resourceDailyAvailabilities.getUdfInfo()"
|
|
26456
27268
|
],
|
|
26457
27269
|
"permissions": "unknown",
|
|
26458
27270
|
"pagination": {
|
|
@@ -26463,41 +27275,45 @@
|
|
|
26463
27275
|
"preset": "retry-ffb3a9cb"
|
|
26464
27276
|
},
|
|
26465
27277
|
"errors": {
|
|
26466
|
-
"set":
|
|
27278
|
+
"set": 6
|
|
26467
27279
|
},
|
|
26468
27280
|
"metadata": {
|
|
26469
|
-
"purpose": "Get the
|
|
26470
|
-
"usage": "Unwraps
|
|
27281
|
+
"purpose": "Get the ResourceDailyAvailability user-defined-field catalog.",
|
|
27282
|
+
"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.",
|
|
26471
27283
|
"preferredWhen": null,
|
|
26472
|
-
"related": [
|
|
26473
|
-
"resource_attachments.getFieldInfo"
|
|
26474
|
-
],
|
|
27284
|
+
"related": [],
|
|
26475
27285
|
"untrustedFields": [
|
|
26476
|
-
"
|
|
27286
|
+
"travelAvailability"
|
|
26477
27287
|
]
|
|
26478
27288
|
},
|
|
26479
27289
|
"compact": null,
|
|
26480
27290
|
"status": "tested"
|
|
26481
27291
|
},
|
|
26482
27292
|
{
|
|
26483
|
-
"id": "
|
|
26484
|
-
"resource": "
|
|
27293
|
+
"id": "resource_daily_availabilities.listByParent",
|
|
27294
|
+
"resource": "resource_daily_availabilities",
|
|
26485
27295
|
"udfCapable": false,
|
|
26486
|
-
"operation": "
|
|
27296
|
+
"operation": "listByParent",
|
|
26487
27297
|
"kind": "primitive",
|
|
26488
|
-
"endpoint": "GET /V1.0/
|
|
27298
|
+
"endpoint": "GET /V1.0/Resources/{parentId}/DailyAvailabilities",
|
|
26489
27299
|
"effect": "read",
|
|
26490
27300
|
"flags": [],
|
|
26491
27301
|
"dryRun": false,
|
|
26492
|
-
"envelope": "
|
|
26493
|
-
"inputSchema": {
|
|
27302
|
+
"envelope": "QueryActionResult[ResourceDailyAvailabilityModel,ResourceDailyAvailability]",
|
|
27303
|
+
"inputSchema": {
|
|
27304
|
+
"parentId": {
|
|
27305
|
+
"type": "string | number",
|
|
27306
|
+
"required": true,
|
|
27307
|
+
"description": "The documented parent route id; no filter, limit, or caller cursor is accepted."
|
|
27308
|
+
}
|
|
27309
|
+
},
|
|
26494
27310
|
"inputSchemaStrict": true,
|
|
26495
27311
|
"outputSchema": {
|
|
26496
|
-
"type": "
|
|
27312
|
+
"type": "QueryActionResult[ResourceDailyAvailabilityModel,ResourceDailyAvailability]",
|
|
26497
27313
|
"drops": []
|
|
26498
27314
|
},
|
|
26499
27315
|
"examples": [
|
|
26500
|
-
"await client.
|
|
27316
|
+
"await invoke(client, 'resource_daily_availabilities.listByParent', [7])"
|
|
26501
27317
|
],
|
|
26502
27318
|
"permissions": "unknown",
|
|
26503
27319
|
"pagination": {
|
|
@@ -26508,33 +27324,35 @@
|
|
|
26508
27324
|
"preset": "retry-ffb3a9cb"
|
|
26509
27325
|
},
|
|
26510
27326
|
"errors": {
|
|
26511
|
-
"set":
|
|
27327
|
+
"set": 11
|
|
26512
27328
|
},
|
|
26513
27329
|
"metadata": {
|
|
26514
|
-
"purpose": "
|
|
26515
|
-
"usage": "
|
|
26516
|
-
"
|
|
27330
|
+
"purpose": "Read one native parent-scoped staff-association page.",
|
|
27331
|
+
"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.",
|
|
27332
|
+
"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.",
|
|
27333
|
+
"preferredWhen": "Use when the documented native parent collection is required; global get remains single-record-id only.",
|
|
26517
27334
|
"related": [
|
|
26518
|
-
"
|
|
27335
|
+
"resource_daily_availabilities.query",
|
|
27336
|
+
"resource_daily_availabilities.get"
|
|
26519
27337
|
],
|
|
26520
27338
|
"untrustedFields": [
|
|
26521
|
-
"
|
|
27339
|
+
"travelAvailability"
|
|
26522
27340
|
]
|
|
26523
27341
|
},
|
|
26524
27342
|
"compact": null,
|
|
26525
27343
|
"status": "tested"
|
|
26526
27344
|
},
|
|
26527
27345
|
{
|
|
26528
|
-
"id": "
|
|
26529
|
-
"resource": "
|
|
27346
|
+
"id": "resource_daily_availabilities.query",
|
|
27347
|
+
"resource": "resource_daily_availabilities",
|
|
26530
27348
|
"udfCapable": false,
|
|
26531
27349
|
"operation": "query",
|
|
26532
27350
|
"kind": "primitive",
|
|
26533
|
-
"endpoint": "GET|POST /V1.0/
|
|
27351
|
+
"endpoint": "GET|POST /V1.0/ResourceDailyAvailabilities/query",
|
|
26534
27352
|
"effect": "read",
|
|
26535
27353
|
"flags": [],
|
|
26536
27354
|
"dryRun": false,
|
|
26537
|
-
"envelope": "QueryActionResult[
|
|
27355
|
+
"envelope": "QueryActionResult[ResourceDailyAvailabilityModel,ResourceDailyAvailability]",
|
|
26538
27356
|
"inputSchema": {
|
|
26539
27357
|
"params": {
|
|
26540
27358
|
"type": "object",
|
|
@@ -26598,11 +27416,11 @@
|
|
|
26598
27416
|
},
|
|
26599
27417
|
"inputSchemaStrict": true,
|
|
26600
27418
|
"outputSchema": {
|
|
26601
|
-
"type": "QueryActionResult[
|
|
27419
|
+
"type": "QueryActionResult[ResourceDailyAvailabilityModel,ResourceDailyAvailability]",
|
|
26602
27420
|
"drops": []
|
|
26603
27421
|
},
|
|
26604
27422
|
"examples": [
|
|
26605
|
-
"await invoke(client, '
|
|
27423
|
+
"await invoke(client, 'resource_daily_availabilities.query', [{ filter: [{ field: 'resourceID', op: 'eq', value: 7 }], limit: 25 }])"
|
|
26606
27424
|
],
|
|
26607
27425
|
"permissions": "unknown",
|
|
26608
27426
|
"pagination": {
|
|
@@ -26620,18 +27438,16 @@
|
|
|
26620
27438
|
"preset": "retry-ffb3a9cb"
|
|
26621
27439
|
},
|
|
26622
27440
|
"errors": {
|
|
26623
|
-
"set":
|
|
27441
|
+
"set": 11
|
|
26624
27442
|
},
|
|
26625
27443
|
"metadata": {
|
|
26626
|
-
"purpose": "Query
|
|
26627
|
-
"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).
|
|
27444
|
+
"purpose": "Query ResourceDailyAvailability records with a JSON filter.",
|
|
27445
|
+
"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.",
|
|
26628
27446
|
"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).",
|
|
26629
|
-
"related": [
|
|
26630
|
-
"resource_attachments.get"
|
|
26631
|
-
],
|
|
27447
|
+
"related": [],
|
|
26632
27448
|
"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.",
|
|
26633
27449
|
"untrustedFields": [
|
|
26634
|
-
"
|
|
27450
|
+
"travelAvailability"
|
|
26635
27451
|
]
|
|
26636
27452
|
},
|
|
26637
27453
|
"compact": null,
|
|
@@ -30035,7 +30851,7 @@
|
|
|
30035
30851
|
"preset": "retry-ffb3a9cb"
|
|
30036
30852
|
},
|
|
30037
30853
|
"errors": {
|
|
30038
|
-
"set":
|
|
30854
|
+
"set": 12
|
|
30039
30855
|
},
|
|
30040
30856
|
"metadata": {
|
|
30041
30857
|
"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.",
|
|
@@ -34241,7 +35057,7 @@
|
|
|
34241
35057
|
"preset": "retry-ffb3a9cb"
|
|
34242
35058
|
},
|
|
34243
35059
|
"errors": {
|
|
34244
|
-
"set":
|
|
35060
|
+
"set": 13
|
|
34245
35061
|
},
|
|
34246
35062
|
"metadata": {
|
|
34247
35063
|
"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).",
|
|
@@ -43715,7 +44531,7 @@
|
|
|
43715
44531
|
"preset": "retry-ffb3a9cb"
|
|
43716
44532
|
},
|
|
43717
44533
|
"errors": {
|
|
43718
|
-
"set":
|
|
44534
|
+
"set": 14
|
|
43719
44535
|
},
|
|
43720
44536
|
"metadata": {
|
|
43721
44537
|
"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.",
|
|
@@ -47381,8 +48197,8 @@
|
|
|
47381
48197
|
]
|
|
47382
48198
|
},
|
|
47383
48199
|
"A": {
|
|
47384
|
-
"planHash": "
|
|
47385
|
-
"builtAt": "2026-11-
|
|
48200
|
+
"planHash": "51888554f455b96e13c50591342fa516b095065762430b783201ac7a995a0901",
|
|
48201
|
+
"builtAt": "2026-11-22T07:17:16.330Z",
|
|
47386
48202
|
"records": [
|
|
47387
48203
|
{
|
|
47388
48204
|
"id": "attachment_info.count",
|
|
@@ -48035,7 +48851,7 @@
|
|
|
48035
48851
|
"preset": "retry-ffb3a9cb"
|
|
48036
48852
|
},
|
|
48037
48853
|
"errors": {
|
|
48038
|
-
"set":
|
|
48854
|
+
"set": 15
|
|
48039
48855
|
},
|
|
48040
48856
|
"metadata": {
|
|
48041
48857
|
"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.",
|
|
@@ -48224,7 +49040,7 @@
|
|
|
48224
49040
|
"preset": "retry-ffb3a9cb"
|
|
48225
49041
|
},
|
|
48226
49042
|
"errors": {
|
|
48227
|
-
"set":
|
|
49043
|
+
"set": 16
|
|
48228
49044
|
},
|
|
48229
49045
|
"metadata": {
|
|
48230
49046
|
"purpose": "Get a company with its primary context records in one call.",
|
|
@@ -48510,7 +49326,7 @@
|
|
|
48510
49326
|
"preset": "retry-ffb3a9cb"
|
|
48511
49327
|
},
|
|
48512
49328
|
"errors": {
|
|
48513
|
-
"set":
|
|
49329
|
+
"set": 16
|
|
48514
49330
|
},
|
|
48515
49331
|
"metadata": {
|
|
48516
49332
|
"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.",
|
|
@@ -49264,7 +50080,7 @@
|
|
|
49264
50080
|
"preset": "retry-ffb3a9cb"
|
|
49265
50081
|
},
|
|
49266
50082
|
"errors": {
|
|
49267
|
-
"set":
|
|
50083
|
+
"set": 17
|
|
49268
50084
|
},
|
|
49269
50085
|
"metadata": {
|
|
49270
50086
|
"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",
|
|
@@ -58570,7 +59386,7 @@
|
|
|
58570
59386
|
"preset": "retry-ffb3a9cb"
|
|
58571
59387
|
},
|
|
58572
59388
|
"errors": {
|
|
58573
|
-
"set":
|
|
59389
|
+
"set": 16
|
|
58574
59390
|
},
|
|
58575
59391
|
"metadata": {
|
|
58576
59392
|
"purpose": "Get a configuration item with its primary context records in one call.",
|
|
@@ -58963,7 +59779,7 @@
|
|
|
58963
59779
|
"preset": "retry-ffb3a9cb"
|
|
58964
59780
|
},
|
|
58965
59781
|
"errors": {
|
|
58966
|
-
"set":
|
|
59782
|
+
"set": 17
|
|
58967
59783
|
},
|
|
58968
59784
|
"metadata": {
|
|
58969
59785
|
"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).",
|
|
@@ -60551,7 +61367,7 @@
|
|
|
60551
61367
|
"preset": "retry-ffb3a9cb"
|
|
60552
61368
|
},
|
|
60553
61369
|
"errors": {
|
|
60554
|
-
"set":
|
|
61370
|
+
"set": 12
|
|
60555
61371
|
},
|
|
60556
61372
|
"metadata": {
|
|
60557
61373
|
"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.",
|
|
@@ -60739,7 +61555,7 @@
|
|
|
60739
61555
|
"preset": "retry-ffb3a9cb"
|
|
60740
61556
|
},
|
|
60741
61557
|
"errors": {
|
|
60742
|
-
"set":
|
|
61558
|
+
"set": 16
|
|
60743
61559
|
},
|
|
60744
61560
|
"metadata": {
|
|
60745
61561
|
"purpose": "Get a contact with its primary context records in one call. (under a company)",
|
|
@@ -71679,7 +72495,7 @@
|
|
|
71679
72495
|
"preset": "retry-ffb3a9cb"
|
|
71680
72496
|
},
|
|
71681
72497
|
"errors": {
|
|
71682
|
-
"set":
|
|
72498
|
+
"set": 13
|
|
71683
72499
|
},
|
|
71684
72500
|
"metadata": {
|
|
71685
72501
|
"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).",
|
|
@@ -72055,7 +72871,7 @@
|
|
|
72055
72871
|
"preset": "retry-ffb3a9cb"
|
|
72056
72872
|
},
|
|
72057
72873
|
"errors": {
|
|
72058
|
-
"set":
|
|
72874
|
+
"set": 17
|
|
72059
72875
|
},
|
|
72060
72876
|
"metadata": {
|
|
72061
72877
|
"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).",
|
|
@@ -72205,7 +73021,7 @@
|
|
|
72205
73021
|
"preset": "retry-ffb3a9cb"
|
|
72206
73022
|
},
|
|
72207
73023
|
"errors": {
|
|
72208
|
-
"set":
|
|
73024
|
+
"set": 17
|
|
72209
73025
|
},
|
|
72210
73026
|
"metadata": {
|
|
72211
73027
|
"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",
|
|
@@ -72797,7 +73613,7 @@
|
|
|
72797
73613
|
"preset": "retry-c5657094"
|
|
72798
73614
|
},
|
|
72799
73615
|
"errors": {
|
|
72800
|
-
"set":
|
|
73616
|
+
"set": 18
|
|
72801
73617
|
},
|
|
72802
73618
|
"metadata": {
|
|
72803
73619
|
"purpose": "Create a product-location inventory item.",
|
|
@@ -73133,7 +73949,7 @@
|
|
|
73133
73949
|
"preset": "retry-ffb3a9cb"
|
|
73134
73950
|
},
|
|
73135
73951
|
"errors": {
|
|
73136
|
-
"set":
|
|
73952
|
+
"set": 19
|
|
73137
73953
|
},
|
|
73138
73954
|
"metadata": {
|
|
73139
73955
|
"purpose": "Query InventoryItem records with a JSON filter.",
|
|
@@ -73191,7 +74007,7 @@
|
|
|
73191
74007
|
"preset": "retry-c5657094"
|
|
73192
74008
|
},
|
|
73193
74009
|
"errors": {
|
|
73194
|
-
"set":
|
|
74010
|
+
"set": 18
|
|
73195
74011
|
},
|
|
73196
74012
|
"metadata": {
|
|
73197
74013
|
"purpose": "Update writable inventory item fields with collection PATCH.",
|
|
@@ -73309,7 +74125,7 @@
|
|
|
73309
74125
|
"preset": "retry-c5657094"
|
|
73310
74126
|
},
|
|
73311
74127
|
"errors": {
|
|
73312
|
-
"set":
|
|
74128
|
+
"set": 20
|
|
73313
74129
|
},
|
|
73314
74130
|
"metadata": {
|
|
73315
74131
|
"purpose": "Create an inventory location.",
|
|
@@ -73635,7 +74451,7 @@
|
|
|
73635
74451
|
"preset": "retry-ffb3a9cb"
|
|
73636
74452
|
},
|
|
73637
74453
|
"errors": {
|
|
73638
|
-
"set":
|
|
74454
|
+
"set": 11
|
|
73639
74455
|
},
|
|
73640
74456
|
"metadata": {
|
|
73641
74457
|
"purpose": "Query InventoryLocation records with a JSON filter.",
|
|
@@ -78964,7 +79780,7 @@
|
|
|
78964
79780
|
"preset": "retry-ffb3a9cb"
|
|
78965
79781
|
},
|
|
78966
79782
|
"errors": {
|
|
78967
|
-
"set":
|
|
79783
|
+
"set": 16
|
|
78968
79784
|
},
|
|
78969
79785
|
"metadata": {
|
|
78970
79786
|
"purpose": "Get a project with its primary context records in one call.",
|
|
@@ -81571,7 +82387,7 @@
|
|
|
81571
82387
|
"preset": "retry-ffb3a9cb"
|
|
81572
82388
|
},
|
|
81573
82389
|
"errors": {
|
|
81574
|
-
"set":
|
|
82390
|
+
"set": 13
|
|
81575
82391
|
},
|
|
81576
82392
|
"metadata": {
|
|
81577
82393
|
"purpose": "Get a quote with its line items in a single call — the items part is the bounded quoteID-filtered query.",
|
|
@@ -82515,7 +83331,7 @@
|
|
|
82515
83331
|
"preset": "retry-c5657094"
|
|
82516
83332
|
},
|
|
82517
83333
|
"errors": {
|
|
82518
|
-
"set":
|
|
83334
|
+
"set": 20
|
|
82519
83335
|
},
|
|
82520
83336
|
"metadata": {
|
|
82521
83337
|
"purpose": "Create an attachment under a task.",
|
|
@@ -82858,7 +83674,7 @@
|
|
|
82858
83674
|
"preset": "retry-ffb3a9cb"
|
|
82859
83675
|
},
|
|
82860
83676
|
"errors": {
|
|
82861
|
-
"set":
|
|
83677
|
+
"set": 11
|
|
82862
83678
|
},
|
|
82863
83679
|
"metadata": {
|
|
82864
83680
|
"purpose": "Query TaskAttachment records with a JSON filter.",
|
|
@@ -92162,7 +92978,7 @@
|
|
|
92162
92978
|
"preset": "retry-ffb3a9cb"
|
|
92163
92979
|
},
|
|
92164
92980
|
"errors": {
|
|
92165
|
-
"set":
|
|
92981
|
+
"set": 17
|
|
92166
92982
|
},
|
|
92167
92983
|
"metadata": {
|
|
92168
92984
|
"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.",
|
|
@@ -92367,7 +93183,7 @@
|
|
|
92367
93183
|
"preset": "retry-ffb3a9cb"
|
|
92368
93184
|
},
|
|
92369
93185
|
"errors": {
|
|
92370
|
-
"set":
|
|
93186
|
+
"set": 16
|
|
92371
93187
|
},
|
|
92372
93188
|
"metadata": {
|
|
92373
93189
|
"purpose": "Get a ticket with its primary context records in one call.",
|
|
@@ -92686,7 +93502,7 @@
|
|
|
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 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).",
|
|
@@ -93124,7 +93940,7 @@
|
|
|
93124
93940
|
"preset": "retry-ffb3a9cb"
|
|
93125
93941
|
},
|
|
93126
93942
|
"errors": {
|
|
93127
|
-
"set":
|
|
93943
|
+
"set": 16
|
|
93128
93944
|
},
|
|
93129
93945
|
"metadata": {
|
|
93130
93946
|
"purpose": "Run the SLA health check for a ticket (numeric ticket id).",
|
|
@@ -93319,7 +94135,7 @@
|
|
|
93319
94135
|
"preset": "retry-ffb3a9cb"
|
|
93320
94136
|
},
|
|
93321
94137
|
"errors": {
|
|
93322
|
-
"set":
|
|
94138
|
+
"set": 16
|
|
93323
94139
|
},
|
|
93324
94140
|
"metadata": {
|
|
93325
94141
|
"purpose": "Get a one-call summary of a ticket (numeric ticket id).",
|
|
@@ -93429,7 +94245,7 @@
|
|
|
93429
94245
|
"preset": "retry-ffb3a9cb"
|
|
93430
94246
|
},
|
|
93431
94247
|
"errors": {
|
|
93432
|
-
"set":
|
|
94248
|
+
"set": 16
|
|
93433
94249
|
},
|
|
93434
94250
|
"metadata": {
|
|
93435
94251
|
"purpose": "Get the event timeline of a ticket (numeric ticket id).",
|
|
@@ -93580,8 +94396,8 @@
|
|
|
93580
94396
|
]
|
|
93581
94397
|
},
|
|
93582
94398
|
"operations": {
|
|
93583
|
-
"planHash": "
|
|
93584
|
-
"builtAt": "2026-11-
|
|
94399
|
+
"planHash": "51888554f455b96e13c50591342fa516b095065762430b783201ac7a995a0901",
|
|
94400
|
+
"builtAt": "2026-11-22T07:17:16.330Z",
|
|
93585
94401
|
"records": [
|
|
93586
94402
|
{
|
|
93587
94403
|
"id": "operations.aggregate",
|
|
@@ -93800,6 +94616,7 @@
|
|
|
93800
94616
|
"timeFormat",
|
|
93801
94617
|
"timeZone",
|
|
93802
94618
|
"title",
|
|
94619
|
+
"travelAvailability",
|
|
93803
94620
|
"travelAvailabilityPct",
|
|
93804
94621
|
"userName",
|
|
93805
94622
|
"valueForDisplay",
|
|
@@ -93992,7 +94809,7 @@
|
|
|
93992
94809
|
"preset": "retry-ffb3a9cb"
|
|
93993
94810
|
},
|
|
93994
94811
|
"errors": {
|
|
93995
|
-
"set":
|
|
94812
|
+
"set": 17
|
|
93996
94813
|
},
|
|
93997
94814
|
"metadata": {
|
|
93998
94815
|
"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).",
|
|
@@ -94044,7 +94861,7 @@
|
|
|
94044
94861
|
"preset": "retry-ffb3a9cb"
|
|
94045
94862
|
},
|
|
94046
94863
|
"errors": {
|
|
94047
|
-
"set":
|
|
94864
|
+
"set": 17
|
|
94048
94865
|
},
|
|
94049
94866
|
"metadata": {
|
|
94050
94867
|
"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.",
|
|
@@ -94180,6 +94997,7 @@
|
|
|
94180
94997
|
"timeFormat",
|
|
94181
94998
|
"timeZone",
|
|
94182
94999
|
"title",
|
|
95000
|
+
"travelAvailability",
|
|
94183
95001
|
"travelAvailabilityPct",
|
|
94184
95002
|
"userName",
|
|
94185
95003
|
"valueForDisplay",
|
|
@@ -94836,6 +95654,7 @@
|
|
|
94836
95654
|
"timeFormat",
|
|
94837
95655
|
"timeZone",
|
|
94838
95656
|
"title",
|
|
95657
|
+
"travelAvailability",
|
|
94839
95658
|
"travelAvailabilityPct",
|
|
94840
95659
|
"userName",
|
|
94841
95660
|
"valueForDisplay",
|
|
@@ -95315,6 +96134,7 @@
|
|
|
95315
96134
|
"timeFormat",
|
|
95316
96135
|
"timeZone",
|
|
95317
96136
|
"title",
|
|
96137
|
+
"travelAvailability",
|
|
95318
96138
|
"travelAvailabilityPct",
|
|
95319
96139
|
"userName",
|
|
95320
96140
|
"valueForDisplay",
|
|
@@ -95696,6 +96516,21 @@
|
|
|
95696
96516
|
"REDIRECT_BLOCKED",
|
|
95697
96517
|
"STALE_OBJECT"
|
|
95698
96518
|
],
|
|
96519
|
+
[
|
|
96520
|
+
"BAD_REQUEST",
|
|
96521
|
+
"CONFIG_ERROR",
|
|
96522
|
+
"NETWORK_ERROR",
|
|
96523
|
+
"UNAUTHORIZED",
|
|
96524
|
+
"RATE_LIMITED",
|
|
96525
|
+
"TIMEOUT",
|
|
96526
|
+
"SERVER_ERROR",
|
|
96527
|
+
"INVALID_RESPONSE",
|
|
96528
|
+
"ABORTED",
|
|
96529
|
+
"RESPONSE_TOO_LARGE",
|
|
96530
|
+
"REDIRECT_BLOCKED",
|
|
96531
|
+
"SCOPE_REQUIRED",
|
|
96532
|
+
"FORBIDDEN"
|
|
96533
|
+
],
|
|
95699
96534
|
[
|
|
95700
96535
|
"CONFIG_ERROR",
|
|
95701
96536
|
"NOT_FOUND",
|
|
@@ -95832,21 +96667,6 @@
|
|
|
95832
96667
|
"REDIRECT_BLOCKED",
|
|
95833
96668
|
"FORBIDDEN"
|
|
95834
96669
|
],
|
|
95835
|
-
[
|
|
95836
|
-
"BAD_REQUEST",
|
|
95837
|
-
"CONFIG_ERROR",
|
|
95838
|
-
"NETWORK_ERROR",
|
|
95839
|
-
"UNAUTHORIZED",
|
|
95840
|
-
"RATE_LIMITED",
|
|
95841
|
-
"TIMEOUT",
|
|
95842
|
-
"SERVER_ERROR",
|
|
95843
|
-
"INVALID_RESPONSE",
|
|
95844
|
-
"ABORTED",
|
|
95845
|
-
"RESPONSE_TOO_LARGE",
|
|
95846
|
-
"REDIRECT_BLOCKED",
|
|
95847
|
-
"SCOPE_REQUIRED",
|
|
95848
|
-
"FORBIDDEN"
|
|
95849
|
-
],
|
|
95850
96670
|
[
|
|
95851
96671
|
"BAD_REQUEST",
|
|
95852
96672
|
"CONFIG_ERROR",
|