Get binder instances by period

GET /closeAPI/api/close/binder-instance
Oidc Oauth2

Query parameters

  • periodId integer Required

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • id integer
    • definition object
      Hide definition attributes Show definition attributes object
      • id integer
      • name string
      • description string
      • status string

        Values are ACTIVE, INACTIVE, DISABLED, NOT_STARTED, IN_PROGRESS, COMPLETE, or DELETED.

      • includesIssues boolean
      • includesDocuments boolean
      • includesAttachments boolean
      • includesReferences boolean
      • includesComments boolean
      • isActive boolean
      • isModifiable boolean
GET /closeAPI/api/close/binder-instance 
curl \
 --request GET 'https://customer.trintech.com/closeAPI/api/close/binder-instance?periodId=42'
Response examples (200) 
[
  {
    "id": 42,
    "definition": {
      "id": 42,
      "name": "string",
      "description": "string",
      "status": "ACTIVE",
      "includesIssues": true,
      "includesDocuments": true,
      "includesAttachments": true,
      "includesReferences": true,
      "includesComments": true,
      "isActive": true,
      "isModifiable": true
    }
  }
]