node-autotask 0.74.0 → 0.76.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +12 -0
- package/MCP_TOOL_CATALOG.json +265 -9
- package/README.md +1 -1
- package/capabilities.json +1219 -217
- package/dist/capabilities-data.js +1449 -447
- package/dist/capabilities.cjs +4 -4
- package/dist/capabilities.js +1 -1
- package/dist/{chunk-HJKY7LUL.js → chunk-3SFIKG2R.js} +575 -215
- package/dist/{chunk-DSQJTGXK.cjs → chunk-55BQEFBO.cjs} +32 -30
- package/dist/{chunk-ASL3BIW2.cjs → chunk-C4S3EKIK.cjs} +3 -3
- package/dist/{chunk-IWTTCBCS.js → chunk-ECSE6B3U.js} +3 -3
- package/dist/{chunk-IFE5FWS7.js → chunk-S7QPD6TR.js} +2 -2
- package/dist/{chunk-PGSDJS52.js → chunk-UFK7JYYC.js} +4 -2
- package/dist/{chunk-AMB54GOO.cjs → chunk-Y4BH5N6R.cjs} +580 -220
- package/dist/{chunk-QZY5LAOG.cjs → chunk-YRTOAPWD.cjs} +199 -199
- package/dist/{index-CH65Ftmy.d.cts → index-BbAzrm2i.d.cts} +95 -1
- package/dist/{index-CH65Ftmy.d.ts → index-BbAzrm2i.d.ts} +95 -1
- package/dist/{index-ColCzIyw.d.ts → index-CY7exGOe.d.ts} +7 -8
- package/dist/{index-CkBDlaSS.d.cts → index-MY7qYY5d.d.cts} +7 -8
- package/dist/index.cjs +84 -84
- package/dist/index.d.cts +3 -3
- package/dist/index.d.ts +3 -3
- package/dist/index.js +5 -5
- package/dist/operations/index.cjs +51 -51
- package/dist/operations/index.d.cts +4 -4
- package/dist/operations/index.d.ts +4 -4
- package/dist/operations/index.js +2 -2
- package/dist/pool.cjs +12 -12
- package/dist/pool.d.cts +1 -1
- package/dist/pool.d.ts +1 -1
- package/dist/pool.js +4 -4
- package/dist/resources/index.cjs +27 -27
- package/dist/resources/index.d.cts +2 -2
- package/dist/resources/index.d.ts +2 -2
- package/dist/resources/index.js +3 -3
- package/dist/types/index.d.cts +1 -1
- package/dist/types/index.d.ts +1 -1
- package/docs/API.md +4 -2
- package/package.json +1 -1
|
@@ -216,6 +216,68 @@ const CAPABILITY_DATA = {
|
|
|
216
216
|
"RESPONSE_TOO_LARGE",
|
|
217
217
|
"REDIRECT_BLOCKED"
|
|
218
218
|
],
|
|
219
|
+
[
|
|
220
|
+
"BAD_REQUEST",
|
|
221
|
+
"CONFIG_ERROR",
|
|
222
|
+
"NETWORK_ERROR",
|
|
223
|
+
"UNAUTHORIZED",
|
|
224
|
+
"RATE_LIMITED",
|
|
225
|
+
"TIMEOUT",
|
|
226
|
+
"SERVER_ERROR",
|
|
227
|
+
"INVALID_RESPONSE",
|
|
228
|
+
"ABORTED",
|
|
229
|
+
"RESPONSE_TOO_LARGE",
|
|
230
|
+
"REDIRECT_BLOCKED",
|
|
231
|
+
"FORBIDDEN"
|
|
232
|
+
],
|
|
233
|
+
[
|
|
234
|
+
"BAD_REQUEST",
|
|
235
|
+
"CONFIG_ERROR",
|
|
236
|
+
"NETWORK_ERROR",
|
|
237
|
+
"UNAUTHORIZED",
|
|
238
|
+
"RATE_LIMITED",
|
|
239
|
+
"VALIDATION_FAILED",
|
|
240
|
+
"CONFLICT",
|
|
241
|
+
"STALE_OBJECT",
|
|
242
|
+
"TIMEOUT",
|
|
243
|
+
"SERVER_ERROR",
|
|
244
|
+
"INVALID_RESPONSE",
|
|
245
|
+
"ABORTED",
|
|
246
|
+
"RESPONSE_TOO_LARGE",
|
|
247
|
+
"REDIRECT_BLOCKED",
|
|
248
|
+
"FORBIDDEN"
|
|
249
|
+
],
|
|
250
|
+
[
|
|
251
|
+
"BAD_REQUEST",
|
|
252
|
+
"CONFIG_ERROR",
|
|
253
|
+
"NETWORK_ERROR",
|
|
254
|
+
"UNAUTHORIZED",
|
|
255
|
+
"RATE_LIMITED",
|
|
256
|
+
"VALIDATION_FAILED",
|
|
257
|
+
"CONFLICT",
|
|
258
|
+
"TIMEOUT",
|
|
259
|
+
"SERVER_ERROR",
|
|
260
|
+
"INVALID_RESPONSE",
|
|
261
|
+
"ABORTED",
|
|
262
|
+
"RESPONSE_TOO_LARGE",
|
|
263
|
+
"REDIRECT_BLOCKED",
|
|
264
|
+
"FORBIDDEN"
|
|
265
|
+
],
|
|
266
|
+
[
|
|
267
|
+
"BAD_REQUEST",
|
|
268
|
+
"CONFIG_ERROR",
|
|
269
|
+
"NETWORK_ERROR",
|
|
270
|
+
"UNAUTHORIZED",
|
|
271
|
+
"RATE_LIMITED",
|
|
272
|
+
"TIMEOUT",
|
|
273
|
+
"SERVER_ERROR",
|
|
274
|
+
"INVALID_RESPONSE",
|
|
275
|
+
"ABORTED",
|
|
276
|
+
"RESPONSE_TOO_LARGE",
|
|
277
|
+
"REDIRECT_BLOCKED",
|
|
278
|
+
"SCOPE_REQUIRED",
|
|
279
|
+
"FORBIDDEN"
|
|
280
|
+
],
|
|
219
281
|
[
|
|
220
282
|
"STATUS_UNKNOWN",
|
|
221
283
|
"STATUS_FIELDS_REQUIRED",
|
|
@@ -348,8 +410,8 @@ const CAPABILITY_DATA = {
|
|
|
348
410
|
],
|
|
349
411
|
"groups": {
|
|
350
412
|
"B": {
|
|
351
|
-
"planHash": "
|
|
352
|
-
"builtAt": "2026-11-
|
|
413
|
+
"planHash": "ad752908bb8c2b868f1df63ba52fd308bd4eaec8e6c9c9182f97504ad79f5ca4",
|
|
414
|
+
"builtAt": "2026-11-19T03:48:00.874Z",
|
|
353
415
|
"records": [
|
|
354
416
|
{
|
|
355
417
|
"id": "appointments.count",
|
|
@@ -43264,8 +43326,8 @@ const CAPABILITY_DATA = {
|
|
|
43264
43326
|
]
|
|
43265
43327
|
},
|
|
43266
43328
|
"A": {
|
|
43267
|
-
"planHash": "
|
|
43268
|
-
"builtAt": "2026-11-
|
|
43329
|
+
"planHash": "ad752908bb8c2b868f1df63ba52fd308bd4eaec8e6c9c9182f97504ad79f5ca4",
|
|
43330
|
+
"builtAt": "2026-11-19T03:48:00.874Z",
|
|
43269
43331
|
"records": [
|
|
43270
43332
|
{
|
|
43271
43333
|
"id": "attachment_info.count",
|
|
@@ -74884,12 +74946,12 @@ const CAPABILITY_DATA = {
|
|
|
74884
74946
|
"status": "tested"
|
|
74885
74947
|
},
|
|
74886
74948
|
{
|
|
74887
|
-
"id": "
|
|
74888
|
-
"resource": "
|
|
74949
|
+
"id": "task_attachments.count",
|
|
74950
|
+
"resource": "task_attachments",
|
|
74889
74951
|
"udfCapable": false,
|
|
74890
74952
|
"operation": "count",
|
|
74891
74953
|
"kind": "primitive",
|
|
74892
|
-
"endpoint": "GET|POST /V1.0/
|
|
74954
|
+
"endpoint": "GET|POST /V1.0/TaskAttachments/query/count",
|
|
74893
74955
|
"effect": "read",
|
|
74894
74956
|
"flags": [],
|
|
74895
74957
|
"dryRun": false,
|
|
@@ -74919,7 +74981,7 @@ const CAPABILITY_DATA = {
|
|
|
74919
74981
|
"drops": []
|
|
74920
74982
|
},
|
|
74921
74983
|
"examples": [
|
|
74922
|
-
"await invoke(client, '
|
|
74984
|
+
"await invoke(client, 'task_attachments.count', [{ filter: [{ field: 'taskID', op: 'eq', value: 7 }] }])"
|
|
74923
74985
|
],
|
|
74924
74986
|
"permissions": "unknown",
|
|
74925
74987
|
"pagination": {
|
|
@@ -74930,18 +74992,17 @@ const CAPABILITY_DATA = {
|
|
|
74930
74992
|
"preset": "retry-ffb3a9cb"
|
|
74931
74993
|
},
|
|
74932
74994
|
"errors": {
|
|
74933
|
-
"set":
|
|
74995
|
+
"set": 12
|
|
74934
74996
|
},
|
|
74935
74997
|
"metadata": {
|
|
74936
|
-
"purpose": "Count
|
|
74937
|
-
"usage": "Unwraps queryCount; returns a plain number.",
|
|
74998
|
+
"purpose": "Count TaskAttachment records matching a task-scoped JSON filter.",
|
|
74999
|
+
"usage": "Unwraps queryCount; returns a plain number. Filter by taskID for task scope. creatorType, data and fileSize are not queryable. Object-specific filters can include child attachments; an empty result is conditional on API-user permissions and visibility. The common attachment changes contract permits child attachments in parent queries. A taskID match alone does not prove a direct task attachment, so createIfNotExists is refused; direct create remains available.",
|
|
74938
75000
|
"preferredWhen": null,
|
|
74939
75001
|
"related": [
|
|
74940
|
-
"
|
|
75002
|
+
"task_attachments.query"
|
|
74941
75003
|
],
|
|
74942
75004
|
"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.",
|
|
74943
75005
|
"untrustedFields": [
|
|
74944
|
-
"description",
|
|
74945
75006
|
"title"
|
|
74946
75007
|
]
|
|
74947
75008
|
},
|
|
@@ -74949,12 +75010,12 @@ const CAPABILITY_DATA = {
|
|
|
74949
75010
|
"status": "tested"
|
|
74950
75011
|
},
|
|
74951
75012
|
{
|
|
74952
|
-
"id": "
|
|
74953
|
-
"resource": "
|
|
75013
|
+
"id": "task_attachments.create",
|
|
75014
|
+
"resource": "task_attachments",
|
|
74954
75015
|
"udfCapable": false,
|
|
74955
75016
|
"operation": "create",
|
|
74956
75017
|
"kind": "primitive",
|
|
74957
|
-
"endpoint": "POST /V1.0/Tasks/{parentId}/
|
|
75018
|
+
"endpoint": "POST /V1.0/Tasks/{parentId}/Attachments",
|
|
74958
75019
|
"effect": "write",
|
|
74959
75020
|
"flags": [],
|
|
74960
75021
|
"dryRun": true,
|
|
@@ -74977,7 +75038,7 @@ const CAPABILITY_DATA = {
|
|
|
74977
75038
|
"drops": []
|
|
74978
75039
|
},
|
|
74979
75040
|
"examples": [
|
|
74980
|
-
"
|
|
75041
|
+
"await invoke(client, 'task_attachments.create', [7, { attachmentType: 'FILE_ATTACHMENT', fullPath: 'note.txt', title: 'Supporting note', publish: 1, data: 'bm90ZQ==' }], { dryRun: true })"
|
|
74981
75042
|
],
|
|
74982
75043
|
"permissions": "unknown",
|
|
74983
75044
|
"pagination": {
|
|
@@ -74988,39 +75049,49 @@ const CAPABILITY_DATA = {
|
|
|
74988
75049
|
"preset": "retry-c5657094"
|
|
74989
75050
|
},
|
|
74990
75051
|
"errors": {
|
|
74991
|
-
"set":
|
|
75052
|
+
"set": 13
|
|
74992
75053
|
},
|
|
74993
75054
|
"metadata": {
|
|
74994
|
-
"purpose": "Create a task
|
|
74995
|
-
"usage": "Returns OperationResultModel.itemId (the new id); the full record is not returned — follow up with get where needed. Parent-scoped: parentId is a path parameter.
|
|
74996
|
-
"preferredWhen": "
|
|
75055
|
+
"purpose": "Create an attachment under a task.",
|
|
75056
|
+
"usage": "Returns OperationResultModel.itemId (the new id); the full record is not returned — follow up with get where needed. Parent-scoped: parentId is a path parameter. FILE_ATTACHMENT requires base64 data; use current attachmentType/publish metadata and vendor file limits. ParentId addresses the Tasks record. Permission and impersonation restrictions apply. The required fields are attachmentType, fullPath, publish and title. For FILE_ATTACHMENT, data is a required non-empty base64 string. Resolve attachmentType/publish values from current metadata, not example integers. Resource impersonation uses the existing request header; the documented contact-impersonation parent list does not include direct Task attachments. Task attachments support parentAttachmentID nesting; this is not a new nested-attachment endpoint. taskNoteID, timeEntryID and opportunityID are read-only reference fields, not writable cross-object associations; legacy parentID and computed creatorType/fileSize are not create inputs.",
|
|
75057
|
+
"preferredWhen": "Add a new attachment; existing attachments cannot be updated. Replace through separately governed delete and create actions.",
|
|
74997
75058
|
"related": [
|
|
74998
|
-
"
|
|
75059
|
+
"task_attachments.get"
|
|
74999
75060
|
],
|
|
75000
|
-
"deleteBoundary": {
|
|
75001
|
-
"resource": "task_notes",
|
|
75002
|
-
"note": "The vendor defines no DELETE for task_notes (spec-derived); a created task note cannot be removed through the public API.",
|
|
75003
|
-
"proof": "spec-derived"
|
|
75004
|
-
},
|
|
75005
75061
|
"untrustedFields": [
|
|
75006
|
-
"description",
|
|
75007
75062
|
"title"
|
|
75008
|
-
]
|
|
75063
|
+
],
|
|
75064
|
+
"createRequirements": {
|
|
75065
|
+
"requiresByValue": [
|
|
75066
|
+
{
|
|
75067
|
+
"field": "attachmentType",
|
|
75068
|
+
"value": "FILE_ATTACHMENT",
|
|
75069
|
+
"requires": {
|
|
75070
|
+
"allOf": [
|
|
75071
|
+
"data"
|
|
75072
|
+
]
|
|
75073
|
+
}
|
|
75074
|
+
}
|
|
75075
|
+
]
|
|
75076
|
+
}
|
|
75009
75077
|
},
|
|
75010
75078
|
"compact": null,
|
|
75011
75079
|
"status": "tested"
|
|
75012
75080
|
},
|
|
75013
75081
|
{
|
|
75014
|
-
"id": "
|
|
75015
|
-
"resource": "
|
|
75082
|
+
"id": "task_attachments.delete",
|
|
75083
|
+
"resource": "task_attachments",
|
|
75016
75084
|
"udfCapable": false,
|
|
75017
|
-
"operation": "
|
|
75085
|
+
"operation": "delete",
|
|
75018
75086
|
"kind": "primitive",
|
|
75019
|
-
"endpoint": "
|
|
75020
|
-
"effect": "
|
|
75021
|
-
"flags": [
|
|
75022
|
-
|
|
75023
|
-
|
|
75087
|
+
"endpoint": "DELETE /V1.0/Tasks/{parentId}/Attachments/{id}",
|
|
75088
|
+
"effect": "destructive",
|
|
75089
|
+
"flags": [
|
|
75090
|
+
"idempotent",
|
|
75091
|
+
"requiresApproval"
|
|
75092
|
+
],
|
|
75093
|
+
"dryRun": true,
|
|
75094
|
+
"envelope": "OperationResultModel (attachment entities: the deleted attachment model is returned, not OperationResultModel)",
|
|
75024
75095
|
"inputSchema": {
|
|
75025
75096
|
"parentId": {
|
|
75026
75097
|
"type": "string | number",
|
|
@@ -75031,27 +75102,15 @@ const CAPABILITY_DATA = {
|
|
|
75031
75102
|
"type": "string | number",
|
|
75032
75103
|
"required": true,
|
|
75033
75104
|
"description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
|
|
75034
|
-
},
|
|
75035
|
-
"opts": {
|
|
75036
|
-
"type": "object",
|
|
75037
|
-
"required": false,
|
|
75038
|
-
"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.",
|
|
75039
|
-
"properties": [
|
|
75040
|
-
{
|
|
75041
|
-
"name": "fresh",
|
|
75042
|
-
"type": "boolean",
|
|
75043
|
-
"optional": true
|
|
75044
|
-
}
|
|
75045
|
-
]
|
|
75046
75105
|
}
|
|
75047
75106
|
},
|
|
75048
75107
|
"inputSchemaStrict": true,
|
|
75049
75108
|
"outputSchema": {
|
|
75050
|
-
"type": "
|
|
75109
|
+
"type": "OperationResultModel (attachment entities: the deleted attachment model is returned, not OperationResultModel)",
|
|
75051
75110
|
"drops": []
|
|
75052
75111
|
},
|
|
75053
75112
|
"examples": [
|
|
75054
|
-
"await client.
|
|
75113
|
+
"await invoke(client, 'task_attachments.delete', ['example-value', 'example-value'], { dryRun: false, confirm: 'task_attachments.delete' })"
|
|
75055
75114
|
],
|
|
75056
75115
|
"permissions": "unknown",
|
|
75057
75116
|
"pagination": {
|
|
@@ -75059,19 +75118,19 @@ const CAPABILITY_DATA = {
|
|
|
75059
75118
|
},
|
|
75060
75119
|
"resolution": null,
|
|
75061
75120
|
"retry": {
|
|
75062
|
-
"preset": "retry-
|
|
75121
|
+
"preset": "retry-1849870d"
|
|
75063
75122
|
},
|
|
75064
75123
|
"errors": {
|
|
75065
|
-
"set":
|
|
75124
|
+
"set": 14
|
|
75066
75125
|
},
|
|
75067
75126
|
"metadata": {
|
|
75068
|
-
"purpose": "
|
|
75069
|
-
"usage": "
|
|
75070
|
-
"preferredWhen":
|
|
75071
|
-
"related": [
|
|
75072
|
-
|
|
75127
|
+
"purpose": "Delete an attachment under a task.",
|
|
75128
|
+
"usage": "Irreversible; dry-run validates the target id first. Parent-scoped: parentId + id.",
|
|
75129
|
+
"preferredWhen": null,
|
|
75130
|
+
"related": [
|
|
75131
|
+
"task_attachments.get"
|
|
75132
|
+
],
|
|
75073
75133
|
"untrustedFields": [
|
|
75074
|
-
"description",
|
|
75075
75134
|
"title"
|
|
75076
75135
|
]
|
|
75077
75136
|
},
|
|
@@ -75079,24 +75138,47 @@ const CAPABILITY_DATA = {
|
|
|
75079
75138
|
"status": "tested"
|
|
75080
75139
|
},
|
|
75081
75140
|
{
|
|
75082
|
-
"id": "
|
|
75083
|
-
"resource": "
|
|
75141
|
+
"id": "task_attachments.get",
|
|
75142
|
+
"resource": "task_attachments",
|
|
75084
75143
|
"udfCapable": false,
|
|
75085
|
-
"operation": "
|
|
75144
|
+
"operation": "get",
|
|
75086
75145
|
"kind": "primitive",
|
|
75087
|
-
"endpoint": "GET /V1.0/
|
|
75146
|
+
"endpoint": "GET /V1.0/Tasks/{parentId}/Attachments/{id}",
|
|
75088
75147
|
"effect": "read",
|
|
75089
75148
|
"flags": [],
|
|
75090
75149
|
"dryRun": false,
|
|
75091
|
-
"envelope": "
|
|
75092
|
-
"inputSchema": {
|
|
75150
|
+
"envelope": "TaskAttachmentModel",
|
|
75151
|
+
"inputSchema": {
|
|
75152
|
+
"parentId": {
|
|
75153
|
+
"type": "string | number",
|
|
75154
|
+
"required": true,
|
|
75155
|
+
"description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
|
|
75156
|
+
},
|
|
75157
|
+
"id": {
|
|
75158
|
+
"type": "string | number",
|
|
75159
|
+
"required": true,
|
|
75160
|
+
"description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
|
|
75161
|
+
},
|
|
75162
|
+
"opts": {
|
|
75163
|
+
"type": "object",
|
|
75164
|
+
"required": false,
|
|
75165
|
+
"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.",
|
|
75166
|
+
"properties": [
|
|
75167
|
+
{
|
|
75168
|
+
"name": "fresh",
|
|
75169
|
+
"type": "boolean",
|
|
75170
|
+
"optional": true
|
|
75171
|
+
}
|
|
75172
|
+
]
|
|
75173
|
+
}
|
|
75174
|
+
},
|
|
75093
75175
|
"inputSchemaStrict": true,
|
|
75094
75176
|
"outputSchema": {
|
|
75095
|
-
"type": "
|
|
75177
|
+
"type": "TaskAttachmentModel",
|
|
75096
75178
|
"drops": []
|
|
75097
75179
|
},
|
|
75098
75180
|
"examples": [
|
|
75099
|
-
"await client.
|
|
75181
|
+
"await client.taskAttachments.get('example-value', 'example-value')"
|
|
75100
75182
|
],
|
|
75101
75183
|
"permissions": "unknown",
|
|
75102
75184
|
"pagination": {
|
|
@@ -75107,17 +75189,17 @@ const CAPABILITY_DATA = {
|
|
|
75107
75189
|
"preset": "retry-ffb3a9cb"
|
|
75108
75190
|
},
|
|
75109
75191
|
"errors": {
|
|
75110
|
-
"set":
|
|
75192
|
+
"set": 3
|
|
75111
75193
|
},
|
|
75112
75194
|
"metadata": {
|
|
75113
|
-
"purpose": "Get
|
|
75114
|
-
"usage": "
|
|
75115
|
-
"preferredWhen":
|
|
75195
|
+
"purpose": "Get one attachment by task ID and attachment ID.",
|
|
75196
|
+
"usage": "Returns the attachment model directly; item: null or an empty model is a typed not-found. Parent-scoped: parentId is the task id, followed by the attachment id. A Tasks parent record is project-scoped elsewhere; do not substitute a project id or an attachment id for the task parent.",
|
|
75197
|
+
"preferredWhen": "Use a known attachment id; query the scoped collection to discover ids.",
|
|
75116
75198
|
"related": [
|
|
75117
|
-
"
|
|
75199
|
+
"task_attachments.query"
|
|
75118
75200
|
],
|
|
75201
|
+
"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 task_attachments.query with includeFields.",
|
|
75119
75202
|
"untrustedFields": [
|
|
75120
|
-
"description",
|
|
75121
75203
|
"title"
|
|
75122
75204
|
]
|
|
75123
75205
|
},
|
|
@@ -75125,24 +75207,24 @@ const CAPABILITY_DATA = {
|
|
|
75125
75207
|
"status": "tested"
|
|
75126
75208
|
},
|
|
75127
75209
|
{
|
|
75128
|
-
"id": "
|
|
75129
|
-
"resource": "
|
|
75210
|
+
"id": "task_attachments.getEntityInfo",
|
|
75211
|
+
"resource": "task_attachments",
|
|
75130
75212
|
"udfCapable": false,
|
|
75131
|
-
"operation": "
|
|
75213
|
+
"operation": "getEntityInfo",
|
|
75132
75214
|
"kind": "primitive",
|
|
75133
|
-
"endpoint": "GET /V1.0/
|
|
75215
|
+
"endpoint": "GET /V1.0/TaskAttachments/entityInformation",
|
|
75134
75216
|
"effect": "read",
|
|
75135
75217
|
"flags": [],
|
|
75136
75218
|
"dryRun": false,
|
|
75137
|
-
"envelope": "
|
|
75219
|
+
"envelope": "EntityInformationResultModel",
|
|
75138
75220
|
"inputSchema": {},
|
|
75139
75221
|
"inputSchemaStrict": true,
|
|
75140
75222
|
"outputSchema": {
|
|
75141
|
-
"type": "
|
|
75223
|
+
"type": "EntityInformationResultModel",
|
|
75142
75224
|
"drops": []
|
|
75143
75225
|
},
|
|
75144
75226
|
"examples": [
|
|
75145
|
-
"await client.
|
|
75227
|
+
"await client.taskAttachments.getEntityInfo()"
|
|
75146
75228
|
],
|
|
75147
75229
|
"permissions": "unknown",
|
|
75148
75230
|
"pagination": {
|
|
@@ -75153,18 +75235,16 @@ const CAPABILITY_DATA = {
|
|
|
75153
75235
|
"preset": "retry-ffb3a9cb"
|
|
75154
75236
|
},
|
|
75155
75237
|
"errors": {
|
|
75156
|
-
"set":
|
|
75238
|
+
"set": 12
|
|
75157
75239
|
},
|
|
75158
75240
|
"metadata": {
|
|
75159
|
-
"purpose": "Get the
|
|
75160
|
-
"usage": "Unwraps
|
|
75241
|
+
"purpose": "Get the TaskAttachment capability metadata (canCreate/canUpdate/hasUserDefinedFields/...).",
|
|
75242
|
+
"usage": "Unwraps info{}; drives client-side capability checks.",
|
|
75161
75243
|
"preferredWhen": null,
|
|
75162
75244
|
"related": [
|
|
75163
|
-
"
|
|
75164
|
-
"task_notes.getUdfInfo"
|
|
75245
|
+
"task_attachments.getFieldInfo"
|
|
75165
75246
|
],
|
|
75166
75247
|
"untrustedFields": [
|
|
75167
|
-
"description",
|
|
75168
75248
|
"title"
|
|
75169
75249
|
]
|
|
75170
75250
|
},
|
|
@@ -75172,24 +75252,24 @@ const CAPABILITY_DATA = {
|
|
|
75172
75252
|
"status": "tested"
|
|
75173
75253
|
},
|
|
75174
75254
|
{
|
|
75175
|
-
"id": "
|
|
75176
|
-
"resource": "
|
|
75255
|
+
"id": "task_attachments.getFieldInfo",
|
|
75256
|
+
"resource": "task_attachments",
|
|
75177
75257
|
"udfCapable": false,
|
|
75178
|
-
"operation": "
|
|
75258
|
+
"operation": "getFieldInfo",
|
|
75179
75259
|
"kind": "primitive",
|
|
75180
|
-
"endpoint": "GET /V1.0/
|
|
75260
|
+
"endpoint": "GET /V1.0/TaskAttachments/entityInformation/fields",
|
|
75181
75261
|
"effect": "read",
|
|
75182
75262
|
"flags": [],
|
|
75183
75263
|
"dryRun": false,
|
|
75184
|
-
"envelope": "
|
|
75264
|
+
"envelope": "FieldInformationResultModel",
|
|
75185
75265
|
"inputSchema": {},
|
|
75186
75266
|
"inputSchemaStrict": true,
|
|
75187
75267
|
"outputSchema": {
|
|
75188
|
-
"type": "
|
|
75268
|
+
"type": "FieldInformationResultModel",
|
|
75189
75269
|
"drops": []
|
|
75190
75270
|
},
|
|
75191
75271
|
"examples": [
|
|
75192
|
-
"await client.
|
|
75272
|
+
"await client.taskAttachments.getFieldInfo()"
|
|
75193
75273
|
],
|
|
75194
75274
|
"permissions": "unknown",
|
|
75195
75275
|
"pagination": {
|
|
@@ -75200,17 +75280,16 @@ const CAPABILITY_DATA = {
|
|
|
75200
75280
|
"preset": "retry-ffb3a9cb"
|
|
75201
75281
|
},
|
|
75202
75282
|
"errors": {
|
|
75203
|
-
"set":
|
|
75283
|
+
"set": 12
|
|
75204
75284
|
},
|
|
75205
75285
|
"metadata": {
|
|
75206
|
-
"purpose": "Get the
|
|
75207
|
-
"usage": "Unwraps fields[];
|
|
75286
|
+
"purpose": "Get the TaskAttachment field catalog (types, picklists, required, maxLength) — the full raw field dump (the largest read of the info trio; compact discovery: operations.fieldCatalog).",
|
|
75287
|
+
"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.",
|
|
75208
75288
|
"preferredWhen": null,
|
|
75209
75289
|
"related": [
|
|
75210
|
-
"
|
|
75290
|
+
"task_attachments.getEntityInfo"
|
|
75211
75291
|
],
|
|
75212
75292
|
"untrustedFields": [
|
|
75213
|
-
"description",
|
|
75214
75293
|
"title"
|
|
75215
75294
|
]
|
|
75216
75295
|
},
|
|
@@ -75218,12 +75297,12 @@ const CAPABILITY_DATA = {
|
|
|
75218
75297
|
"status": "tested"
|
|
75219
75298
|
},
|
|
75220
75299
|
{
|
|
75221
|
-
"id": "
|
|
75222
|
-
"resource": "
|
|
75300
|
+
"id": "task_attachments.query",
|
|
75301
|
+
"resource": "task_attachments",
|
|
75223
75302
|
"udfCapable": false,
|
|
75224
75303
|
"operation": "query",
|
|
75225
75304
|
"kind": "primitive",
|
|
75226
|
-
"endpoint": "GET|POST /V1.0/
|
|
75305
|
+
"endpoint": "GET|POST /V1.0/TaskAttachments/query",
|
|
75227
75306
|
"effect": "read",
|
|
75228
75307
|
"flags": [],
|
|
75229
75308
|
"dryRun": false,
|
|
@@ -75295,7 +75374,7 @@ const CAPABILITY_DATA = {
|
|
|
75295
75374
|
"drops": []
|
|
75296
75375
|
},
|
|
75297
75376
|
"examples": [
|
|
75298
|
-
"await invoke(client, '
|
|
75377
|
+
"await invoke(client, 'task_attachments.query', [{ filter: [{ field: 'taskID', op: 'eq', value: 7 }], limit: 25 }])"
|
|
75299
75378
|
],
|
|
75300
75379
|
"permissions": "unknown",
|
|
75301
75380
|
"pagination": {
|
|
@@ -75313,80 +75392,17 @@ const CAPABILITY_DATA = {
|
|
|
75313
75392
|
"preset": "retry-ffb3a9cb"
|
|
75314
75393
|
},
|
|
75315
75394
|
"errors": {
|
|
75316
|
-
"set":
|
|
75395
|
+
"set": 15
|
|
75317
75396
|
},
|
|
75318
75397
|
"metadata": {
|
|
75319
|
-
"purpose": "Query
|
|
75320
|
-
"usage": "Server-side pagination: one call walks the vendor cursor internally (page 1 POSTs the QueryModel body with MaxRecords = the walk's internal page size (at most 500; the default POST path — `via: 'get'` issues a GET on page 1); later pages POST the SAME body — IncludeFields, MaxRecords and the preserved filter — to the absolute vendor cursor, rebased to the client base URL; the vendor honours IncludeFields on a continuation and ignores MaxRecords there, so a later page carries the vendor's own page size) until the limit is met or the cursor is null; 1000-page guard (hasMore stays true at the guard). queryAll is the unbounded raw walk — only when you need the ENTIRE set and accept a large payload; default to the bounded query op. noteChars: N (integer >= 1) is an opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose — the same set the server wraps): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result (zero wire — response-side only). latest: N returns the N highest-id rows (id-descending): the vendor has no sort parameter — this is the only ordering channel, and a date window in `filter` narrows the cost; count-anchored — C ≤ 2500 → one count + a ≤6-page walk of the matching set, C > 2500 → count probes + an id-threshold window (≤64 probes; LATEST_THRESHOLD_UNRESOLVED on budget exhaustion), a blind count → a bounded walk with the blind-surface stamp (LATEST_WINDOW_INCOMPLETE on a truncated walk). Parent-scoped entity: the query stays global (filter with taskID 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.",
|
|
75398
|
+
"purpose": "Query TaskAttachment records with a JSON filter.",
|
|
75399
|
+
"usage": "Server-side pagination: one call walks the vendor cursor internally (page 1 POSTs the QueryModel body with MaxRecords = the walk's internal page size (at most 500; the default POST path — `via: 'get'` issues a GET on page 1); later pages POST the SAME body — IncludeFields, MaxRecords and the preserved filter — to the absolute vendor cursor, rebased to the client base URL; the vendor honours IncludeFields on a continuation and ignores MaxRecords there, so a later page carries the vendor's own page size) until the limit is met or the cursor is null; 1000-page guard (hasMore stays true at the guard). queryAll is the unbounded raw walk — only when you need the ENTIRE set and accept a large payload; default to the bounded query op. noteChars: N (integer >= 1) is an opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose — the same set the server wraps): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result (zero wire — response-side only). latest: N returns the N highest-id rows (id-descending): the vendor has no sort parameter — this is the only ordering channel, and a date window in `filter` narrows the cost; count-anchored — C ≤ 2500 → one count + a ≤6-page walk of the matching set, C > 2500 → count probes + an id-threshold window (≤64 probes; LATEST_THRESHOLD_UNRESOLVED on budget exhaustion), a blind count → a bounded walk with the blind-surface stamp (LATEST_WINDOW_INCOMPLETE on a truncated walk). Parent-scoped entity: the query stays global (filter with taskID 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. Filter by taskID for task scope. creatorType, data and fileSize are not queryable. Object-specific filters can include child attachments; 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. The common attachment changes contract permits child attachments in parent queries. A taskID match alone does not prove a direct task attachment, so createIfNotExists is refused; direct create remains available.",
|
|
75321
75400
|
"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).",
|
|
75322
|
-
"related": [],
|
|
75323
|
-
"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.",
|
|
75324
|
-
"untrustedFields": [
|
|
75325
|
-
"description",
|
|
75326
|
-
"title"
|
|
75327
|
-
]
|
|
75328
|
-
},
|
|
75329
|
-
"compact": null,
|
|
75330
|
-
"status": "tested"
|
|
75331
|
-
},
|
|
75332
|
-
{
|
|
75333
|
-
"id": "task_notes.update",
|
|
75334
|
-
"resource": "task_notes",
|
|
75335
|
-
"udfCapable": false,
|
|
75336
|
-
"operation": "update",
|
|
75337
|
-
"kind": "primitive",
|
|
75338
|
-
"endpoint": "PUT|PATCH /V1.0/Tasks/{parentId}/Notes",
|
|
75339
|
-
"effect": "write",
|
|
75340
|
-
"flags": [
|
|
75341
|
-
"idempotent"
|
|
75342
|
-
],
|
|
75343
|
-
"dryRun": true,
|
|
75344
|
-
"envelope": "OperationResultModel",
|
|
75345
|
-
"inputSchema": {
|
|
75346
|
-
"parentId": {
|
|
75347
|
-
"type": "string | number",
|
|
75348
|
-
"required": true,
|
|
75349
|
-
"description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
|
|
75350
|
-
},
|
|
75351
|
-
"id": {
|
|
75352
|
-
"type": "string | number",
|
|
75353
|
-
"required": true,
|
|
75354
|
-
"description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
|
|
75355
|
-
},
|
|
75356
|
-
"data": {
|
|
75357
|
-
"type": "object",
|
|
75358
|
-
"required": true,
|
|
75359
|
-
"description": "The record payload (vendor model fields)."
|
|
75360
|
-
}
|
|
75361
|
-
},
|
|
75362
|
-
"inputSchemaStrict": true,
|
|
75363
|
-
"outputSchema": {
|
|
75364
|
-
"type": "OperationResultModel",
|
|
75365
|
-
"drops": []
|
|
75366
|
-
},
|
|
75367
|
-
"examples": [
|
|
75368
|
-
"await client.taskNotes.update(7, 3, { description: 'Updated progress' }, { dryRun: true })"
|
|
75369
|
-
],
|
|
75370
|
-
"permissions": "unknown",
|
|
75371
|
-
"pagination": {
|
|
75372
|
-
"mode": "none"
|
|
75373
|
-
},
|
|
75374
|
-
"resolution": null,
|
|
75375
|
-
"retry": {
|
|
75376
|
-
"preset": "retry-85897a3a"
|
|
75377
|
-
},
|
|
75378
|
-
"errors": {
|
|
75379
|
-
"set": 1
|
|
75380
|
-
},
|
|
75381
|
-
"metadata": {
|
|
75382
|
-
"purpose": "Update a task note.",
|
|
75383
|
-
"usage": "Issues PATCH on the collection (swagger documents put+patch there; the node strips the id from the path and the vendor keys the record by the id in the body). TaskNoteModel has no supported lastModifiedDate stale token; preview reads a fresh record, without promising an atomic vendor precondition. Parent-scoped: parentId + id. Description writes use plain text and can lose existing rich text/images. Parent taskID is the path argument; a supplied taskID must match. Current field metadata supplies picklist values; no numeric value is presumed valid. Baseline-project notes are read-only. Task Category settings may require title. Writable fields: description (max 3200), title (max 250), noteType, publish, createdByContactID and matching taskID; creator/date fields and UDF writes are refused.",
|
|
75384
|
-
"preferredWhen": "Use when an existing task note needs a supported field change.",
|
|
75385
75401
|
"related": [
|
|
75386
|
-
"
|
|
75402
|
+
"task_attachments.get"
|
|
75387
75403
|
],
|
|
75404
|
+
"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.",
|
|
75388
75405
|
"untrustedFields": [
|
|
75389
|
-
"description",
|
|
75390
75406
|
"title"
|
|
75391
75407
|
]
|
|
75392
75408
|
},
|
|
@@ -75394,12 +75410,12 @@ const CAPABILITY_DATA = {
|
|
|
75394
75410
|
"status": "tested"
|
|
75395
75411
|
},
|
|
75396
75412
|
{
|
|
75397
|
-
"id": "
|
|
75398
|
-
"resource": "
|
|
75413
|
+
"id": "task_note_attachments.count",
|
|
75414
|
+
"resource": "task_note_attachments",
|
|
75399
75415
|
"udfCapable": false,
|
|
75400
75416
|
"operation": "count",
|
|
75401
75417
|
"kind": "primitive",
|
|
75402
|
-
"endpoint": "GET|POST /V1.0/
|
|
75418
|
+
"endpoint": "GET|POST /V1.0/TaskNoteAttachments/query/count",
|
|
75403
75419
|
"effect": "read",
|
|
75404
75420
|
"flags": [],
|
|
75405
75421
|
"dryRun": false,
|
|
@@ -75429,7 +75445,7 @@ const CAPABILITY_DATA = {
|
|
|
75429
75445
|
"drops": []
|
|
75430
75446
|
},
|
|
75431
75447
|
"examples": [
|
|
75432
|
-
"await invoke(client, '
|
|
75448
|
+
"await invoke(client, 'task_note_attachments.count', [{ filter: [{ field: 'taskNoteID', op: 'eq', value: 7 }] }])"
|
|
75433
75449
|
],
|
|
75434
75450
|
"permissions": "unknown",
|
|
75435
75451
|
"pagination": {
|
|
@@ -75443,24 +75459,27 @@ const CAPABILITY_DATA = {
|
|
|
75443
75459
|
"set": 0
|
|
75444
75460
|
},
|
|
75445
75461
|
"metadata": {
|
|
75446
|
-
"purpose": "Count task
|
|
75447
|
-
"usage": "Unwraps queryCount; returns a plain number.",
|
|
75462
|
+
"purpose": "Count task note attachment records matching a JSON filter. Use taskNoteID for note scope.",
|
|
75463
|
+
"usage": "Unwraps queryCount; returns a plain number. Include an object-specific taskNoteID filter. taskID is the separate task association; taskNoteID identifies the note parent. Do not substitute the task id for the note id. creatorType, data and fileSize are not queryable. Object-specific filters do not establish exact direct-parent attachment membership; an empty result is conditional on API-user permissions and visibility.",
|
|
75448
75464
|
"preferredWhen": null,
|
|
75449
75465
|
"related": [
|
|
75450
|
-
"
|
|
75466
|
+
"task_note_attachments.query"
|
|
75451
75467
|
],
|
|
75452
|
-
"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."
|
|
75468
|
+
"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.",
|
|
75469
|
+
"untrustedFields": [
|
|
75470
|
+
"title"
|
|
75471
|
+
]
|
|
75453
75472
|
},
|
|
75454
75473
|
"compact": null,
|
|
75455
75474
|
"status": "tested"
|
|
75456
75475
|
},
|
|
75457
75476
|
{
|
|
75458
|
-
"id": "
|
|
75459
|
-
"resource": "
|
|
75477
|
+
"id": "task_note_attachments.create",
|
|
75478
|
+
"resource": "task_note_attachments",
|
|
75460
75479
|
"udfCapable": false,
|
|
75461
75480
|
"operation": "create",
|
|
75462
75481
|
"kind": "primitive",
|
|
75463
|
-
"endpoint": "POST /V1.0/
|
|
75482
|
+
"endpoint": "POST /V1.0/TaskNotes/{parentId}/Attachments",
|
|
75464
75483
|
"effect": "write",
|
|
75465
75484
|
"flags": [],
|
|
75466
75485
|
"dryRun": true,
|
|
@@ -75483,7 +75502,7 @@ const CAPABILITY_DATA = {
|
|
|
75483
75502
|
"drops": []
|
|
75484
75503
|
},
|
|
75485
75504
|
"examples": [
|
|
75486
|
-
"await client.
|
|
75505
|
+
"const fields = await client.taskNoteAttachments.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.taskNoteAttachments.create(7, { attachmentType: 'FILE_ATTACHMENT', fullPath: 'note.txt', title: 'Supporting note', publish: Number(values[0].value), data: 'bm90ZQ==' }, { dryRun: true });"
|
|
75487
75506
|
],
|
|
75488
75507
|
"permissions": "unknown",
|
|
75489
75508
|
"pagination": {
|
|
@@ -75497,28 +75516,58 @@ const CAPABILITY_DATA = {
|
|
|
75497
75516
|
"set": 1
|
|
75498
75517
|
},
|
|
75499
75518
|
"metadata": {
|
|
75500
|
-
"purpose": "
|
|
75501
|
-
"usage": "
|
|
75502
|
-
"preferredWhen":
|
|
75503
|
-
"related": [
|
|
75519
|
+
"purpose": "Create a file attachment under a task note.",
|
|
75520
|
+
"usage": "Create a file under TaskNotes/{parentId}/Attachments; parentId is the task-note ID, not taskID. Required: explicit FILE_ATTACHMENT, title/fullPath (at most 255 characters), numeric publish from current metadata and base64 data. Existing attachments cannot be updated. taskID/taskNoteID 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 impersonation requires security permission, publish label ALL, an active contact/account, and a note created by that contact. Resource impersonation uses the configured header. Exact-parent deduplication is unproven; createIfNotExists is unsupported. No live create is claimed.",
|
|
75521
|
+
"preferredWhen": "Add a new attachment; existing attachments cannot be updated. Replace through separately governed delete and create actions.",
|
|
75522
|
+
"related": [
|
|
75523
|
+
"task_note_attachments.get"
|
|
75524
|
+
],
|
|
75525
|
+
"argNotes": {
|
|
75526
|
+
"data": "File uploads only. Optional attachedByContactID is the documented contact impersonation input; the vendor checks authorship of the task note, active contact/account, publish ALL and security permission. Read-only taskID/taskNoteID, audit/creator fields, contentType and fileSize are not create inputs. No parentAttachmentID on this model; nested attachments use the parent entity URL and do not retain note visibility. Other attachment types and UDF writes are unsupported."
|
|
75527
|
+
},
|
|
75528
|
+
"untrustedFields": [
|
|
75529
|
+
"title"
|
|
75530
|
+
],
|
|
75531
|
+
"createRequirements": {
|
|
75532
|
+
"requires": {
|
|
75533
|
+
"allOf": [
|
|
75534
|
+
"attachmentType",
|
|
75535
|
+
"fullPath",
|
|
75536
|
+
"title",
|
|
75537
|
+
"publish",
|
|
75538
|
+
"data"
|
|
75539
|
+
]
|
|
75540
|
+
},
|
|
75541
|
+
"requiresByValue": [
|
|
75542
|
+
{
|
|
75543
|
+
"field": "attachmentType",
|
|
75544
|
+
"value": "FILE_ATTACHMENT",
|
|
75545
|
+
"requires": {
|
|
75546
|
+
"allOf": [
|
|
75547
|
+
"data"
|
|
75548
|
+
]
|
|
75549
|
+
}
|
|
75550
|
+
}
|
|
75551
|
+
]
|
|
75552
|
+
}
|
|
75504
75553
|
},
|
|
75505
75554
|
"compact": null,
|
|
75506
75555
|
"status": "tested"
|
|
75507
75556
|
},
|
|
75508
75557
|
{
|
|
75509
|
-
"id": "
|
|
75510
|
-
"resource": "
|
|
75558
|
+
"id": "task_note_attachments.delete",
|
|
75559
|
+
"resource": "task_note_attachments",
|
|
75511
75560
|
"udfCapable": false,
|
|
75512
75561
|
"operation": "delete",
|
|
75513
75562
|
"kind": "primitive",
|
|
75514
|
-
"endpoint": "DELETE /V1.0/
|
|
75563
|
+
"endpoint": "DELETE /V1.0/TaskNotes/{parentId}/Attachments/{id}",
|
|
75515
75564
|
"effect": "destructive",
|
|
75516
75565
|
"flags": [
|
|
75517
75566
|
"idempotent",
|
|
75518
75567
|
"requiresApproval"
|
|
75519
75568
|
],
|
|
75520
75569
|
"dryRun": true,
|
|
75521
|
-
"envelope": "OperationResultModel",
|
|
75570
|
+
"envelope": "OperationResultModel (attachment entities: the deleted attachment model is returned, not OperationResultModel)",
|
|
75522
75571
|
"inputSchema": {
|
|
75523
75572
|
"parentId": {
|
|
75524
75573
|
"type": "string | number",
|
|
@@ -75533,11 +75582,11 @@ const CAPABILITY_DATA = {
|
|
|
75533
75582
|
},
|
|
75534
75583
|
"inputSchemaStrict": true,
|
|
75535
75584
|
"outputSchema": {
|
|
75536
|
-
"type": "OperationResultModel",
|
|
75585
|
+
"type": "OperationResultModel (attachment entities: the deleted attachment model is returned, not OperationResultModel)",
|
|
75537
75586
|
"drops": []
|
|
75538
75587
|
},
|
|
75539
75588
|
"examples": [
|
|
75540
|
-
"await invoke(client, '
|
|
75589
|
+
"await invoke(client, 'task_note_attachments.delete', [7, 3], { confirm: 'task_note_attachments.delete' })"
|
|
75541
75590
|
],
|
|
75542
75591
|
"permissions": "unknown",
|
|
75543
75592
|
"pagination": {
|
|
@@ -75551,27 +75600,30 @@ const CAPABILITY_DATA = {
|
|
|
75551
75600
|
"set": 2
|
|
75552
75601
|
},
|
|
75553
75602
|
"metadata": {
|
|
75554
|
-
"purpose": "Delete
|
|
75555
|
-
"usage": "
|
|
75603
|
+
"purpose": "Delete an attachment under a task note.",
|
|
75604
|
+
"usage": "Irreversible; dry-run validates the target id first. Parent-scoped: parentId + id.",
|
|
75556
75605
|
"preferredWhen": null,
|
|
75557
75606
|
"related": [
|
|
75558
|
-
"
|
|
75607
|
+
"task_note_attachments.get"
|
|
75608
|
+
],
|
|
75609
|
+
"untrustedFields": [
|
|
75610
|
+
"title"
|
|
75559
75611
|
]
|
|
75560
75612
|
},
|
|
75561
75613
|
"compact": null,
|
|
75562
75614
|
"status": "tested"
|
|
75563
75615
|
},
|
|
75564
75616
|
{
|
|
75565
|
-
"id": "
|
|
75566
|
-
"resource": "
|
|
75617
|
+
"id": "task_note_attachments.get",
|
|
75618
|
+
"resource": "task_note_attachments",
|
|
75567
75619
|
"udfCapable": false,
|
|
75568
75620
|
"operation": "get",
|
|
75569
75621
|
"kind": "primitive",
|
|
75570
|
-
"endpoint": "GET /V1.0/
|
|
75622
|
+
"endpoint": "GET /V1.0/TaskNotes/{parentId}/Attachments/{id}",
|
|
75571
75623
|
"effect": "read",
|
|
75572
75624
|
"flags": [],
|
|
75573
75625
|
"dryRun": false,
|
|
75574
|
-
"envelope": "
|
|
75626
|
+
"envelope": "TaskNoteAttachmentModel",
|
|
75575
75627
|
"inputSchema": {
|
|
75576
75628
|
"parentId": {
|
|
75577
75629
|
"type": "string | number",
|
|
@@ -75598,11 +75650,11 @@ const CAPABILITY_DATA = {
|
|
|
75598
75650
|
},
|
|
75599
75651
|
"inputSchemaStrict": true,
|
|
75600
75652
|
"outputSchema": {
|
|
75601
|
-
"type": "
|
|
75653
|
+
"type": "TaskNoteAttachmentModel",
|
|
75602
75654
|
"drops": []
|
|
75603
75655
|
},
|
|
75604
75656
|
"examples": [
|
|
75605
|
-
"await client.
|
|
75657
|
+
"await client.taskNoteAttachments.get(7, 3)"
|
|
75606
75658
|
],
|
|
75607
75659
|
"permissions": "unknown",
|
|
75608
75660
|
"pagination": {
|
|
@@ -75616,22 +75668,27 @@ const CAPABILITY_DATA = {
|
|
|
75616
75668
|
"set": 3
|
|
75617
75669
|
},
|
|
75618
75670
|
"metadata": {
|
|
75619
|
-
"purpose": "Get one
|
|
75620
|
-
"usage": "
|
|
75621
|
-
"preferredWhen": "
|
|
75622
|
-
"related": [
|
|
75623
|
-
|
|
75671
|
+
"purpose": "Get one TaskNoteAttachment by id.",
|
|
75672
|
+
"usage": "Returns the attachment model directly; item: null or an empty model is a typed not-found. Parent-scoped: parentId is the task-note id, followed by the attachment id.",
|
|
75673
|
+
"preferredWhen": "Use a known attachment id; query the scoped collection to discover ids.",
|
|
75674
|
+
"related": [
|
|
75675
|
+
"task_note_attachments.query"
|
|
75676
|
+
],
|
|
75677
|
+
"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 task_note_attachments.query with includeFields.",
|
|
75678
|
+
"untrustedFields": [
|
|
75679
|
+
"title"
|
|
75680
|
+
]
|
|
75624
75681
|
},
|
|
75625
75682
|
"compact": null,
|
|
75626
75683
|
"status": "tested"
|
|
75627
75684
|
},
|
|
75628
75685
|
{
|
|
75629
|
-
"id": "
|
|
75630
|
-
"resource": "
|
|
75686
|
+
"id": "task_note_attachments.getEntityInfo",
|
|
75687
|
+
"resource": "task_note_attachments",
|
|
75631
75688
|
"udfCapable": false,
|
|
75632
75689
|
"operation": "getEntityInfo",
|
|
75633
75690
|
"kind": "primitive",
|
|
75634
|
-
"endpoint": "GET /V1.0/
|
|
75691
|
+
"endpoint": "GET /V1.0/TaskNoteAttachments/entityInformation",
|
|
75635
75692
|
"effect": "read",
|
|
75636
75693
|
"flags": [],
|
|
75637
75694
|
"dryRun": false,
|
|
@@ -75643,7 +75700,7 @@ const CAPABILITY_DATA = {
|
|
|
75643
75700
|
"drops": []
|
|
75644
75701
|
},
|
|
75645
75702
|
"examples": [
|
|
75646
|
-
"await client.
|
|
75703
|
+
"await client.taskNoteAttachments.getEntityInfo()"
|
|
75647
75704
|
],
|
|
75648
75705
|
"permissions": "unknown",
|
|
75649
75706
|
"pagination": {
|
|
@@ -75657,23 +75714,26 @@ const CAPABILITY_DATA = {
|
|
|
75657
75714
|
"set": 0
|
|
75658
75715
|
},
|
|
75659
75716
|
"metadata": {
|
|
75660
|
-
"purpose": "Get the
|
|
75717
|
+
"purpose": "Get the TaskNoteAttachment capability metadata (canCreate/canUpdate/hasUserDefinedFields/...).",
|
|
75661
75718
|
"usage": "Unwraps info{}; drives client-side capability checks.",
|
|
75662
75719
|
"preferredWhen": null,
|
|
75663
75720
|
"related": [
|
|
75664
|
-
"
|
|
75721
|
+
"task_note_attachments.getFieldInfo"
|
|
75722
|
+
],
|
|
75723
|
+
"untrustedFields": [
|
|
75724
|
+
"title"
|
|
75665
75725
|
]
|
|
75666
75726
|
},
|
|
75667
75727
|
"compact": null,
|
|
75668
75728
|
"status": "tested"
|
|
75669
75729
|
},
|
|
75670
75730
|
{
|
|
75671
|
-
"id": "
|
|
75672
|
-
"resource": "
|
|
75731
|
+
"id": "task_note_attachments.getFieldInfo",
|
|
75732
|
+
"resource": "task_note_attachments",
|
|
75673
75733
|
"udfCapable": false,
|
|
75674
75734
|
"operation": "getFieldInfo",
|
|
75675
75735
|
"kind": "primitive",
|
|
75676
|
-
"endpoint": "GET /V1.0/
|
|
75736
|
+
"endpoint": "GET /V1.0/TaskNoteAttachments/entityInformation/fields",
|
|
75677
75737
|
"effect": "read",
|
|
75678
75738
|
"flags": [],
|
|
75679
75739
|
"dryRun": false,
|
|
@@ -75685,7 +75745,7 @@ const CAPABILITY_DATA = {
|
|
|
75685
75745
|
"drops": []
|
|
75686
75746
|
},
|
|
75687
75747
|
"examples": [
|
|
75688
|
-
"await client.
|
|
75748
|
+
"await client.taskNoteAttachments.getFieldInfo()"
|
|
75689
75749
|
],
|
|
75690
75750
|
"permissions": "unknown",
|
|
75691
75751
|
"pagination": {
|
|
@@ -75699,66 +75759,26 @@ const CAPABILITY_DATA = {
|
|
|
75699
75759
|
"set": 0
|
|
75700
75760
|
},
|
|
75701
75761
|
"metadata": {
|
|
75702
|
-
"purpose": "Get the
|
|
75762
|
+
"purpose": "Get the TaskNoteAttachment field catalog (types, picklists, required, maxLength) — the full raw field dump (the largest read of the info trio; compact discovery: operations.fieldCatalog).",
|
|
75703
75763
|
"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.",
|
|
75704
75764
|
"preferredWhen": null,
|
|
75705
75765
|
"related": [
|
|
75706
|
-
"
|
|
75707
|
-
|
|
75708
|
-
|
|
75709
|
-
|
|
75710
|
-
"compact": null,
|
|
75711
|
-
"status": "tested"
|
|
75712
|
-
},
|
|
75713
|
-
{
|
|
75714
|
-
"id": "task_predecessors.getUdfInfo",
|
|
75715
|
-
"resource": "task_predecessors",
|
|
75716
|
-
"udfCapable": false,
|
|
75717
|
-
"operation": "getUdfInfo",
|
|
75718
|
-
"kind": "primitive",
|
|
75719
|
-
"endpoint": "GET /V1.0/TaskPredecessors/entityInformation/userDefinedFields",
|
|
75720
|
-
"effect": "read",
|
|
75721
|
-
"flags": [],
|
|
75722
|
-
"dryRun": false,
|
|
75723
|
-
"envelope": "UserDefinedFieldInformationResultModel",
|
|
75724
|
-
"inputSchema": {},
|
|
75725
|
-
"inputSchemaStrict": true,
|
|
75726
|
-
"outputSchema": {
|
|
75727
|
-
"type": "UserDefinedFieldInformationResultModel",
|
|
75728
|
-
"drops": []
|
|
75729
|
-
},
|
|
75730
|
-
"examples": [
|
|
75731
|
-
"await client.taskPredecessors.getUdfInfo()"
|
|
75732
|
-
],
|
|
75733
|
-
"permissions": "unknown",
|
|
75734
|
-
"pagination": {
|
|
75735
|
-
"mode": "none"
|
|
75736
|
-
},
|
|
75737
|
-
"resolution": null,
|
|
75738
|
-
"retry": {
|
|
75739
|
-
"preset": "retry-ffb3a9cb"
|
|
75740
|
-
},
|
|
75741
|
-
"errors": {
|
|
75742
|
-
"set": 0
|
|
75743
|
-
},
|
|
75744
|
-
"metadata": {
|
|
75745
|
-
"purpose": "Get the TaskPredecessor user-defined-field catalog.",
|
|
75746
|
-
"usage": "Unwraps fields[]; only meaningful where the entity is UDF-capable. (entity is not UDF-capable; catalog is expected empty).",
|
|
75747
|
-
"preferredWhen": null,
|
|
75748
|
-
"related": [
|
|
75749
|
-
"task_predecessors.getFieldInfo"
|
|
75766
|
+
"task_note_attachments.getEntityInfo"
|
|
75767
|
+
],
|
|
75768
|
+
"untrustedFields": [
|
|
75769
|
+
"title"
|
|
75750
75770
|
]
|
|
75751
75771
|
},
|
|
75752
75772
|
"compact": null,
|
|
75753
75773
|
"status": "tested"
|
|
75754
75774
|
},
|
|
75755
75775
|
{
|
|
75756
|
-
"id": "
|
|
75757
|
-
"resource": "
|
|
75776
|
+
"id": "task_note_attachments.query",
|
|
75777
|
+
"resource": "task_note_attachments",
|
|
75758
75778
|
"udfCapable": false,
|
|
75759
75779
|
"operation": "query",
|
|
75760
75780
|
"kind": "primitive",
|
|
75761
|
-
"endpoint": "GET|POST /V1.0/
|
|
75781
|
+
"endpoint": "GET|POST /V1.0/TaskNoteAttachments/query",
|
|
75762
75782
|
"effect": "read",
|
|
75763
75783
|
"flags": [],
|
|
75764
75784
|
"dryRun": false,
|
|
@@ -75830,7 +75850,7 @@ const CAPABILITY_DATA = {
|
|
|
75830
75850
|
"drops": []
|
|
75831
75851
|
},
|
|
75832
75852
|
"examples": [
|
|
75833
|
-
"await invoke(client, '
|
|
75853
|
+
"await invoke(client, 'task_note_attachments.query', [{ filter: [{ field: 'taskNoteID', op: 'eq', value: 7 }], limit: 25 }])"
|
|
75834
75854
|
],
|
|
75835
75855
|
"permissions": "unknown",
|
|
75836
75856
|
"pagination": {
|
|
@@ -75851,80 +75871,27 @@ const CAPABILITY_DATA = {
|
|
|
75851
75871
|
"set": 4
|
|
75852
75872
|
},
|
|
75853
75873
|
"metadata": {
|
|
75854
|
-
"purpose": "Query
|
|
75855
|
-
"usage": "Server-side pagination: one call walks the vendor cursor internally (page 1 POSTs the QueryModel body with MaxRecords = the walk's internal page size (at most 500; the default POST path — `via: 'get'` issues a GET on page 1); later pages POST the SAME body — IncludeFields, MaxRecords and the preserved filter — to the absolute vendor cursor, rebased to the client base URL; the vendor honours IncludeFields on a continuation and ignores MaxRecords there, so a later page carries the vendor's own page size) until the limit is met or the cursor is null; 1000-page guard (hasMore stays true at the guard). queryAll is the unbounded raw walk — only when you need the ENTIRE set and accept a large payload; default to the bounded query op. noteChars: N (integer >= 1) is an opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose — the same set the server wraps): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result (zero wire — response-side only). latest: N returns the N highest-id rows (id-descending): the vendor has no sort parameter — this is the only ordering channel, and a date window in `filter` narrows the cost; count-anchored — C ≤ 2500 → one count + a ≤6-page walk of the matching set, C > 2500 → count probes + an id-threshold window (≤64 probes; LATEST_THRESHOLD_UNRESOLVED on budget exhaustion), a blind count → a bounded walk with the blind-surface stamp (LATEST_WINDOW_INCOMPLETE on a truncated walk). Parent-scoped entity: the query stays global (filter with
|
|
75874
|
+
"purpose": "Query TaskNoteAttachment records with a JSON filter.",
|
|
75875
|
+
"usage": "Server-side pagination: one call walks the vendor cursor internally (page 1 POSTs the QueryModel body with MaxRecords = the walk's internal page size (at most 500; the default POST path — `via: 'get'` issues a GET on page 1); later pages POST the SAME body — IncludeFields, MaxRecords and the preserved filter — to the absolute vendor cursor, rebased to the client base URL; the vendor honours IncludeFields on a continuation and ignores MaxRecords there, so a later page carries the vendor's own page size) until the limit is met or the cursor is null; 1000-page guard (hasMore stays true at the guard). queryAll is the unbounded raw walk — only when you need the ENTIRE set and accept a large payload; default to the bounded query op. noteChars: N (integer >= 1) is an opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose — the same set the server wraps): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result (zero wire — response-side only). latest: N returns the N highest-id rows (id-descending): the vendor has no sort parameter — this is the only ordering channel, and a date window in `filter` narrows the cost; count-anchored — C ≤ 2500 → one count + a ≤6-page walk of the matching set, C > 2500 → count probes + an id-threshold window (≤64 probes; LATEST_THRESHOLD_UNRESOLVED on budget exhaustion), a blind count → a bounded walk with the blind-surface stamp (LATEST_WINDOW_INCOMPLETE on a truncated walk). Parent-scoped entity: the query stays global (filter with taskNoteID 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 taskNoteID filter. taskID is the separate task association; taskNoteID identifies the note parent. Do not substitute the task id for the note id. creatorType, data and fileSize are not queryable. Object-specific filters do not establish exact direct-parent attachment membership; an empty result is conditional on API-user permissions and visibility. The Swagger query response names an attachment model, while this collection uses the existing SDK attachment query contract { items, pageDetails }; a bare-model response is rejected as INVALID_RESPONSE rather than guessed into a collection.",
|
|
75856
75876
|
"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).",
|
|
75857
|
-
"related": [
|
|
75858
|
-
|
|
75859
|
-
|
|
75860
|
-
|
|
75861
|
-
|
|
75862
|
-
|
|
75863
|
-
|
|
75864
|
-
"id": "task_predecessors.update",
|
|
75865
|
-
"resource": "task_predecessors",
|
|
75866
|
-
"udfCapable": false,
|
|
75867
|
-
"operation": "update",
|
|
75868
|
-
"kind": "primitive",
|
|
75869
|
-
"endpoint": "PATCH /V1.0/Tasks/{parentId}/Predecessors",
|
|
75870
|
-
"effect": "write",
|
|
75871
|
-
"flags": [
|
|
75872
|
-
"idempotent"
|
|
75873
|
-
],
|
|
75874
|
-
"dryRun": true,
|
|
75875
|
-
"envelope": "OperationResultModel",
|
|
75876
|
-
"inputSchema": {
|
|
75877
|
-
"parentId": {
|
|
75878
|
-
"type": "string | number",
|
|
75879
|
-
"required": true,
|
|
75880
|
-
"description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
|
|
75881
|
-
},
|
|
75882
|
-
"id": {
|
|
75883
|
-
"type": "string | number",
|
|
75884
|
-
"required": true,
|
|
75885
|
-
"description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
|
|
75886
|
-
},
|
|
75887
|
-
"data": {
|
|
75888
|
-
"type": "object",
|
|
75889
|
-
"required": true,
|
|
75890
|
-
"description": "The record payload (vendor model fields)."
|
|
75891
|
-
}
|
|
75892
|
-
},
|
|
75893
|
-
"inputSchemaStrict": true,
|
|
75894
|
-
"outputSchema": {
|
|
75895
|
-
"type": "OperationResultModel",
|
|
75896
|
-
"drops": []
|
|
75897
|
-
},
|
|
75898
|
-
"examples": [
|
|
75899
|
-
"await client.taskPredecessors.update(7, 3, { lagDays: 2 }, { dryRun: true })"
|
|
75900
|
-
],
|
|
75901
|
-
"permissions": "unknown",
|
|
75902
|
-
"pagination": {
|
|
75903
|
-
"mode": "none"
|
|
75904
|
-
},
|
|
75905
|
-
"resolution": null,
|
|
75906
|
-
"retry": {
|
|
75907
|
-
"preset": "retry-c5657094"
|
|
75908
|
-
},
|
|
75909
|
-
"errors": {
|
|
75910
|
-
"set": 1
|
|
75911
|
-
},
|
|
75912
|
-
"metadata": {
|
|
75913
|
-
"purpose": "update task predecessor relationships.",
|
|
75914
|
-
"usage": "The successorTaskID identifies the scoped Tasks parent. Predecessor and successor must be distinct tasks in the same project; mutations freshly read both documented task items to verify their identities and project. Phases are unsupported predecessors; baseline-project relationships are read-only. API-user module/security permissions and restricted task visibility remain vendor-enforced; an unreadable task refuses mutation without proving tenant absence. Only lagDays can be updated. No UDF writes or implicit dependency/cascade management. TaskPredecessorModel has no atomic stale token.",
|
|
75915
|
-
"preferredWhen": null,
|
|
75916
|
-
"related": []
|
|
75877
|
+
"related": [
|
|
75878
|
+
"task_note_attachments.get"
|
|
75879
|
+
],
|
|
75880
|
+
"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.",
|
|
75881
|
+
"untrustedFields": [
|
|
75882
|
+
"title"
|
|
75883
|
+
]
|
|
75917
75884
|
},
|
|
75918
75885
|
"compact": null,
|
|
75919
75886
|
"status": "tested"
|
|
75920
75887
|
},
|
|
75921
75888
|
{
|
|
75922
|
-
"id": "
|
|
75923
|
-
"resource": "
|
|
75889
|
+
"id": "task_notes.count",
|
|
75890
|
+
"resource": "task_notes",
|
|
75924
75891
|
"udfCapable": false,
|
|
75925
75892
|
"operation": "count",
|
|
75926
75893
|
"kind": "primitive",
|
|
75927
|
-
"endpoint": "GET|POST /V1.0/
|
|
75894
|
+
"endpoint": "GET|POST /V1.0/TaskNotes/query/count",
|
|
75928
75895
|
"effect": "read",
|
|
75929
75896
|
"flags": [],
|
|
75930
75897
|
"dryRun": false,
|
|
@@ -75954,7 +75921,7 @@ const CAPABILITY_DATA = {
|
|
|
75954
75921
|
"drops": []
|
|
75955
75922
|
},
|
|
75956
75923
|
"examples": [
|
|
75957
|
-
"await client.
|
|
75924
|
+
"await invoke(client, 'task_notes.count', [{ filter: [{ field: 'taskID', op: 'eq', value: 7 }] }])"
|
|
75958
75925
|
],
|
|
75959
75926
|
"permissions": "unknown",
|
|
75960
75927
|
"pagination": {
|
|
@@ -75968,24 +75935,28 @@ const CAPABILITY_DATA = {
|
|
|
75968
75935
|
"set": 0
|
|
75969
75936
|
},
|
|
75970
75937
|
"metadata": {
|
|
75971
|
-
"purpose": "Count
|
|
75938
|
+
"purpose": "Count task note records matching a JSON filter.",
|
|
75972
75939
|
"usage": "Unwraps queryCount; returns a plain number.",
|
|
75973
75940
|
"preferredWhen": null,
|
|
75974
75941
|
"related": [
|
|
75975
|
-
"
|
|
75942
|
+
"task_notes.query"
|
|
75976
75943
|
],
|
|
75977
|
-
"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."
|
|
75944
|
+
"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.",
|
|
75945
|
+
"untrustedFields": [
|
|
75946
|
+
"description",
|
|
75947
|
+
"title"
|
|
75948
|
+
]
|
|
75978
75949
|
},
|
|
75979
75950
|
"compact": null,
|
|
75980
75951
|
"status": "tested"
|
|
75981
75952
|
},
|
|
75982
75953
|
{
|
|
75983
|
-
"id": "
|
|
75984
|
-
"resource": "
|
|
75954
|
+
"id": "task_notes.create",
|
|
75955
|
+
"resource": "task_notes",
|
|
75985
75956
|
"udfCapable": false,
|
|
75986
75957
|
"operation": "create",
|
|
75987
75958
|
"kind": "primitive",
|
|
75988
|
-
"endpoint": "POST /V1.0/Tasks/{parentId}/
|
|
75959
|
+
"endpoint": "POST /V1.0/Tasks/{parentId}/Notes",
|
|
75989
75960
|
"effect": "write",
|
|
75990
75961
|
"flags": [],
|
|
75991
75962
|
"dryRun": true,
|
|
@@ -76008,7 +75979,7 @@ const CAPABILITY_DATA = {
|
|
|
76008
75979
|
"drops": []
|
|
76009
75980
|
},
|
|
76010
75981
|
"examples": [
|
|
76011
|
-
"await client.
|
|
75982
|
+
"const fields = await client.taskNotes.getFieldInfo();\nconst activeValue = (name) => {\n const field = fields.find(field => field.name === name && field.isPickList === true);\n const choice = field?.picklistValues?.find(choice => choice.isActive === true && typeof choice.value === 'string' && /^-?\\d+$/.test(choice.value) && Number.isSafeInteger(Number(choice.value)));\n if (!choice) throw new Error(`No active integer picklist choice is available for ${name}; check TaskNotes field metadata.`);\n return Number(choice.value);\n};\nconst noteType = activeValue('noteType');\nconst publish = activeValue('publish');\nawait client.taskNotes.create(7, { description: 'Work completed', title: 'Progress', noteType, publish, taskID: 7 }, { dryRun: true });"
|
|
76012
75983
|
],
|
|
76013
75984
|
"permissions": "unknown",
|
|
76014
75985
|
"pagination": {
|
|
@@ -76022,83 +75993,36 @@ const CAPABILITY_DATA = {
|
|
|
76022
75993
|
"set": 1
|
|
76023
75994
|
},
|
|
76024
75995
|
"metadata": {
|
|
76025
|
-
"purpose": "Create a
|
|
76026
|
-
"usage": "Returns OperationResultModel.itemId (the new id); the full record is not returned — follow up with get where needed. Parent-scoped: parentId is a path parameter.",
|
|
75996
|
+
"purpose": "Create a task note.",
|
|
75997
|
+
"usage": "Returns OperationResultModel.itemId (the new id); the full record is not returned — follow up with get where needed. Parent-scoped: parentId is a path parameter. Description writes use plain text and can lose existing rich text/images. The create body must include taskID equal to the parentId path argument; official documentation does not establish that the URL fills this required field. Current field metadata supplies picklist values; no numeric value is presumed valid. Baseline-project notes are read-only. Task Category settings may require title. Contact impersonation requires permission, publish ALL (resolve its value from current metadata), an active contact and account, and a task belonging to the contact's account or a child account. Writable fields: description (max 3200), title (max 250), noteType, publish, createdByContactID and matching taskID; creator/date fields and UDF writes are refused. Create requires description, noteType, publish and taskID.",
|
|
76027
75998
|
"preferredWhen": "Only for a record that does not exist yet; prefer update for an id you already have.",
|
|
76028
75999
|
"related": [
|
|
76029
|
-
"
|
|
76030
|
-
]
|
|
76031
|
-
|
|
76032
|
-
|
|
76033
|
-
|
|
76034
|
-
|
|
76035
|
-
{
|
|
76036
|
-
"id": "task_secondary_resources.delete",
|
|
76037
|
-
"resource": "task_secondary_resources",
|
|
76038
|
-
"udfCapable": false,
|
|
76039
|
-
"operation": "delete",
|
|
76040
|
-
"kind": "primitive",
|
|
76041
|
-
"endpoint": "DELETE /V1.0/Tasks/{parentId}/SecondaryResources/{id}",
|
|
76042
|
-
"effect": "destructive",
|
|
76043
|
-
"flags": [
|
|
76044
|
-
"idempotent",
|
|
76045
|
-
"requiresApproval"
|
|
76046
|
-
],
|
|
76047
|
-
"dryRun": true,
|
|
76048
|
-
"envelope": "OperationResultModel",
|
|
76049
|
-
"inputSchema": {
|
|
76050
|
-
"parentId": {
|
|
76051
|
-
"type": "string | number",
|
|
76052
|
-
"required": true,
|
|
76053
|
-
"description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
|
|
76000
|
+
"task_notes.update"
|
|
76001
|
+
],
|
|
76002
|
+
"deleteBoundary": {
|
|
76003
|
+
"resource": "task_notes",
|
|
76004
|
+
"note": "The vendor defines no DELETE for task_notes (spec-derived); a created task note cannot be removed through the public API.",
|
|
76005
|
+
"proof": "spec-derived"
|
|
76054
76006
|
},
|
|
76055
|
-
"
|
|
76056
|
-
"
|
|
76057
|
-
"
|
|
76058
|
-
"description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
|
|
76059
|
-
}
|
|
76060
|
-
},
|
|
76061
|
-
"inputSchemaStrict": true,
|
|
76062
|
-
"outputSchema": {
|
|
76063
|
-
"type": "OperationResultModel",
|
|
76064
|
-
"drops": []
|
|
76065
|
-
},
|
|
76066
|
-
"examples": [
|
|
76067
|
-
"await invoke(client, 'task_secondary_resources.delete', ['example-value', 'example-value'], { dryRun: false, confirm: 'task_secondary_resources.delete' })"
|
|
76068
|
-
],
|
|
76069
|
-
"permissions": "unknown",
|
|
76070
|
-
"pagination": {
|
|
76071
|
-
"mode": "none"
|
|
76072
|
-
},
|
|
76073
|
-
"resolution": null,
|
|
76074
|
-
"retry": {
|
|
76075
|
-
"preset": "retry-1849870d"
|
|
76076
|
-
},
|
|
76077
|
-
"errors": {
|
|
76078
|
-
"set": 2
|
|
76079
|
-
},
|
|
76080
|
-
"metadata": {
|
|
76081
|
-
"purpose": "Delete a project task secondary resource. (under a task)",
|
|
76082
|
-
"usage": "Irreversible; dry-run validates the target id first. Parent-scoped: parentId + id.",
|
|
76083
|
-
"preferredWhen": null,
|
|
76084
|
-
"related": [
|
|
76085
|
-
"task_secondary_resources.get"
|
|
76007
|
+
"untrustedFields": [
|
|
76008
|
+
"description",
|
|
76009
|
+
"title"
|
|
76086
76010
|
]
|
|
76087
76011
|
},
|
|
76088
76012
|
"compact": null,
|
|
76089
76013
|
"status": "tested"
|
|
76090
76014
|
},
|
|
76091
76015
|
{
|
|
76092
|
-
"id": "
|
|
76093
|
-
"resource": "
|
|
76016
|
+
"id": "task_notes.get",
|
|
76017
|
+
"resource": "task_notes",
|
|
76094
76018
|
"udfCapable": false,
|
|
76095
76019
|
"operation": "get",
|
|
76096
76020
|
"kind": "primitive",
|
|
76097
|
-
"endpoint": "GET /V1.0/Tasks/{parentId}/
|
|
76021
|
+
"endpoint": "GET /V1.0/Tasks/{parentId}/Notes/{id}",
|
|
76098
76022
|
"effect": "read",
|
|
76099
76023
|
"flags": [],
|
|
76100
76024
|
"dryRun": false,
|
|
76101
|
-
"envelope": "ItemQueryResultModel[
|
|
76025
|
+
"envelope": "ItemQueryResultModel[TaskNoteModel,TaskNote]",
|
|
76102
76026
|
"inputSchema": {
|
|
76103
76027
|
"parentId": {
|
|
76104
76028
|
"type": "string | number",
|
|
@@ -76125,11 +76049,11 @@ const CAPABILITY_DATA = {
|
|
|
76125
76049
|
},
|
|
76126
76050
|
"inputSchemaStrict": true,
|
|
76127
76051
|
"outputSchema": {
|
|
76128
|
-
"type": "ItemQueryResultModel[
|
|
76052
|
+
"type": "ItemQueryResultModel[TaskNoteModel,TaskNote]",
|
|
76129
76053
|
"drops": []
|
|
76130
76054
|
},
|
|
76131
76055
|
"examples": [
|
|
76132
|
-
"await client.
|
|
76056
|
+
"await client.taskNotes.get(7, 3)"
|
|
76133
76057
|
],
|
|
76134
76058
|
"permissions": "unknown",
|
|
76135
76059
|
"pagination": {
|
|
@@ -76143,24 +76067,26 @@ const CAPABILITY_DATA = {
|
|
|
76143
76067
|
"set": 3
|
|
76144
76068
|
},
|
|
76145
76069
|
"metadata": {
|
|
76146
|
-
"purpose": "Get one
|
|
76070
|
+
"purpose": "Get one TaskNote by id.",
|
|
76147
76071
|
"usage": "item: null on the 200 body maps to NotFoundError (vendor not-found signal). Parent-scoped: parentId + id.",
|
|
76148
|
-
"preferredWhen": "Preferred when the
|
|
76149
|
-
"related": [
|
|
76150
|
-
|
|
76151
|
-
|
|
76152
|
-
|
|
76072
|
+
"preferredWhen": "Preferred when the parent task ID and note ID are known; use a bounded taskID-filtered query to discover notes.",
|
|
76073
|
+
"related": [],
|
|
76074
|
+
"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 task_notes.query with includeFields.",
|
|
76075
|
+
"untrustedFields": [
|
|
76076
|
+
"description",
|
|
76077
|
+
"title"
|
|
76078
|
+
]
|
|
76153
76079
|
},
|
|
76154
76080
|
"compact": null,
|
|
76155
76081
|
"status": "tested"
|
|
76156
76082
|
},
|
|
76157
76083
|
{
|
|
76158
|
-
"id": "
|
|
76159
|
-
"resource": "
|
|
76084
|
+
"id": "task_notes.getEntityInfo",
|
|
76085
|
+
"resource": "task_notes",
|
|
76160
76086
|
"udfCapable": false,
|
|
76161
76087
|
"operation": "getEntityInfo",
|
|
76162
76088
|
"kind": "primitive",
|
|
76163
|
-
"endpoint": "GET /V1.0/
|
|
76089
|
+
"endpoint": "GET /V1.0/TaskNotes/entityInformation",
|
|
76164
76090
|
"effect": "read",
|
|
76165
76091
|
"flags": [],
|
|
76166
76092
|
"dryRun": false,
|
|
@@ -76172,7 +76098,7 @@ const CAPABILITY_DATA = {
|
|
|
76172
76098
|
"drops": []
|
|
76173
76099
|
},
|
|
76174
76100
|
"examples": [
|
|
76175
|
-
"await client.
|
|
76101
|
+
"await client.taskNotes.getEntityInfo()"
|
|
76176
76102
|
],
|
|
76177
76103
|
"permissions": "unknown",
|
|
76178
76104
|
"pagination": {
|
|
@@ -76186,23 +76112,27 @@ const CAPABILITY_DATA = {
|
|
|
76186
76112
|
"set": 0
|
|
76187
76113
|
},
|
|
76188
76114
|
"metadata": {
|
|
76189
|
-
"purpose": "Get the
|
|
76115
|
+
"purpose": "Get the TaskNote capability metadata (canCreate/canUpdate/hasUserDefinedFields/...).",
|
|
76190
76116
|
"usage": "Unwraps info{}; drives client-side capability checks.",
|
|
76191
76117
|
"preferredWhen": null,
|
|
76192
76118
|
"related": [
|
|
76193
|
-
"
|
|
76119
|
+
"task_notes.getFieldInfo"
|
|
76120
|
+
],
|
|
76121
|
+
"untrustedFields": [
|
|
76122
|
+
"description",
|
|
76123
|
+
"title"
|
|
76194
76124
|
]
|
|
76195
76125
|
},
|
|
76196
76126
|
"compact": null,
|
|
76197
76127
|
"status": "tested"
|
|
76198
76128
|
},
|
|
76199
76129
|
{
|
|
76200
|
-
"id": "
|
|
76201
|
-
"resource": "
|
|
76130
|
+
"id": "task_notes.getFieldInfo",
|
|
76131
|
+
"resource": "task_notes",
|
|
76202
76132
|
"udfCapable": false,
|
|
76203
76133
|
"operation": "getFieldInfo",
|
|
76204
76134
|
"kind": "primitive",
|
|
76205
|
-
"endpoint": "GET /V1.0/
|
|
76135
|
+
"endpoint": "GET /V1.0/TaskNotes/entityInformation/fields",
|
|
76206
76136
|
"effect": "read",
|
|
76207
76137
|
"flags": [],
|
|
76208
76138
|
"dryRun": false,
|
|
@@ -76214,7 +76144,7 @@ const CAPABILITY_DATA = {
|
|
|
76214
76144
|
"drops": []
|
|
76215
76145
|
},
|
|
76216
76146
|
"examples": [
|
|
76217
|
-
"await client.
|
|
76147
|
+
"await client.taskNotes.getFieldInfo()"
|
|
76218
76148
|
],
|
|
76219
76149
|
"permissions": "unknown",
|
|
76220
76150
|
"pagination": {
|
|
@@ -76228,24 +76158,28 @@ const CAPABILITY_DATA = {
|
|
|
76228
76158
|
"set": 0
|
|
76229
76159
|
},
|
|
76230
76160
|
"metadata": {
|
|
76231
|
-
"purpose": "Get the
|
|
76161
|
+
"purpose": "Get the TaskNote field catalog (types, picklists, required, maxLength) — the full raw field dump (the largest read of the info trio; compact discovery: operations.fieldCatalog).",
|
|
76232
76162
|
"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.",
|
|
76233
76163
|
"preferredWhen": null,
|
|
76234
76164
|
"related": [
|
|
76235
|
-
"
|
|
76236
|
-
"
|
|
76165
|
+
"task_notes.getEntityInfo",
|
|
76166
|
+
"task_notes.getUdfInfo"
|
|
76167
|
+
],
|
|
76168
|
+
"untrustedFields": [
|
|
76169
|
+
"description",
|
|
76170
|
+
"title"
|
|
76237
76171
|
]
|
|
76238
76172
|
},
|
|
76239
76173
|
"compact": null,
|
|
76240
76174
|
"status": "tested"
|
|
76241
76175
|
},
|
|
76242
76176
|
{
|
|
76243
|
-
"id": "
|
|
76244
|
-
"resource": "
|
|
76177
|
+
"id": "task_notes.getUdfInfo",
|
|
76178
|
+
"resource": "task_notes",
|
|
76245
76179
|
"udfCapable": false,
|
|
76246
76180
|
"operation": "getUdfInfo",
|
|
76247
76181
|
"kind": "primitive",
|
|
76248
|
-
"endpoint": "GET /V1.0/
|
|
76182
|
+
"endpoint": "GET /V1.0/TaskNotes/entityInformation/userDefinedFields",
|
|
76249
76183
|
"effect": "read",
|
|
76250
76184
|
"flags": [],
|
|
76251
76185
|
"dryRun": false,
|
|
@@ -76257,7 +76191,7 @@ const CAPABILITY_DATA = {
|
|
|
76257
76191
|
"drops": []
|
|
76258
76192
|
},
|
|
76259
76193
|
"examples": [
|
|
76260
|
-
"await client.
|
|
76194
|
+
"await client.taskNotes.getUdfInfo()"
|
|
76261
76195
|
],
|
|
76262
76196
|
"permissions": "unknown",
|
|
76263
76197
|
"pagination": {
|
|
@@ -76271,23 +76205,1091 @@ const CAPABILITY_DATA = {
|
|
|
76271
76205
|
"set": 0
|
|
76272
76206
|
},
|
|
76273
76207
|
"metadata": {
|
|
76274
|
-
"purpose": "Get the
|
|
76208
|
+
"purpose": "Get the TaskNote user-defined-field catalog.",
|
|
76275
76209
|
"usage": "Unwraps fields[]; only meaningful where the entity is UDF-capable. (entity is not UDF-capable; catalog is expected empty).",
|
|
76276
76210
|
"preferredWhen": null,
|
|
76277
76211
|
"related": [
|
|
76278
|
-
"
|
|
76212
|
+
"task_notes.getFieldInfo"
|
|
76213
|
+
],
|
|
76214
|
+
"untrustedFields": [
|
|
76215
|
+
"description",
|
|
76216
|
+
"title"
|
|
76279
76217
|
]
|
|
76280
76218
|
},
|
|
76281
76219
|
"compact": null,
|
|
76282
76220
|
"status": "tested"
|
|
76283
76221
|
},
|
|
76284
76222
|
{
|
|
76285
|
-
"id": "
|
|
76286
|
-
"resource": "
|
|
76223
|
+
"id": "task_notes.query",
|
|
76224
|
+
"resource": "task_notes",
|
|
76287
76225
|
"udfCapable": false,
|
|
76288
76226
|
"operation": "query",
|
|
76289
76227
|
"kind": "primitive",
|
|
76290
|
-
"endpoint": "GET|POST /V1.0/
|
|
76228
|
+
"endpoint": "GET|POST /V1.0/TaskNotes/query",
|
|
76229
|
+
"effect": "read",
|
|
76230
|
+
"flags": [],
|
|
76231
|
+
"dryRun": false,
|
|
76232
|
+
"envelope": "QueryActionResult[<Model>,<Entity>]",
|
|
76233
|
+
"inputSchema": {
|
|
76234
|
+
"params": {
|
|
76235
|
+
"type": "object",
|
|
76236
|
+
"required": false,
|
|
76237
|
+
"description": "The query params object (CLOSED — unknown keys are refused pre-request with a typed error naming the key + the valid keys): { filter?: FilterCondition[], limit?: number (total cap, default 500, max 2500 — NOT a page size), latest?: number (1-2500; the N highest-id rows — the vendor has no sort; count-probe + id-threshold semantics, see docs/API.md §4; the same-process latest-walk count probes are briefly cached per client — a 30 s TTL, cleared on a write through this client (a probe in flight across the write is discarded by the cache's invalidation epoch); the plain count op and aggregate stay fresh; limit and latest may coexist only when limit >= latest), noteChars?: number (integer >= 1; opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result), includeFields?: string[], fieldCheck?: boolean (default true: every includeFields NAME and every filter condition FIELD NAME is checked pre-request against the live field set (the vendored spec when that read faults — the resource's plan-pinned live-only fields, metadata.liveOnlyFields, are exempt from the vendored refusal: the live entity carries them and the vendor model omits them (e.g. time_entries postedDate/postedOnTime) — a truly unknown name is still refused); a refusal costs zero QUERY wire — the query POST and the count probe that anchors latest are never issued, a COLD fieldCache performs one authority metadata GET first (zero on a warm one); the one udf:true condition per query is exempt (a tenant UDF name is absent from the vendored spec by definition); false disables both name checks, never the shape/grammar checks; the count verb's bag is name-checked the same way and carries the same fieldCheck opt-out; a direct queryBounded/queryAll call is not checked (no bag contract there)), names?: boolean (absent = the client's labels option — OFF by default (the label pass costs a field-catalog read + up to 20 cold name reads per call; the MCP server (iit-mcp-autotask) enables the client labels option when it re-pins to this version (downstream)); true adds the row label siblings: picklist <field>Label (statusLabel), <fk>Name for companyID/contractID/ticketID/roleID/billingCodeID/*ResourceID (contractIDName, assignedResourceIDName) — null, never missing, when the field is keyed with a null value, a 0 id or an unresolved value (a picklist 0 is labelled when the picklist defines it); a names summary appears only when something was left unlabelled (the 20 uncached name-read cap or an unresolved picklist value); false = raw ids, ~30% smaller on a full tickets row), via?: \"post\" | \"get\" (vendor GET has a 2048-char cap), acknowledgeUnscoped?: boolean (query verb only; a walk expected to read over 500 rows with no id scope in the filter is guarded — one pre-flight <resource>.count, and a count over 500 refuses with the typed SCOPE_REQUIRED before the walk; true walks the unscoped set anyway; a count that fails or is blind lets the walk run and the result's scopeNote says so), walk?: object (walk.maxRows: positive integer — (D6): the walk's TOTAL row cap — serves at most maxRows rows in total; the page size stays min(500, limit), so one vendor page may fetch more rows than maxRows and the surplus is sliced off (fetched, not served); the result's truncated flag — false only when the cursor is exhausted, true iff more rows exist past the cap (so an exact-multiple count with a live next page reports true); not combinable with latest) }. Filter grammar: 13 operators (eq, noteq, gt, gte, lt, lte, beginsWith, endsWith, contains, exist, notExist, in, notIn; in/notIn: array or \"1,2,3\") + and/or grouping (no not-group); field names in vendor API casing (via operations.fieldCatalog); caps: 500 OR-conditions / 1 UDF / 8000 chars.",
|
|
76238
|
+
"properties": [
|
|
76239
|
+
{
|
|
76240
|
+
"name": "filter",
|
|
76241
|
+
"type": "FilterCondition[]",
|
|
76242
|
+
"optional": true
|
|
76243
|
+
},
|
|
76244
|
+
{
|
|
76245
|
+
"name": "limit",
|
|
76246
|
+
"type": "number",
|
|
76247
|
+
"optional": true,
|
|
76248
|
+
"default": 500
|
|
76249
|
+
},
|
|
76250
|
+
{
|
|
76251
|
+
"name": "latest",
|
|
76252
|
+
"type": "number",
|
|
76253
|
+
"optional": true
|
|
76254
|
+
},
|
|
76255
|
+
{
|
|
76256
|
+
"name": "noteChars",
|
|
76257
|
+
"type": "number",
|
|
76258
|
+
"optional": true
|
|
76259
|
+
},
|
|
76260
|
+
{
|
|
76261
|
+
"name": "includeFields",
|
|
76262
|
+
"type": "string[]",
|
|
76263
|
+
"optional": true
|
|
76264
|
+
},
|
|
76265
|
+
{
|
|
76266
|
+
"name": "fieldCheck",
|
|
76267
|
+
"type": "boolean",
|
|
76268
|
+
"optional": true,
|
|
76269
|
+
"default": true
|
|
76270
|
+
},
|
|
76271
|
+
{
|
|
76272
|
+
"name": "names",
|
|
76273
|
+
"type": "boolean",
|
|
76274
|
+
"optional": true
|
|
76275
|
+
},
|
|
76276
|
+
{
|
|
76277
|
+
"name": "via",
|
|
76278
|
+
"type": "\"post\" | \"get\"",
|
|
76279
|
+
"optional": true
|
|
76280
|
+
},
|
|
76281
|
+
{
|
|
76282
|
+
"name": "acknowledgeUnscoped",
|
|
76283
|
+
"type": "boolean",
|
|
76284
|
+
"optional": true
|
|
76285
|
+
},
|
|
76286
|
+
{
|
|
76287
|
+
"name": "walk",
|
|
76288
|
+
"type": "object",
|
|
76289
|
+
"optional": true
|
|
76290
|
+
}
|
|
76291
|
+
]
|
|
76292
|
+
}
|
|
76293
|
+
},
|
|
76294
|
+
"inputSchemaStrict": true,
|
|
76295
|
+
"outputSchema": {
|
|
76296
|
+
"type": "QueryActionResult[<Model>,<Entity>]",
|
|
76297
|
+
"drops": []
|
|
76298
|
+
},
|
|
76299
|
+
"examples": [
|
|
76300
|
+
"await invoke(client, 'task_notes.query', [{ filter: [{ field: 'taskID', op: 'eq', value: 7 }], limit: 25 }])"
|
|
76301
|
+
],
|
|
76302
|
+
"permissions": "unknown",
|
|
76303
|
+
"pagination": {
|
|
76304
|
+
"mode": "cursor",
|
|
76305
|
+
"vendorDefault": 10,
|
|
76306
|
+
"vendorMax": 500,
|
|
76307
|
+
"pageGuard": 1000,
|
|
76308
|
+
"queryBounded": {
|
|
76309
|
+
"default": 500,
|
|
76310
|
+
"max": 2500
|
|
76311
|
+
}
|
|
76312
|
+
},
|
|
76313
|
+
"resolution": null,
|
|
76314
|
+
"retry": {
|
|
76315
|
+
"preset": "retry-ffb3a9cb"
|
|
76316
|
+
},
|
|
76317
|
+
"errors": {
|
|
76318
|
+
"set": 4
|
|
76319
|
+
},
|
|
76320
|
+
"metadata": {
|
|
76321
|
+
"purpose": "Query TaskNote records with a JSON filter.",
|
|
76322
|
+
"usage": "Server-side pagination: one call walks the vendor cursor internally (page 1 POSTs the QueryModel body with MaxRecords = the walk's internal page size (at most 500; the default POST path — `via: 'get'` issues a GET on page 1); later pages POST the SAME body — IncludeFields, MaxRecords and the preserved filter — to the absolute vendor cursor, rebased to the client base URL; the vendor honours IncludeFields on a continuation and ignores MaxRecords there, so a later page carries the vendor's own page size) until the limit is met or the cursor is null; 1000-page guard (hasMore stays true at the guard). queryAll is the unbounded raw walk — only when you need the ENTIRE set and accept a large payload; default to the bounded query op. noteChars: N (integer >= 1) is an opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose — the same set the server wraps): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result (zero wire — response-side only). latest: N returns the N highest-id rows (id-descending): the vendor has no sort parameter — this is the only ordering channel, and a date window in `filter` narrows the cost; count-anchored — C ≤ 2500 → one count + a ≤6-page walk of the matching set, C > 2500 → count probes + an id-threshold window (≤64 probes; LATEST_THRESHOLD_UNRESOLVED on budget exhaustion), a blind count → a bounded walk with the blind-surface stamp (LATEST_WINDOW_INCOMPLETE on a truncated walk). Parent-scoped entity: the query stays global (filter with taskID 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.",
|
|
76323
|
+
"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).",
|
|
76324
|
+
"related": [],
|
|
76325
|
+
"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.",
|
|
76326
|
+
"untrustedFields": [
|
|
76327
|
+
"description",
|
|
76328
|
+
"title"
|
|
76329
|
+
]
|
|
76330
|
+
},
|
|
76331
|
+
"compact": null,
|
|
76332
|
+
"status": "tested"
|
|
76333
|
+
},
|
|
76334
|
+
{
|
|
76335
|
+
"id": "task_notes.update",
|
|
76336
|
+
"resource": "task_notes",
|
|
76337
|
+
"udfCapable": false,
|
|
76338
|
+
"operation": "update",
|
|
76339
|
+
"kind": "primitive",
|
|
76340
|
+
"endpoint": "PUT|PATCH /V1.0/Tasks/{parentId}/Notes",
|
|
76341
|
+
"effect": "write",
|
|
76342
|
+
"flags": [
|
|
76343
|
+
"idempotent"
|
|
76344
|
+
],
|
|
76345
|
+
"dryRun": true,
|
|
76346
|
+
"envelope": "OperationResultModel",
|
|
76347
|
+
"inputSchema": {
|
|
76348
|
+
"parentId": {
|
|
76349
|
+
"type": "string | number",
|
|
76350
|
+
"required": true,
|
|
76351
|
+
"description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
|
|
76352
|
+
},
|
|
76353
|
+
"id": {
|
|
76354
|
+
"type": "string | number",
|
|
76355
|
+
"required": true,
|
|
76356
|
+
"description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
|
|
76357
|
+
},
|
|
76358
|
+
"data": {
|
|
76359
|
+
"type": "object",
|
|
76360
|
+
"required": true,
|
|
76361
|
+
"description": "The record payload (vendor model fields)."
|
|
76362
|
+
}
|
|
76363
|
+
},
|
|
76364
|
+
"inputSchemaStrict": true,
|
|
76365
|
+
"outputSchema": {
|
|
76366
|
+
"type": "OperationResultModel",
|
|
76367
|
+
"drops": []
|
|
76368
|
+
},
|
|
76369
|
+
"examples": [
|
|
76370
|
+
"await client.taskNotes.update(7, 3, { description: 'Updated progress' }, { dryRun: true })"
|
|
76371
|
+
],
|
|
76372
|
+
"permissions": "unknown",
|
|
76373
|
+
"pagination": {
|
|
76374
|
+
"mode": "none"
|
|
76375
|
+
},
|
|
76376
|
+
"resolution": null,
|
|
76377
|
+
"retry": {
|
|
76378
|
+
"preset": "retry-85897a3a"
|
|
76379
|
+
},
|
|
76380
|
+
"errors": {
|
|
76381
|
+
"set": 1
|
|
76382
|
+
},
|
|
76383
|
+
"metadata": {
|
|
76384
|
+
"purpose": "Update a task note.",
|
|
76385
|
+
"usage": "Issues PATCH on the collection (swagger documents put+patch there; the node strips the id from the path and the vendor keys the record by the id in the body). TaskNoteModel has no supported lastModifiedDate stale token; preview reads a fresh record, without promising an atomic vendor precondition. Parent-scoped: parentId + id. Description writes use plain text and can lose existing rich text/images. Parent taskID is the path argument; a supplied taskID must match. Current field metadata supplies picklist values; no numeric value is presumed valid. Baseline-project notes are read-only. Task Category settings may require title. Writable fields: description (max 3200), title (max 250), noteType, publish, createdByContactID and matching taskID; creator/date fields and UDF writes are refused.",
|
|
76386
|
+
"preferredWhen": "Use when an existing task note needs a supported field change.",
|
|
76387
|
+
"related": [
|
|
76388
|
+
"task_notes.get"
|
|
76389
|
+
],
|
|
76390
|
+
"untrustedFields": [
|
|
76391
|
+
"description",
|
|
76392
|
+
"title"
|
|
76393
|
+
]
|
|
76394
|
+
},
|
|
76395
|
+
"compact": null,
|
|
76396
|
+
"status": "tested"
|
|
76397
|
+
},
|
|
76398
|
+
{
|
|
76399
|
+
"id": "task_predecessors.count",
|
|
76400
|
+
"resource": "task_predecessors",
|
|
76401
|
+
"udfCapable": false,
|
|
76402
|
+
"operation": "count",
|
|
76403
|
+
"kind": "primitive",
|
|
76404
|
+
"endpoint": "GET|POST /V1.0/TaskPredecessors/query/count",
|
|
76405
|
+
"effect": "read",
|
|
76406
|
+
"flags": [],
|
|
76407
|
+
"dryRun": false,
|
|
76408
|
+
"envelope": "QueryCountResultModel",
|
|
76409
|
+
"inputSchema": {
|
|
76410
|
+
"params": {
|
|
76411
|
+
"type": "object",
|
|
76412
|
+
"required": false,
|
|
76413
|
+
"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.",
|
|
76414
|
+
"properties": [
|
|
76415
|
+
{
|
|
76416
|
+
"name": "filter",
|
|
76417
|
+
"type": "FilterCondition[]",
|
|
76418
|
+
"optional": true
|
|
76419
|
+
},
|
|
76420
|
+
{
|
|
76421
|
+
"name": "fieldCheck",
|
|
76422
|
+
"type": "boolean",
|
|
76423
|
+
"optional": true
|
|
76424
|
+
}
|
|
76425
|
+
]
|
|
76426
|
+
}
|
|
76427
|
+
},
|
|
76428
|
+
"inputSchemaStrict": true,
|
|
76429
|
+
"outputSchema": {
|
|
76430
|
+
"type": "QueryCountResultModel",
|
|
76431
|
+
"drops": []
|
|
76432
|
+
},
|
|
76433
|
+
"examples": [
|
|
76434
|
+
"await invoke(client, 'task_predecessors.count', [{ filter: [{ field: 'successorTaskID', op: 'eq', value: 7 }] }])"
|
|
76435
|
+
],
|
|
76436
|
+
"permissions": "unknown",
|
|
76437
|
+
"pagination": {
|
|
76438
|
+
"mode": "none"
|
|
76439
|
+
},
|
|
76440
|
+
"resolution": null,
|
|
76441
|
+
"retry": {
|
|
76442
|
+
"preset": "retry-ffb3a9cb"
|
|
76443
|
+
},
|
|
76444
|
+
"errors": {
|
|
76445
|
+
"set": 0
|
|
76446
|
+
},
|
|
76447
|
+
"metadata": {
|
|
76448
|
+
"purpose": "Count task predecessor relationships matching a JSON filter.",
|
|
76449
|
+
"usage": "Unwraps queryCount; returns a plain number.",
|
|
76450
|
+
"preferredWhen": null,
|
|
76451
|
+
"related": [
|
|
76452
|
+
"task_predecessors.query"
|
|
76453
|
+
],
|
|
76454
|
+
"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."
|
|
76455
|
+
},
|
|
76456
|
+
"compact": null,
|
|
76457
|
+
"status": "tested"
|
|
76458
|
+
},
|
|
76459
|
+
{
|
|
76460
|
+
"id": "task_predecessors.create",
|
|
76461
|
+
"resource": "task_predecessors",
|
|
76462
|
+
"udfCapable": false,
|
|
76463
|
+
"operation": "create",
|
|
76464
|
+
"kind": "primitive",
|
|
76465
|
+
"endpoint": "POST /V1.0/Tasks/{parentId}/Predecessors",
|
|
76466
|
+
"effect": "write",
|
|
76467
|
+
"flags": [],
|
|
76468
|
+
"dryRun": true,
|
|
76469
|
+
"envelope": "OperationResultModel",
|
|
76470
|
+
"inputSchema": {
|
|
76471
|
+
"parentId": {
|
|
76472
|
+
"type": "string | number",
|
|
76473
|
+
"required": true,
|
|
76474
|
+
"description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
|
|
76475
|
+
},
|
|
76476
|
+
"data": {
|
|
76477
|
+
"type": "object",
|
|
76478
|
+
"required": true,
|
|
76479
|
+
"description": "The record payload (vendor model fields)."
|
|
76480
|
+
}
|
|
76481
|
+
},
|
|
76482
|
+
"inputSchemaStrict": true,
|
|
76483
|
+
"outputSchema": {
|
|
76484
|
+
"type": "OperationResultModel",
|
|
76485
|
+
"drops": []
|
|
76486
|
+
},
|
|
76487
|
+
"examples": [
|
|
76488
|
+
"await client.taskPredecessors.create(7, { predecessorTaskID: 8, successorTaskID: 7, lagDays: 2 }, { dryRun: true })"
|
|
76489
|
+
],
|
|
76490
|
+
"permissions": "unknown",
|
|
76491
|
+
"pagination": {
|
|
76492
|
+
"mode": "none"
|
|
76493
|
+
},
|
|
76494
|
+
"resolution": null,
|
|
76495
|
+
"retry": {
|
|
76496
|
+
"preset": "retry-c5657094"
|
|
76497
|
+
},
|
|
76498
|
+
"errors": {
|
|
76499
|
+
"set": 1
|
|
76500
|
+
},
|
|
76501
|
+
"metadata": {
|
|
76502
|
+
"purpose": "create task predecessor relationships.",
|
|
76503
|
+
"usage": "The successorTaskID identifies the scoped Tasks parent. Predecessor and successor must be distinct tasks in the same project; mutations freshly read both documented task items to verify their identities and project. Phases are unsupported predecessors; baseline-project relationships are read-only. API-user module/security permissions and restricted task visibility remain vendor-enforced; an unreadable task refuses mutation without proving tenant absence. Only lagDays can be updated. No UDF writes or implicit dependency/cascade management. TaskPredecessorModel has no atomic stale token.",
|
|
76504
|
+
"preferredWhen": null,
|
|
76505
|
+
"related": []
|
|
76506
|
+
},
|
|
76507
|
+
"compact": null,
|
|
76508
|
+
"status": "tested"
|
|
76509
|
+
},
|
|
76510
|
+
{
|
|
76511
|
+
"id": "task_predecessors.delete",
|
|
76512
|
+
"resource": "task_predecessors",
|
|
76513
|
+
"udfCapable": false,
|
|
76514
|
+
"operation": "delete",
|
|
76515
|
+
"kind": "primitive",
|
|
76516
|
+
"endpoint": "DELETE /V1.0/Tasks/{parentId}/Predecessors/{id}",
|
|
76517
|
+
"effect": "destructive",
|
|
76518
|
+
"flags": [
|
|
76519
|
+
"idempotent",
|
|
76520
|
+
"requiresApproval"
|
|
76521
|
+
],
|
|
76522
|
+
"dryRun": true,
|
|
76523
|
+
"envelope": "OperationResultModel",
|
|
76524
|
+
"inputSchema": {
|
|
76525
|
+
"parentId": {
|
|
76526
|
+
"type": "string | number",
|
|
76527
|
+
"required": true,
|
|
76528
|
+
"description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
|
|
76529
|
+
},
|
|
76530
|
+
"id": {
|
|
76531
|
+
"type": "string | number",
|
|
76532
|
+
"required": true,
|
|
76533
|
+
"description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
|
|
76534
|
+
}
|
|
76535
|
+
},
|
|
76536
|
+
"inputSchemaStrict": true,
|
|
76537
|
+
"outputSchema": {
|
|
76538
|
+
"type": "OperationResultModel",
|
|
76539
|
+
"drops": []
|
|
76540
|
+
},
|
|
76541
|
+
"examples": [
|
|
76542
|
+
"await invoke(client, 'task_predecessors.delete', ['example-value', 'example-value'], { dryRun: false, confirm: 'task_predecessors.delete' })"
|
|
76543
|
+
],
|
|
76544
|
+
"permissions": "unknown",
|
|
76545
|
+
"pagination": {
|
|
76546
|
+
"mode": "none"
|
|
76547
|
+
},
|
|
76548
|
+
"resolution": null,
|
|
76549
|
+
"retry": {
|
|
76550
|
+
"preset": "retry-1849870d"
|
|
76551
|
+
},
|
|
76552
|
+
"errors": {
|
|
76553
|
+
"set": 2
|
|
76554
|
+
},
|
|
76555
|
+
"metadata": {
|
|
76556
|
+
"purpose": "Delete one task predecessor relationship.",
|
|
76557
|
+
"usage": "The successorTaskID identifies the scoped Tasks parent. Predecessor and successor must be distinct tasks in the same project; mutations freshly read both documented task items to verify their identities and project. Phases are unsupported predecessors; baseline-project relationships are read-only. API-user module/security permissions and restricted task visibility remain vendor-enforced; an unreadable task refuses mutation without proving tenant absence. Only lagDays can be updated. No UDF writes or implicit dependency/cascade management. TaskPredecessorModel has no atomic stale token. Destructive invocation requires exact operation confirmation. Preview sends no mutation.",
|
|
76558
|
+
"preferredWhen": null,
|
|
76559
|
+
"related": [
|
|
76560
|
+
"task_predecessors.get"
|
|
76561
|
+
]
|
|
76562
|
+
},
|
|
76563
|
+
"compact": null,
|
|
76564
|
+
"status": "tested"
|
|
76565
|
+
},
|
|
76566
|
+
{
|
|
76567
|
+
"id": "task_predecessors.get",
|
|
76568
|
+
"resource": "task_predecessors",
|
|
76569
|
+
"udfCapable": false,
|
|
76570
|
+
"operation": "get",
|
|
76571
|
+
"kind": "primitive",
|
|
76572
|
+
"endpoint": "GET /V1.0/Tasks/{parentId}/Predecessors/{id}",
|
|
76573
|
+
"effect": "read",
|
|
76574
|
+
"flags": [],
|
|
76575
|
+
"dryRun": false,
|
|
76576
|
+
"envelope": "ItemQueryResultModel[TaskPredecessorModel,TaskPredecessor]",
|
|
76577
|
+
"inputSchema": {
|
|
76578
|
+
"parentId": {
|
|
76579
|
+
"type": "string | number",
|
|
76580
|
+
"required": true,
|
|
76581
|
+
"description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
|
|
76582
|
+
},
|
|
76583
|
+
"id": {
|
|
76584
|
+
"type": "string | number",
|
|
76585
|
+
"required": true,
|
|
76586
|
+
"description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
|
|
76587
|
+
},
|
|
76588
|
+
"opts": {
|
|
76589
|
+
"type": "object",
|
|
76590
|
+
"required": false,
|
|
76591
|
+
"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.",
|
|
76592
|
+
"properties": [
|
|
76593
|
+
{
|
|
76594
|
+
"name": "fresh",
|
|
76595
|
+
"type": "boolean",
|
|
76596
|
+
"optional": true
|
|
76597
|
+
}
|
|
76598
|
+
]
|
|
76599
|
+
}
|
|
76600
|
+
},
|
|
76601
|
+
"inputSchemaStrict": true,
|
|
76602
|
+
"outputSchema": {
|
|
76603
|
+
"type": "ItemQueryResultModel[TaskPredecessorModel,TaskPredecessor]",
|
|
76604
|
+
"drops": []
|
|
76605
|
+
},
|
|
76606
|
+
"examples": [
|
|
76607
|
+
"await client.taskPredecessors.get(7, 3)"
|
|
76608
|
+
],
|
|
76609
|
+
"permissions": "unknown",
|
|
76610
|
+
"pagination": {
|
|
76611
|
+
"mode": "none"
|
|
76612
|
+
},
|
|
76613
|
+
"resolution": null,
|
|
76614
|
+
"retry": {
|
|
76615
|
+
"preset": "retry-ffb3a9cb"
|
|
76616
|
+
},
|
|
76617
|
+
"errors": {
|
|
76618
|
+
"set": 3
|
|
76619
|
+
},
|
|
76620
|
+
"metadata": {
|
|
76621
|
+
"purpose": "Get one task predecessor relationship by successor task ID and relationship ID.",
|
|
76622
|
+
"usage": "The successorTaskID identifies the scoped Tasks parent. Predecessor and successor must be distinct tasks in the same project; mutations freshly read both documented task items to verify their identities and project. Phases are unsupported predecessors; baseline-project relationships are read-only. API-user module/security permissions and restricted task visibility remain vendor-enforced; an unreadable task refuses mutation without proving tenant absence. Only lagDays can be updated. No UDF writes or implicit dependency/cascade management. TaskPredecessorModel has no atomic stale token.",
|
|
76623
|
+
"preferredWhen": "Preferred when the successor task ID and relationship ID are known; use a bounded successorTaskID-filtered query to discover relationships.",
|
|
76624
|
+
"related": [],
|
|
76625
|
+
"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 task_predecessors.query with includeFields."
|
|
76626
|
+
},
|
|
76627
|
+
"compact": null,
|
|
76628
|
+
"status": "tested"
|
|
76629
|
+
},
|
|
76630
|
+
{
|
|
76631
|
+
"id": "task_predecessors.getEntityInfo",
|
|
76632
|
+
"resource": "task_predecessors",
|
|
76633
|
+
"udfCapable": false,
|
|
76634
|
+
"operation": "getEntityInfo",
|
|
76635
|
+
"kind": "primitive",
|
|
76636
|
+
"endpoint": "GET /V1.0/TaskPredecessors/entityInformation",
|
|
76637
|
+
"effect": "read",
|
|
76638
|
+
"flags": [],
|
|
76639
|
+
"dryRun": false,
|
|
76640
|
+
"envelope": "EntityInformationResultModel",
|
|
76641
|
+
"inputSchema": {},
|
|
76642
|
+
"inputSchemaStrict": true,
|
|
76643
|
+
"outputSchema": {
|
|
76644
|
+
"type": "EntityInformationResultModel",
|
|
76645
|
+
"drops": []
|
|
76646
|
+
},
|
|
76647
|
+
"examples": [
|
|
76648
|
+
"await client.taskPredecessors.getEntityInfo()"
|
|
76649
|
+
],
|
|
76650
|
+
"permissions": "unknown",
|
|
76651
|
+
"pagination": {
|
|
76652
|
+
"mode": "none"
|
|
76653
|
+
},
|
|
76654
|
+
"resolution": null,
|
|
76655
|
+
"retry": {
|
|
76656
|
+
"preset": "retry-ffb3a9cb"
|
|
76657
|
+
},
|
|
76658
|
+
"errors": {
|
|
76659
|
+
"set": 0
|
|
76660
|
+
},
|
|
76661
|
+
"metadata": {
|
|
76662
|
+
"purpose": "Get the TaskPredecessor capability metadata (canCreate/canUpdate/hasUserDefinedFields/...).",
|
|
76663
|
+
"usage": "Unwraps info{}; drives client-side capability checks.",
|
|
76664
|
+
"preferredWhen": null,
|
|
76665
|
+
"related": [
|
|
76666
|
+
"task_predecessors.getFieldInfo"
|
|
76667
|
+
]
|
|
76668
|
+
},
|
|
76669
|
+
"compact": null,
|
|
76670
|
+
"status": "tested"
|
|
76671
|
+
},
|
|
76672
|
+
{
|
|
76673
|
+
"id": "task_predecessors.getFieldInfo",
|
|
76674
|
+
"resource": "task_predecessors",
|
|
76675
|
+
"udfCapable": false,
|
|
76676
|
+
"operation": "getFieldInfo",
|
|
76677
|
+
"kind": "primitive",
|
|
76678
|
+
"endpoint": "GET /V1.0/TaskPredecessors/entityInformation/fields",
|
|
76679
|
+
"effect": "read",
|
|
76680
|
+
"flags": [],
|
|
76681
|
+
"dryRun": false,
|
|
76682
|
+
"envelope": "FieldInformationResultModel",
|
|
76683
|
+
"inputSchema": {},
|
|
76684
|
+
"inputSchemaStrict": true,
|
|
76685
|
+
"outputSchema": {
|
|
76686
|
+
"type": "FieldInformationResultModel",
|
|
76687
|
+
"drops": []
|
|
76688
|
+
},
|
|
76689
|
+
"examples": [
|
|
76690
|
+
"await client.taskPredecessors.getFieldInfo()"
|
|
76691
|
+
],
|
|
76692
|
+
"permissions": "unknown",
|
|
76693
|
+
"pagination": {
|
|
76694
|
+
"mode": "none"
|
|
76695
|
+
},
|
|
76696
|
+
"resolution": null,
|
|
76697
|
+
"retry": {
|
|
76698
|
+
"preset": "retry-ffb3a9cb"
|
|
76699
|
+
},
|
|
76700
|
+
"errors": {
|
|
76701
|
+
"set": 0
|
|
76702
|
+
},
|
|
76703
|
+
"metadata": {
|
|
76704
|
+
"purpose": "Get the TaskPredecessor field catalog (types, picklists, required, maxLength) — the full raw field dump (the largest read of the info trio; compact discovery: operations.fieldCatalog).",
|
|
76705
|
+
"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.",
|
|
76706
|
+
"preferredWhen": null,
|
|
76707
|
+
"related": [
|
|
76708
|
+
"task_predecessors.getEntityInfo",
|
|
76709
|
+
"task_predecessors.getUdfInfo"
|
|
76710
|
+
]
|
|
76711
|
+
},
|
|
76712
|
+
"compact": null,
|
|
76713
|
+
"status": "tested"
|
|
76714
|
+
},
|
|
76715
|
+
{
|
|
76716
|
+
"id": "task_predecessors.getUdfInfo",
|
|
76717
|
+
"resource": "task_predecessors",
|
|
76718
|
+
"udfCapable": false,
|
|
76719
|
+
"operation": "getUdfInfo",
|
|
76720
|
+
"kind": "primitive",
|
|
76721
|
+
"endpoint": "GET /V1.0/TaskPredecessors/entityInformation/userDefinedFields",
|
|
76722
|
+
"effect": "read",
|
|
76723
|
+
"flags": [],
|
|
76724
|
+
"dryRun": false,
|
|
76725
|
+
"envelope": "UserDefinedFieldInformationResultModel",
|
|
76726
|
+
"inputSchema": {},
|
|
76727
|
+
"inputSchemaStrict": true,
|
|
76728
|
+
"outputSchema": {
|
|
76729
|
+
"type": "UserDefinedFieldInformationResultModel",
|
|
76730
|
+
"drops": []
|
|
76731
|
+
},
|
|
76732
|
+
"examples": [
|
|
76733
|
+
"await client.taskPredecessors.getUdfInfo()"
|
|
76734
|
+
],
|
|
76735
|
+
"permissions": "unknown",
|
|
76736
|
+
"pagination": {
|
|
76737
|
+
"mode": "none"
|
|
76738
|
+
},
|
|
76739
|
+
"resolution": null,
|
|
76740
|
+
"retry": {
|
|
76741
|
+
"preset": "retry-ffb3a9cb"
|
|
76742
|
+
},
|
|
76743
|
+
"errors": {
|
|
76744
|
+
"set": 0
|
|
76745
|
+
},
|
|
76746
|
+
"metadata": {
|
|
76747
|
+
"purpose": "Get the TaskPredecessor user-defined-field catalog.",
|
|
76748
|
+
"usage": "Unwraps fields[]; only meaningful where the entity is UDF-capable. (entity is not UDF-capable; catalog is expected empty).",
|
|
76749
|
+
"preferredWhen": null,
|
|
76750
|
+
"related": [
|
|
76751
|
+
"task_predecessors.getFieldInfo"
|
|
76752
|
+
]
|
|
76753
|
+
},
|
|
76754
|
+
"compact": null,
|
|
76755
|
+
"status": "tested"
|
|
76756
|
+
},
|
|
76757
|
+
{
|
|
76758
|
+
"id": "task_predecessors.query",
|
|
76759
|
+
"resource": "task_predecessors",
|
|
76760
|
+
"udfCapable": false,
|
|
76761
|
+
"operation": "query",
|
|
76762
|
+
"kind": "primitive",
|
|
76763
|
+
"endpoint": "GET|POST /V1.0/TaskPredecessors/query",
|
|
76764
|
+
"effect": "read",
|
|
76765
|
+
"flags": [],
|
|
76766
|
+
"dryRun": false,
|
|
76767
|
+
"envelope": "QueryActionResult[<Model>,<Entity>]",
|
|
76768
|
+
"inputSchema": {
|
|
76769
|
+
"params": {
|
|
76770
|
+
"type": "object",
|
|
76771
|
+
"required": false,
|
|
76772
|
+
"description": "The query params object (CLOSED — unknown keys are refused pre-request with a typed error naming the key + the valid keys): { filter?: FilterCondition[], limit?: number (total cap, default 500, max 2500 — NOT a page size), latest?: number (1-2500; the N highest-id rows — the vendor has no sort; count-probe + id-threshold semantics, see docs/API.md §4; the same-process latest-walk count probes are briefly cached per client — a 30 s TTL, cleared on a write through this client (a probe in flight across the write is discarded by the cache's invalidation epoch); the plain count op and aggregate stay fresh; limit and latest may coexist only when limit >= latest), noteChars?: number (integer >= 1; opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result), includeFields?: string[], fieldCheck?: boolean (default true: every includeFields NAME and every filter condition FIELD NAME is checked pre-request against the live field set (the vendored spec when that read faults — the resource's plan-pinned live-only fields, metadata.liveOnlyFields, are exempt from the vendored refusal: the live entity carries them and the vendor model omits them (e.g. time_entries postedDate/postedOnTime) — a truly unknown name is still refused); a refusal costs zero QUERY wire — the query POST and the count probe that anchors latest are never issued, a COLD fieldCache performs one authority metadata GET first (zero on a warm one); the one udf:true condition per query is exempt (a tenant UDF name is absent from the vendored spec by definition); false disables both name checks, never the shape/grammar checks; the count verb's bag is name-checked the same way and carries the same fieldCheck opt-out; a direct queryBounded/queryAll call is not checked (no bag contract there)), names?: boolean (absent = the client's labels option — OFF by default (the label pass costs a field-catalog read + up to 20 cold name reads per call; the MCP server (iit-mcp-autotask) enables the client labels option when it re-pins to this version (downstream)); true adds the row label siblings: picklist <field>Label (statusLabel), <fk>Name for companyID/contractID/ticketID/roleID/billingCodeID/*ResourceID (contractIDName, assignedResourceIDName) — null, never missing, when the field is keyed with a null value, a 0 id or an unresolved value (a picklist 0 is labelled when the picklist defines it); a names summary appears only when something was left unlabelled (the 20 uncached name-read cap or an unresolved picklist value); false = raw ids, ~30% smaller on a full tickets row), via?: \"post\" | \"get\" (vendor GET has a 2048-char cap), acknowledgeUnscoped?: boolean (query verb only; a walk expected to read over 500 rows with no id scope in the filter is guarded — one pre-flight <resource>.count, and a count over 500 refuses with the typed SCOPE_REQUIRED before the walk; true walks the unscoped set anyway; a count that fails or is blind lets the walk run and the result's scopeNote says so), walk?: object (walk.maxRows: positive integer — (D6): the walk's TOTAL row cap — serves at most maxRows rows in total; the page size stays min(500, limit), so one vendor page may fetch more rows than maxRows and the surplus is sliced off (fetched, not served); the result's truncated flag — false only when the cursor is exhausted, true iff more rows exist past the cap (so an exact-multiple count with a live next page reports true); not combinable with latest) }. Filter grammar: 13 operators (eq, noteq, gt, gte, lt, lte, beginsWith, endsWith, contains, exist, notExist, in, notIn; in/notIn: array or \"1,2,3\") + and/or grouping (no not-group); field names in vendor API casing (via operations.fieldCatalog); caps: 500 OR-conditions / 1 UDF / 8000 chars.",
|
|
76773
|
+
"properties": [
|
|
76774
|
+
{
|
|
76775
|
+
"name": "filter",
|
|
76776
|
+
"type": "FilterCondition[]",
|
|
76777
|
+
"optional": true
|
|
76778
|
+
},
|
|
76779
|
+
{
|
|
76780
|
+
"name": "limit",
|
|
76781
|
+
"type": "number",
|
|
76782
|
+
"optional": true,
|
|
76783
|
+
"default": 500
|
|
76784
|
+
},
|
|
76785
|
+
{
|
|
76786
|
+
"name": "latest",
|
|
76787
|
+
"type": "number",
|
|
76788
|
+
"optional": true
|
|
76789
|
+
},
|
|
76790
|
+
{
|
|
76791
|
+
"name": "noteChars",
|
|
76792
|
+
"type": "number",
|
|
76793
|
+
"optional": true
|
|
76794
|
+
},
|
|
76795
|
+
{
|
|
76796
|
+
"name": "includeFields",
|
|
76797
|
+
"type": "string[]",
|
|
76798
|
+
"optional": true
|
|
76799
|
+
},
|
|
76800
|
+
{
|
|
76801
|
+
"name": "fieldCheck",
|
|
76802
|
+
"type": "boolean",
|
|
76803
|
+
"optional": true,
|
|
76804
|
+
"default": true
|
|
76805
|
+
},
|
|
76806
|
+
{
|
|
76807
|
+
"name": "names",
|
|
76808
|
+
"type": "boolean",
|
|
76809
|
+
"optional": true
|
|
76810
|
+
},
|
|
76811
|
+
{
|
|
76812
|
+
"name": "via",
|
|
76813
|
+
"type": "\"post\" | \"get\"",
|
|
76814
|
+
"optional": true
|
|
76815
|
+
},
|
|
76816
|
+
{
|
|
76817
|
+
"name": "acknowledgeUnscoped",
|
|
76818
|
+
"type": "boolean",
|
|
76819
|
+
"optional": true
|
|
76820
|
+
},
|
|
76821
|
+
{
|
|
76822
|
+
"name": "walk",
|
|
76823
|
+
"type": "object",
|
|
76824
|
+
"optional": true
|
|
76825
|
+
}
|
|
76826
|
+
]
|
|
76827
|
+
}
|
|
76828
|
+
},
|
|
76829
|
+
"inputSchemaStrict": true,
|
|
76830
|
+
"outputSchema": {
|
|
76831
|
+
"type": "QueryActionResult[<Model>,<Entity>]",
|
|
76832
|
+
"drops": []
|
|
76833
|
+
},
|
|
76834
|
+
"examples": [
|
|
76835
|
+
"await invoke(client, 'task_predecessors.query', [{ filter: [{ field: 'successorTaskID', op: 'eq', value: 7 }], limit: 25 }])"
|
|
76836
|
+
],
|
|
76837
|
+
"permissions": "unknown",
|
|
76838
|
+
"pagination": {
|
|
76839
|
+
"mode": "cursor",
|
|
76840
|
+
"vendorDefault": 10,
|
|
76841
|
+
"vendorMax": 500,
|
|
76842
|
+
"pageGuard": 1000,
|
|
76843
|
+
"queryBounded": {
|
|
76844
|
+
"default": 500,
|
|
76845
|
+
"max": 2500
|
|
76846
|
+
}
|
|
76847
|
+
},
|
|
76848
|
+
"resolution": null,
|
|
76849
|
+
"retry": {
|
|
76850
|
+
"preset": "retry-ffb3a9cb"
|
|
76851
|
+
},
|
|
76852
|
+
"errors": {
|
|
76853
|
+
"set": 4
|
|
76854
|
+
},
|
|
76855
|
+
"metadata": {
|
|
76856
|
+
"purpose": "Query TaskPredecessor records with a JSON filter.",
|
|
76857
|
+
"usage": "Server-side pagination: one call walks the vendor cursor internally (page 1 POSTs the QueryModel body with MaxRecords = the walk's internal page size (at most 500; the default POST path — `via: 'get'` issues a GET on page 1); later pages POST the SAME body — IncludeFields, MaxRecords and the preserved filter — to the absolute vendor cursor, rebased to the client base URL; the vendor honours IncludeFields on a continuation and ignores MaxRecords there, so a later page carries the vendor's own page size) until the limit is met or the cursor is null; 1000-page guard (hasMore stays true at the guard). queryAll is the unbounded raw walk — only when you need the ENTIRE set and accept a large payload; default to the bounded query op. noteChars: N (integer >= 1) is an opt-in per-field char cap on the untrusted-class free-text fields of the resource (notes/descriptions/UDF prose — the same set the server wraps): each capped value = the first N chars + the explicit marker … [+N chars truncated] (N = chars removed), applied at result-build BEFORE the server-side untrusted wrapper; absent = the raw, untruncated result (zero wire — response-side only). latest: N returns the N highest-id rows (id-descending): the vendor has no sort parameter — this is the only ordering channel, and a date window in `filter` narrows the cost; count-anchored — C ≤ 2500 → one count + a ≤6-page walk of the matching set, C > 2500 → count probes + an id-threshold window (≤64 probes; LATEST_THRESHOLD_UNRESOLVED on budget exhaustion), a blind count → a bounded walk with the blind-surface stamp (LATEST_WINDOW_INCOMPLETE on a truncated walk). Parent-scoped entity: the query stays global (filter with successorTaskID 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.",
|
|
76858
|
+
"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).",
|
|
76859
|
+
"related": [],
|
|
76860
|
+
"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."
|
|
76861
|
+
},
|
|
76862
|
+
"compact": null,
|
|
76863
|
+
"status": "tested"
|
|
76864
|
+
},
|
|
76865
|
+
{
|
|
76866
|
+
"id": "task_predecessors.update",
|
|
76867
|
+
"resource": "task_predecessors",
|
|
76868
|
+
"udfCapable": false,
|
|
76869
|
+
"operation": "update",
|
|
76870
|
+
"kind": "primitive",
|
|
76871
|
+
"endpoint": "PATCH /V1.0/Tasks/{parentId}/Predecessors",
|
|
76872
|
+
"effect": "write",
|
|
76873
|
+
"flags": [
|
|
76874
|
+
"idempotent"
|
|
76875
|
+
],
|
|
76876
|
+
"dryRun": true,
|
|
76877
|
+
"envelope": "OperationResultModel",
|
|
76878
|
+
"inputSchema": {
|
|
76879
|
+
"parentId": {
|
|
76880
|
+
"type": "string | number",
|
|
76881
|
+
"required": true,
|
|
76882
|
+
"description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
|
|
76883
|
+
},
|
|
76884
|
+
"id": {
|
|
76885
|
+
"type": "string | number",
|
|
76886
|
+
"required": true,
|
|
76887
|
+
"description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
|
|
76888
|
+
},
|
|
76889
|
+
"data": {
|
|
76890
|
+
"type": "object",
|
|
76891
|
+
"required": true,
|
|
76892
|
+
"description": "The record payload (vendor model fields)."
|
|
76893
|
+
}
|
|
76894
|
+
},
|
|
76895
|
+
"inputSchemaStrict": true,
|
|
76896
|
+
"outputSchema": {
|
|
76897
|
+
"type": "OperationResultModel",
|
|
76898
|
+
"drops": []
|
|
76899
|
+
},
|
|
76900
|
+
"examples": [
|
|
76901
|
+
"await client.taskPredecessors.update(7, 3, { lagDays: 2 }, { dryRun: true })"
|
|
76902
|
+
],
|
|
76903
|
+
"permissions": "unknown",
|
|
76904
|
+
"pagination": {
|
|
76905
|
+
"mode": "none"
|
|
76906
|
+
},
|
|
76907
|
+
"resolution": null,
|
|
76908
|
+
"retry": {
|
|
76909
|
+
"preset": "retry-c5657094"
|
|
76910
|
+
},
|
|
76911
|
+
"errors": {
|
|
76912
|
+
"set": 1
|
|
76913
|
+
},
|
|
76914
|
+
"metadata": {
|
|
76915
|
+
"purpose": "update task predecessor relationships.",
|
|
76916
|
+
"usage": "The successorTaskID identifies the scoped Tasks parent. Predecessor and successor must be distinct tasks in the same project; mutations freshly read both documented task items to verify their identities and project. Phases are unsupported predecessors; baseline-project relationships are read-only. API-user module/security permissions and restricted task visibility remain vendor-enforced; an unreadable task refuses mutation without proving tenant absence. Only lagDays can be updated. No UDF writes or implicit dependency/cascade management. TaskPredecessorModel has no atomic stale token.",
|
|
76917
|
+
"preferredWhen": null,
|
|
76918
|
+
"related": []
|
|
76919
|
+
},
|
|
76920
|
+
"compact": null,
|
|
76921
|
+
"status": "tested"
|
|
76922
|
+
},
|
|
76923
|
+
{
|
|
76924
|
+
"id": "task_secondary_resources.count",
|
|
76925
|
+
"resource": "task_secondary_resources",
|
|
76926
|
+
"udfCapable": false,
|
|
76927
|
+
"operation": "count",
|
|
76928
|
+
"kind": "primitive",
|
|
76929
|
+
"endpoint": "GET|POST /V1.0/TaskSecondaryResources/query/count",
|
|
76930
|
+
"effect": "read",
|
|
76931
|
+
"flags": [],
|
|
76932
|
+
"dryRun": false,
|
|
76933
|
+
"envelope": "QueryCountResultModel",
|
|
76934
|
+
"inputSchema": {
|
|
76935
|
+
"params": {
|
|
76936
|
+
"type": "object",
|
|
76937
|
+
"required": false,
|
|
76938
|
+
"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.",
|
|
76939
|
+
"properties": [
|
|
76940
|
+
{
|
|
76941
|
+
"name": "filter",
|
|
76942
|
+
"type": "FilterCondition[]",
|
|
76943
|
+
"optional": true
|
|
76944
|
+
},
|
|
76945
|
+
{
|
|
76946
|
+
"name": "fieldCheck",
|
|
76947
|
+
"type": "boolean",
|
|
76948
|
+
"optional": true
|
|
76949
|
+
}
|
|
76950
|
+
]
|
|
76951
|
+
}
|
|
76952
|
+
},
|
|
76953
|
+
"inputSchemaStrict": true,
|
|
76954
|
+
"outputSchema": {
|
|
76955
|
+
"type": "QueryCountResultModel",
|
|
76956
|
+
"drops": []
|
|
76957
|
+
},
|
|
76958
|
+
"examples": [
|
|
76959
|
+
"await client.taskSecondaryResources.count({ filter: [{ field: 'name', op: 'eq', value: 'example' }] })"
|
|
76960
|
+
],
|
|
76961
|
+
"permissions": "unknown",
|
|
76962
|
+
"pagination": {
|
|
76963
|
+
"mode": "none"
|
|
76964
|
+
},
|
|
76965
|
+
"resolution": null,
|
|
76966
|
+
"retry": {
|
|
76967
|
+
"preset": "retry-ffb3a9cb"
|
|
76968
|
+
},
|
|
76969
|
+
"errors": {
|
|
76970
|
+
"set": 0
|
|
76971
|
+
},
|
|
76972
|
+
"metadata": {
|
|
76973
|
+
"purpose": "Count project task secondary resource records matching a JSON filter. (under a task)",
|
|
76974
|
+
"usage": "Unwraps queryCount; returns a plain number.",
|
|
76975
|
+
"preferredWhen": null,
|
|
76976
|
+
"related": [
|
|
76977
|
+
"task_secondary_resources.query"
|
|
76978
|
+
],
|
|
76979
|
+
"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."
|
|
76980
|
+
},
|
|
76981
|
+
"compact": null,
|
|
76982
|
+
"status": "tested"
|
|
76983
|
+
},
|
|
76984
|
+
{
|
|
76985
|
+
"id": "task_secondary_resources.create",
|
|
76986
|
+
"resource": "task_secondary_resources",
|
|
76987
|
+
"udfCapable": false,
|
|
76988
|
+
"operation": "create",
|
|
76989
|
+
"kind": "primitive",
|
|
76990
|
+
"endpoint": "POST /V1.0/Tasks/{parentId}/SecondaryResources",
|
|
76991
|
+
"effect": "write",
|
|
76992
|
+
"flags": [],
|
|
76993
|
+
"dryRun": true,
|
|
76994
|
+
"envelope": "OperationResultModel",
|
|
76995
|
+
"inputSchema": {
|
|
76996
|
+
"parentId": {
|
|
76997
|
+
"type": "string | number",
|
|
76998
|
+
"required": true,
|
|
76999
|
+
"description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
|
|
77000
|
+
},
|
|
77001
|
+
"data": {
|
|
77002
|
+
"type": "object",
|
|
77003
|
+
"required": true,
|
|
77004
|
+
"description": "The record payload (vendor model fields)."
|
|
77005
|
+
}
|
|
77006
|
+
},
|
|
77007
|
+
"inputSchemaStrict": true,
|
|
77008
|
+
"outputSchema": {
|
|
77009
|
+
"type": "OperationResultModel",
|
|
77010
|
+
"drops": []
|
|
77011
|
+
},
|
|
77012
|
+
"examples": [
|
|
77013
|
+
"await client.taskSecondaryResources.create('example-value', { name: 'example' }, { dryRun: true })"
|
|
77014
|
+
],
|
|
77015
|
+
"permissions": "unknown",
|
|
77016
|
+
"pagination": {
|
|
77017
|
+
"mode": "none"
|
|
77018
|
+
},
|
|
77019
|
+
"resolution": null,
|
|
77020
|
+
"retry": {
|
|
77021
|
+
"preset": "retry-c5657094"
|
|
77022
|
+
},
|
|
77023
|
+
"errors": {
|
|
77024
|
+
"set": 1
|
|
77025
|
+
},
|
|
77026
|
+
"metadata": {
|
|
77027
|
+
"purpose": "Create a project task secondary resource. (under a task)",
|
|
77028
|
+
"usage": "Returns OperationResultModel.itemId (the new id); the full record is not returned — follow up with get where needed. Parent-scoped: parentId is a path parameter.",
|
|
77029
|
+
"preferredWhen": "Only for a record that does not exist yet; prefer update for an id you already have.",
|
|
77030
|
+
"related": [
|
|
77031
|
+
"task_secondary_resources.update"
|
|
77032
|
+
]
|
|
77033
|
+
},
|
|
77034
|
+
"compact": null,
|
|
77035
|
+
"status": "tested"
|
|
77036
|
+
},
|
|
77037
|
+
{
|
|
77038
|
+
"id": "task_secondary_resources.delete",
|
|
77039
|
+
"resource": "task_secondary_resources",
|
|
77040
|
+
"udfCapable": false,
|
|
77041
|
+
"operation": "delete",
|
|
77042
|
+
"kind": "primitive",
|
|
77043
|
+
"endpoint": "DELETE /V1.0/Tasks/{parentId}/SecondaryResources/{id}",
|
|
77044
|
+
"effect": "destructive",
|
|
77045
|
+
"flags": [
|
|
77046
|
+
"idempotent",
|
|
77047
|
+
"requiresApproval"
|
|
77048
|
+
],
|
|
77049
|
+
"dryRun": true,
|
|
77050
|
+
"envelope": "OperationResultModel",
|
|
77051
|
+
"inputSchema": {
|
|
77052
|
+
"parentId": {
|
|
77053
|
+
"type": "string | number",
|
|
77054
|
+
"required": true,
|
|
77055
|
+
"description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
|
|
77056
|
+
},
|
|
77057
|
+
"id": {
|
|
77058
|
+
"type": "string | number",
|
|
77059
|
+
"required": true,
|
|
77060
|
+
"description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
|
|
77061
|
+
}
|
|
77062
|
+
},
|
|
77063
|
+
"inputSchemaStrict": true,
|
|
77064
|
+
"outputSchema": {
|
|
77065
|
+
"type": "OperationResultModel",
|
|
77066
|
+
"drops": []
|
|
77067
|
+
},
|
|
77068
|
+
"examples": [
|
|
77069
|
+
"await invoke(client, 'task_secondary_resources.delete', ['example-value', 'example-value'], { dryRun: false, confirm: 'task_secondary_resources.delete' })"
|
|
77070
|
+
],
|
|
77071
|
+
"permissions": "unknown",
|
|
77072
|
+
"pagination": {
|
|
77073
|
+
"mode": "none"
|
|
77074
|
+
},
|
|
77075
|
+
"resolution": null,
|
|
77076
|
+
"retry": {
|
|
77077
|
+
"preset": "retry-1849870d"
|
|
77078
|
+
},
|
|
77079
|
+
"errors": {
|
|
77080
|
+
"set": 2
|
|
77081
|
+
},
|
|
77082
|
+
"metadata": {
|
|
77083
|
+
"purpose": "Delete a project task secondary resource. (under a task)",
|
|
77084
|
+
"usage": "Irreversible; dry-run validates the target id first. Parent-scoped: parentId + id.",
|
|
77085
|
+
"preferredWhen": null,
|
|
77086
|
+
"related": [
|
|
77087
|
+
"task_secondary_resources.get"
|
|
77088
|
+
]
|
|
77089
|
+
},
|
|
77090
|
+
"compact": null,
|
|
77091
|
+
"status": "tested"
|
|
77092
|
+
},
|
|
77093
|
+
{
|
|
77094
|
+
"id": "task_secondary_resources.get",
|
|
77095
|
+
"resource": "task_secondary_resources",
|
|
77096
|
+
"udfCapable": false,
|
|
77097
|
+
"operation": "get",
|
|
77098
|
+
"kind": "primitive",
|
|
77099
|
+
"endpoint": "GET /V1.0/Tasks/{parentId}/SecondaryResources/{id}",
|
|
77100
|
+
"effect": "read",
|
|
77101
|
+
"flags": [],
|
|
77102
|
+
"dryRun": false,
|
|
77103
|
+
"envelope": "ItemQueryResultModel[TaskSecondaryResourceModel,TaskSecondaryResource]",
|
|
77104
|
+
"inputSchema": {
|
|
77105
|
+
"parentId": {
|
|
77106
|
+
"type": "string | number",
|
|
77107
|
+
"required": true,
|
|
77108
|
+
"description": "The parent record id (parent-scoped collection; number, or a canonical integer string)."
|
|
77109
|
+
},
|
|
77110
|
+
"id": {
|
|
77111
|
+
"type": "string | number",
|
|
77112
|
+
"required": true,
|
|
77113
|
+
"description": "The record id (number, or a canonical integer string — ids beyond 2^53 are supported via the string form)."
|
|
77114
|
+
},
|
|
77115
|
+
"opts": {
|
|
77116
|
+
"type": "object",
|
|
77117
|
+
"required": false,
|
|
77118
|
+
"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.",
|
|
77119
|
+
"properties": [
|
|
77120
|
+
{
|
|
77121
|
+
"name": "fresh",
|
|
77122
|
+
"type": "boolean",
|
|
77123
|
+
"optional": true
|
|
77124
|
+
}
|
|
77125
|
+
]
|
|
77126
|
+
}
|
|
77127
|
+
},
|
|
77128
|
+
"inputSchemaStrict": true,
|
|
77129
|
+
"outputSchema": {
|
|
77130
|
+
"type": "ItemQueryResultModel[TaskSecondaryResourceModel,TaskSecondaryResource]",
|
|
77131
|
+
"drops": []
|
|
77132
|
+
},
|
|
77133
|
+
"examples": [
|
|
77134
|
+
"await client.taskSecondaryResources.get('example-value', 'example-value')"
|
|
77135
|
+
],
|
|
77136
|
+
"permissions": "unknown",
|
|
77137
|
+
"pagination": {
|
|
77138
|
+
"mode": "none"
|
|
77139
|
+
},
|
|
77140
|
+
"resolution": null,
|
|
77141
|
+
"retry": {
|
|
77142
|
+
"preset": "retry-ffb3a9cb"
|
|
77143
|
+
},
|
|
77144
|
+
"errors": {
|
|
77145
|
+
"set": 3
|
|
77146
|
+
},
|
|
77147
|
+
"metadata": {
|
|
77148
|
+
"purpose": "Get one TaskSecondaryResource by id.",
|
|
77149
|
+
"usage": "item: null on the 200 body maps to NotFoundError (vendor not-found signal). Parent-scoped: parentId + id.",
|
|
77150
|
+
"preferredWhen": "Preferred when the numeric id is already known; task_secondary_resources.resolve is for a field value.",
|
|
77151
|
+
"related": [
|
|
77152
|
+
"task_secondary_resources.resolve"
|
|
77153
|
+
],
|
|
77154
|
+
"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 task_secondary_resources.query with includeFields."
|
|
77155
|
+
},
|
|
77156
|
+
"compact": null,
|
|
77157
|
+
"status": "tested"
|
|
77158
|
+
},
|
|
77159
|
+
{
|
|
77160
|
+
"id": "task_secondary_resources.getEntityInfo",
|
|
77161
|
+
"resource": "task_secondary_resources",
|
|
77162
|
+
"udfCapable": false,
|
|
77163
|
+
"operation": "getEntityInfo",
|
|
77164
|
+
"kind": "primitive",
|
|
77165
|
+
"endpoint": "GET /V1.0/TaskSecondaryResources/entityInformation",
|
|
77166
|
+
"effect": "read",
|
|
77167
|
+
"flags": [],
|
|
77168
|
+
"dryRun": false,
|
|
77169
|
+
"envelope": "EntityInformationResultModel",
|
|
77170
|
+
"inputSchema": {},
|
|
77171
|
+
"inputSchemaStrict": true,
|
|
77172
|
+
"outputSchema": {
|
|
77173
|
+
"type": "EntityInformationResultModel",
|
|
77174
|
+
"drops": []
|
|
77175
|
+
},
|
|
77176
|
+
"examples": [
|
|
77177
|
+
"await client.taskSecondaryResources.getEntityInfo()"
|
|
77178
|
+
],
|
|
77179
|
+
"permissions": "unknown",
|
|
77180
|
+
"pagination": {
|
|
77181
|
+
"mode": "none"
|
|
77182
|
+
},
|
|
77183
|
+
"resolution": null,
|
|
77184
|
+
"retry": {
|
|
77185
|
+
"preset": "retry-ffb3a9cb"
|
|
77186
|
+
},
|
|
77187
|
+
"errors": {
|
|
77188
|
+
"set": 0
|
|
77189
|
+
},
|
|
77190
|
+
"metadata": {
|
|
77191
|
+
"purpose": "Get the TaskSecondaryResource capability metadata (canCreate/canUpdate/hasUserDefinedFields/...).",
|
|
77192
|
+
"usage": "Unwraps info{}; drives client-side capability checks.",
|
|
77193
|
+
"preferredWhen": null,
|
|
77194
|
+
"related": [
|
|
77195
|
+
"task_secondary_resources.getFieldInfo"
|
|
77196
|
+
]
|
|
77197
|
+
},
|
|
77198
|
+
"compact": null,
|
|
77199
|
+
"status": "tested"
|
|
77200
|
+
},
|
|
77201
|
+
{
|
|
77202
|
+
"id": "task_secondary_resources.getFieldInfo",
|
|
77203
|
+
"resource": "task_secondary_resources",
|
|
77204
|
+
"udfCapable": false,
|
|
77205
|
+
"operation": "getFieldInfo",
|
|
77206
|
+
"kind": "primitive",
|
|
77207
|
+
"endpoint": "GET /V1.0/TaskSecondaryResources/entityInformation/fields",
|
|
77208
|
+
"effect": "read",
|
|
77209
|
+
"flags": [],
|
|
77210
|
+
"dryRun": false,
|
|
77211
|
+
"envelope": "FieldInformationResultModel",
|
|
77212
|
+
"inputSchema": {},
|
|
77213
|
+
"inputSchemaStrict": true,
|
|
77214
|
+
"outputSchema": {
|
|
77215
|
+
"type": "FieldInformationResultModel",
|
|
77216
|
+
"drops": []
|
|
77217
|
+
},
|
|
77218
|
+
"examples": [
|
|
77219
|
+
"await client.taskSecondaryResources.getFieldInfo()"
|
|
77220
|
+
],
|
|
77221
|
+
"permissions": "unknown",
|
|
77222
|
+
"pagination": {
|
|
77223
|
+
"mode": "none"
|
|
77224
|
+
},
|
|
77225
|
+
"resolution": null,
|
|
77226
|
+
"retry": {
|
|
77227
|
+
"preset": "retry-ffb3a9cb"
|
|
77228
|
+
},
|
|
77229
|
+
"errors": {
|
|
77230
|
+
"set": 0
|
|
77231
|
+
},
|
|
77232
|
+
"metadata": {
|
|
77233
|
+
"purpose": "Get the TaskSecondaryResource field catalog (types, picklists, required, maxLength) — the full raw field dump (the largest read of the info trio; compact discovery: operations.fieldCatalog).",
|
|
77234
|
+
"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.",
|
|
77235
|
+
"preferredWhen": null,
|
|
77236
|
+
"related": [
|
|
77237
|
+
"task_secondary_resources.getEntityInfo",
|
|
77238
|
+
"task_secondary_resources.getUdfInfo"
|
|
77239
|
+
]
|
|
77240
|
+
},
|
|
77241
|
+
"compact": null,
|
|
77242
|
+
"status": "tested"
|
|
77243
|
+
},
|
|
77244
|
+
{
|
|
77245
|
+
"id": "task_secondary_resources.getUdfInfo",
|
|
77246
|
+
"resource": "task_secondary_resources",
|
|
77247
|
+
"udfCapable": false,
|
|
77248
|
+
"operation": "getUdfInfo",
|
|
77249
|
+
"kind": "primitive",
|
|
77250
|
+
"endpoint": "GET /V1.0/TaskSecondaryResources/entityInformation/userDefinedFields",
|
|
77251
|
+
"effect": "read",
|
|
77252
|
+
"flags": [],
|
|
77253
|
+
"dryRun": false,
|
|
77254
|
+
"envelope": "UserDefinedFieldInformationResultModel",
|
|
77255
|
+
"inputSchema": {},
|
|
77256
|
+
"inputSchemaStrict": true,
|
|
77257
|
+
"outputSchema": {
|
|
77258
|
+
"type": "UserDefinedFieldInformationResultModel",
|
|
77259
|
+
"drops": []
|
|
77260
|
+
},
|
|
77261
|
+
"examples": [
|
|
77262
|
+
"await client.taskSecondaryResources.getUdfInfo()"
|
|
77263
|
+
],
|
|
77264
|
+
"permissions": "unknown",
|
|
77265
|
+
"pagination": {
|
|
77266
|
+
"mode": "none"
|
|
77267
|
+
},
|
|
77268
|
+
"resolution": null,
|
|
77269
|
+
"retry": {
|
|
77270
|
+
"preset": "retry-ffb3a9cb"
|
|
77271
|
+
},
|
|
77272
|
+
"errors": {
|
|
77273
|
+
"set": 0
|
|
77274
|
+
},
|
|
77275
|
+
"metadata": {
|
|
77276
|
+
"purpose": "Get the TaskSecondaryResource user-defined-field catalog.",
|
|
77277
|
+
"usage": "Unwraps fields[]; only meaningful where the entity is UDF-capable. (entity is not UDF-capable; catalog is expected empty).",
|
|
77278
|
+
"preferredWhen": null,
|
|
77279
|
+
"related": [
|
|
77280
|
+
"task_secondary_resources.getFieldInfo"
|
|
77281
|
+
]
|
|
77282
|
+
},
|
|
77283
|
+
"compact": null,
|
|
77284
|
+
"status": "tested"
|
|
77285
|
+
},
|
|
77286
|
+
{
|
|
77287
|
+
"id": "task_secondary_resources.query",
|
|
77288
|
+
"resource": "task_secondary_resources",
|
|
77289
|
+
"udfCapable": false,
|
|
77290
|
+
"operation": "query",
|
|
77291
|
+
"kind": "primitive",
|
|
77292
|
+
"endpoint": "GET|POST /V1.0/TaskSecondaryResources/query",
|
|
76291
77293
|
"effect": "read",
|
|
76292
77294
|
"flags": [],
|
|
76293
77295
|
"dryRun": false,
|
|
@@ -83158,7 +84160,7 @@ const CAPABILITY_DATA = {
|
|
|
83158
84160
|
"preset": "retry-6980a375"
|
|
83159
84161
|
},
|
|
83160
84162
|
"errors": {
|
|
83161
|
-
"set":
|
|
84163
|
+
"set": 16
|
|
83162
84164
|
},
|
|
83163
84165
|
"metadata": {
|
|
83164
84166
|
"purpose": "Move a ticket to a target status in ONE op — the node validates targetStatus against the tenant's LIVE status picklist (entity metadata; vendor rejection is the fallback when the metadata is unavailable) + the live-discovered per-status required-field map and fills the proven-safe defaults itself (the vendor 500s when a target status has unsatisfied field requirements; the MCP LLM has no way to know the map).",
|
|
@@ -83563,7 +84565,7 @@ const CAPABILITY_DATA = {
|
|
|
83563
84565
|
"preset": "retry-ffb3a9cb"
|
|
83564
84566
|
},
|
|
83565
84567
|
"errors": {
|
|
83566
|
-
"set":
|
|
84568
|
+
"set": 17
|
|
83567
84569
|
},
|
|
83568
84570
|
"metadata": {
|
|
83569
84571
|
"purpose": "List the tickets a resource is assigned to — as primary owner, as a secondary resource, or both — de-duplicated, with the four reconciling counts and an optional open-only filter that uses the tenant's own closed-status set.",
|
|
@@ -84753,7 +85755,7 @@ const CAPABILITY_DATA = {
|
|
|
84753
85755
|
"preset": "retry-ffb3a9cb"
|
|
84754
85756
|
},
|
|
84755
85757
|
"errors": {
|
|
84756
|
-
"set":
|
|
85758
|
+
"set": 18
|
|
84757
85759
|
},
|
|
84758
85760
|
"metadata": {
|
|
84759
85761
|
"purpose": "Report the ticket status picklist and the ids this SDK treats as CLOSED for the caller's tenant, with the provenance of that set (read from the tenant's picklist, or the documented assumed fallback).",
|
|
@@ -85112,8 +86114,8 @@ const CAPABILITY_DATA = {
|
|
|
85112
86114
|
]
|
|
85113
86115
|
},
|
|
85114
86116
|
"operations": {
|
|
85115
|
-
"planHash": "
|
|
85116
|
-
"builtAt": "2026-11-
|
|
86117
|
+
"planHash": "ad752908bb8c2b868f1df63ba52fd308bd4eaec8e6c9c9182f97504ad79f5ca4",
|
|
86118
|
+
"builtAt": "2026-11-19T03:48:00.874Z",
|
|
85117
86119
|
"records": [
|
|
85118
86120
|
{
|
|
85119
86121
|
"id": "operations.aggregate",
|
|
@@ -85196,7 +86198,7 @@ const CAPABILITY_DATA = {
|
|
|
85196
86198
|
"preset": "retry-ffb3a9cb"
|
|
85197
86199
|
},
|
|
85198
86200
|
"errors": {
|
|
85199
|
-
"set":
|
|
86201
|
+
"set": 19
|
|
85200
86202
|
},
|
|
85201
86203
|
"metadata": {
|
|
85202
86204
|
"purpose": "Fold any query surface into groups/sums/totals in one bounded call — or count it with the vendor count endpoint when no folding is needed — with blind-surface and truncation honesty (caps documented: the walk scans at most 2500 rows and top keeps at most 100 groups — a truncated aggregate is a PARTIAL answer, never a tenant-wide total); date fields bucket via the closed groupBy suffix <field>@month | @week | @year (ISO labels, UTC-anchored). Use it for totals, sums, counts and hours per ticket, resource, company, contract or month (group by any field), e.g. time entries hours grouped by ticket and resource",
|
|
@@ -85277,7 +86279,7 @@ const CAPABILITY_DATA = {
|
|
|
85277
86279
|
"preset": "retry-ffb3a9cb"
|
|
85278
86280
|
},
|
|
85279
86281
|
"errors": {
|
|
85280
|
-
"set":
|
|
86282
|
+
"set": 20
|
|
85281
86283
|
},
|
|
85282
86284
|
"metadata": {
|
|
85283
86285
|
"purpose": "Accounts-receivable aging at a point in time, in one budgeted call: open invoices per company bucketed by days past due (current, 1-30, 31-60, 61-90, over 90, no due date), with totals per currency.",
|
|
@@ -85343,7 +86345,7 @@ const CAPABILITY_DATA = {
|
|
|
85343
86345
|
"preset": "retry-ffb3a9cb"
|
|
85344
86346
|
},
|
|
85345
86347
|
"errors": {
|
|
85346
|
-
"set":
|
|
86348
|
+
"set": 21
|
|
85347
86349
|
},
|
|
85348
86350
|
"metadata": {
|
|
85349
86351
|
"purpose": "Read static creation requirements, prior validation findings and unproven input guidance. This is not a live test of current-tenant capability, inventory or permissions.",
|
|
@@ -85539,7 +86541,7 @@ const CAPABILITY_DATA = {
|
|
|
85539
86541
|
"preset": "retry-ffb3a9cb"
|
|
85540
86542
|
},
|
|
85541
86543
|
"errors": {
|
|
85542
|
-
"set":
|
|
86544
|
+
"set": 22
|
|
85543
86545
|
},
|
|
85544
86546
|
"metadata": {
|
|
85545
86547
|
"purpose": "Fetch the LIVE vendor field catalog for the named resources in one bounded read call: which fields exist, which are required, types, maxLength, read-only, queryable, picklist-ness — the on-demand refresh for the point-in-time pins (operations.createGuidance, the zoneFacts) when the vendor has moved since they were verified. The wire cost (resources × include) is refused pre-request above the cap, never truncated; with the opt-in fieldCache configured, repeat reads inside the TTL cost no wire. It reports picklist-ness as a flag (isPickList) and picklist field NAMES (picklistFields); with the opt-in labels: true the projected picklist rows carry the vendor's exposed picklist VALUES (labels next to each value), and without it the op serves no VALUES. A picklist VALUE the vendor does not expose to this API user is not resolvable from this catalog.",
|
|
@@ -85636,7 +86638,7 @@ const CAPABILITY_DATA = {
|
|
|
85636
86638
|
"preset": "retry-ffb3a9cb"
|
|
85637
86639
|
},
|
|
85638
86640
|
"errors": {
|
|
85639
|
-
"set":
|
|
86641
|
+
"set": 20
|
|
85640
86642
|
},
|
|
85641
86643
|
"metadata": {
|
|
85642
86644
|
"purpose": "Non-chargeable work in one budgeted call: non-billable and contract-covered billing items (value, labour hours, lines) per company, contract or contract type, posted or invoiced or not.",
|
|
@@ -85753,7 +86755,7 @@ const CAPABILITY_DATA = {
|
|
|
85753
86755
|
"preset": "retry-ffb3a9cb"
|
|
85754
86756
|
},
|
|
85755
86757
|
"errors": {
|
|
85756
|
-
"set":
|
|
86758
|
+
"set": 23
|
|
85757
86759
|
},
|
|
85758
86760
|
"metadata": {
|
|
85759
86761
|
"purpose": "Contract profit and margin grouped by contract, company, contract type, vertical or month over a window, in one budgeted call: a contracts.profitability fan-out with totals and per-contract coverage gaps.",
|
|
@@ -85843,7 +86845,7 @@ const CAPABILITY_DATA = {
|
|
|
85843
86845
|
"preset": "retry-ffb3a9cb"
|
|
85844
86846
|
},
|
|
85845
86847
|
"errors": {
|
|
85846
|
-
"set":
|
|
86848
|
+
"set": 20
|
|
85847
86849
|
},
|
|
85848
86850
|
"metadata": {
|
|
85849
86851
|
"purpose": "Monthly recurring revenue at a point in time per company, in one budgeted call: contract services, subscriptions and the month's contract charges (usage billing, counted as recurring revenue) reported apart, plus the contracts ending soon.",
|
|
@@ -85898,7 +86900,7 @@ const CAPABILITY_DATA = {
|
|
|
85898
86900
|
"preset": "retry-ffb3a9cb"
|
|
85899
86901
|
},
|
|
85900
86902
|
"errors": {
|
|
85901
|
-
"set":
|
|
86903
|
+
"set": 21
|
|
85902
86904
|
},
|
|
85903
86905
|
"metadata": {
|
|
85904
86906
|
"purpose": "Describe a resource’s SDK-covered parent/child operations, lookup keys and static create guidance without a vendor call. Current-user visibility and tenant inventory require live reads.",
|
|
@@ -86310,7 +87312,7 @@ const CAPABILITY_DATA = {
|
|
|
86310
87312
|
"preset": "retry-ffb3a9cb"
|
|
86311
87313
|
},
|
|
86312
87314
|
"errors": {
|
|
86313
|
-
"set":
|
|
87315
|
+
"set": 20
|
|
86314
87316
|
},
|
|
86315
87317
|
"metadata": {
|
|
86316
87318
|
"purpose": "Total revenue grouped by account vertical, contract type, company, contract, month or line of business over an invoice-date window, in one budgeted call with totals, excluded buckets, a reconciliation and optional non-chargeable work.",
|
|
@@ -86370,7 +87372,7 @@ const CAPABILITY_DATA = {
|
|
|
86370
87372
|
"preset": "retry-ffb3a9cb"
|
|
86371
87373
|
},
|
|
86372
87374
|
"errors": {
|
|
86373
|
-
"set":
|
|
87375
|
+
"set": 24
|
|
86374
87376
|
},
|
|
86375
87377
|
"metadata": {
|
|
86376
87378
|
"purpose": "Fence the vendor free text of a raw SDK read result in the untrusted-content markers, using the operation's own registry record as the field authority.",
|
|
@@ -86638,7 +87640,7 @@ const CAPABILITY_DATA = {
|
|
|
86638
87640
|
"preset": "retry-ffb3a9cb"
|
|
86639
87641
|
},
|
|
86640
87642
|
"errors": {
|
|
86641
|
-
"set":
|
|
87643
|
+
"set": 24
|
|
86642
87644
|
},
|
|
86643
87645
|
"metadata": {
|
|
86644
87646
|
"purpose": "Build a clickable Autotask UI deep link for a record in one ZERO-wire call, e.g. for the time entry or ticket a response is about.",
|
|
@@ -86729,7 +87731,7 @@ const CAPABILITY_DATA = {
|
|
|
86729
87731
|
"preset": "retry-ffb3a9cb"
|
|
86730
87732
|
},
|
|
86731
87733
|
"errors": {
|
|
86732
|
-
"set":
|
|
87734
|
+
"set": 25
|
|
86733
87735
|
},
|
|
86734
87736
|
"metadata": {
|
|
86735
87737
|
"purpose": "Work in progress in one budgeted call: billable time entries no billing item references yet (unposted), in hours, per company, resource or contract type, split approved / unapproved where the tenant records approval.",
|