Organization

"Organizations" acts as a container for managing infrastructure and object resources, providing a centralized platform for development and deployment. It allows for easier management of permissions, scalability, and collaboration among different stakeholders within the platform.

Organization Data Model

Name	Data Type	Description
_id	String	System-generated field that indicates org identifier.
name	String	Represents the name of an organization within the system.
domain	String	Represents the domain associated with an organization within the system.
_databaseName	String	System-generated field that indicates the database identifier.
_createdAt	Date	System-generated timestamp that denotes the date and time when an organization was created.
_createdBy	String	System-generated field that indicates the account who created.
_modifiedAt	Date	System-generated generated timestamp that denotes the date and time when a organization was modified.
_modifiedby	String	System-generated field that indicates the account who modified.

Example Organization

{
    "_id":"64392b37862be321e3598f58",
    "name":"Clinic",
    "domain":"clinic",
    "_databaseName":"clinic_64392b37862be321e3598f58",
    "_createdAt":
        {
            "$date":
                {
                    "$numberLong":"1681468215788"
                }
        },
    "_createdBy":"[email protected]",
    "_modifiedAt":
        {
            "$date":
                {
                    "$numberLong":"1681468215788"
                }
        },
    "_modifiedby":"[email protected]"
}

Create a new organization

post

Sample request:

POST api/v1/CreateOrganization
{
    "name": "Touchcore Systems",
    "domain": "TSPL"   
}

Authorizations

oauth2

AuthorizationstringRequired

Standard Authorization header using the Bearer scheme ("bearer {token}")

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

namestringRequired

domainstringRequired

Responses

200

Success

No content

401

Unauthorized

403

Forbidden

post

/api/v1/CreateOrganization

HTTPcURLJavaScriptPython

POST /api/v1/CreateOrganization HTTP/1.1
Host: api-qa.accelerator-platform.com/
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 31

{
  "name": "text",
  "domain": "text"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

No content

Get all organizations

get

Authorizations

oauth2

AuthorizationstringRequired

Standard Authorization header using the Bearer scheme ("bearer {token}")

Responses

200

Success

No content

401

Unauthorized

403

Forbidden

get

/api/v1/GetOrganizations

HTTPcURLJavaScriptPython

GET /api/v1/GetOrganizations HTTP/1.1
Host: api-qa.accelerator-platform.com/
Authorization: YOUR_API_KEY
Accept: */*

No content

Get an organization

get

Authorizations

oauth2

AuthorizationstringRequired

Standard Authorization header using the Bearer scheme ("bearer {token}")

Path parameters

idstringRequired

Responses

200

Success

No content

401

Unauthorized

403

Forbidden

get

/api/v1/GetOrganization/{id}

HTTPcURLJavaScriptPython

GET /api/v1/GetOrganization/{id} HTTP/1.1
Host: api-qa.accelerator-platform.com/
Authorization: YOUR_API_KEY
Accept: */*

No content