Records

PreviousI2x NextSites

List the records for a project

List the records for the specified project

get

/projects/{projectId}/records

Authorizations

Path parameters

projectIdstringrequired

The project ID

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.ecosuite.io//projects/{projectId}/records' \
  --header 'Authorization: YOUR_API_KEY'

200

400

{
  "records": [
    null,
    null
  ]
}

successful operation

Create a new project record with a server generated ID

post

/projects/{projectId}/records

Authorizations

Path parameters

projectIdstringrequired

The project ID

Body

one of

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.ecosuite.io//projects/{projectId}/records' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text","verified":false,"isContract":"yes","recordType":"financial","hiddenFields":[null],"contacts":[{"name":"text","type":"text"}],"notes":[{"note":"text","comments":[{"comment":"text"}]}]}'

200

400

{
  "record": {
    "name": "text",
    "verified": false,
    "isContract": "yes",
    "recordType": "financial",
    "hiddenFields": [
      "text"
    ],
    "contacts": [
      {
        "name": "text",
        "type": "text"
      }
    ],
    "notes": [
      {
        "note": "text",
        "comments": [
          {
            "comment": "text"
          }
        ]
      }
    ]
  }
}

successful operation

Update an existing project record

put

/projects/{projectId}/records/{recordId}

Authorizations

Path parameters

projectIdstringrequired

The project ID

recordIdstringrequired

The record ID

Body

one of

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://api.ecosuite.io//projects/{projectId}/records/{recordId}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text","verified":false,"isContract":"yes","recordType":"financial","hiddenFields":[null],"contacts":[{"name":"text","type":"text"}],"notes":[{"note":"text","comments":[{"comment":"text"}]}]}'

200

400

{
  "record": {
    "name": "text",
    "verified": false,
    "isContract": "yes",
    "recordType": "financial",
    "hiddenFields": [
      "text"
    ],
    "contacts": [
      {
        "name": "text",
        "type": "text"
      }
    ],
    "notes": [
      {
        "note": "text",
        "comments": [
          {
            "comment": "text"
          }
        ]
      }
    ]
  }
}

successful operation