Antly

Namespace Reference

Objects and records

Curated JQL namespaces and examples for objects and records.

Objects namespaces power Antly custom data: object definitions, dynamic record namespaces, sections/questions, pipelines, quick actions, record documents, comments, scripts, and workflow bindings.

Key namespaces and models

  • objects.Object
  • objects.StaticObject
  • objects.Record
  • objects.Document
  • objects.Comment
  • objects.Edge
  • objects.Section
  • objects.Question
  • objects.Pipeline
  • objects.PipelineStage
  • objects.RecordPipelineHistory
  • objects.Workflow
  • objects.TriggerWorkflow
  • objects.TriggerWorkflowNode
  • objects.QuickAction
  • objects.QuickActionEvent
  • objects.ObjectScript
  • objects.<YourObject>

Common controller intents

  • objects.Object.irisCreateObject
  • objects.Object.irisUpdateObject
  • objects.Object.generateErd
  • objects.Object.forceDeleteWithRecords
  • objects.Object.testScript
  • objects.Record.saveWithInlines
  • objects.Record.retrieveWithInlines
  • objects.Record.progressPipelineStage
  • objects.Record.irisChatWithRecord
  • objects.PublicObject.retrieveObject
  • objects.PublicObject.createRecord

Common model intents

Most listed model namespaces support retrieve, retrieveOne, retrieveV2, create, update/patch, deleteOne, metadata, and aggregate subject to model permissions. Use consequence only for models that implement an on_<consequence> hook.

Retrieve example

json
1{ 2 "__meta__": { 3 "schema": "model", 4 "namespace": "objects.Object", 5 "intent": "retrieve", 6 "authenticationClass": "jwt", 7 "ordering": "-created", 8 "limit": 20 9 }, 10 "id": null, 11 "created": null 12}

Create example

json
1{ 2 "__meta__": { 3 "schema": "model", 4 "namespace": "objects.Object", 5 "intent": "create", 6 "authenticationClass": "jwt", 7 "return": { 8 "id": null, 9 "name": null, 10 "alias": null, 11 "namespace": null 12 } 13 }, 14 "name": "Customer", 15 "alias": "customer", 16 "namespace": "objects.Customer" 17}

For examples that include foreign keys, numeric ids must refer to records in the same tenant and visible to the authenticated user.

Dynamic record example

json
1{ 2 "__meta__": { 3 "schema": "model", 4 "namespace": "objects.Customer", 5 "intent": "retrieveV2", 6 "authenticationClass": "jwt", 7 "ordering": [ 8 "-created", 9 "id" 10 ], 11 "limit": 25 12 }, 13 "id": null, 14 "reference": null, 15 "additionalInformation": null, 16 "created": null 17}

objects.Customer is resolved to objects.Record with an injected filter on object.namespace.

Previous

System and identity

Next

Tasks and approvals