Back to top

API Documentation

< Back

Kuali Research REST APIs - System

Research System

Action Attributes

Get Action Attributes by Key
GET/research-sys/api/v1/action-attributes/(key)

Example URI

GET /research-sys/api/v1/action-attributes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "value": "(val)",
  "_primaryKey": "(val)"
}

Get All Action Attributes
GET/research-sys/api/v1/action-attributes/

Example URI

GET /research-sys/api/v1/action-attributes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Action Attributes with Filtering
GET/research-sys/api/v1/action-attributes/

Example URI

GET /research-sys/api/v1/action-attributes/
URI Parameters
HideShow
id
string (optional) 
value
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Action Attributes
GET/research-sys/api/v1/action-attributes/

Example URI

GET /research-sys/api/v1/action-attributes/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "value"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Action Attributes
GET/research-sys/api/v1/action-attributes/

Example URI

GET /research-sys/api/v1/action-attributes/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Action Attributes.md"
transfer-encoding: chunked

Update Action Attributes
PUT/research-sys/api/v1/action-attributes/(key)

Example URI

PUT /research-sys/api/v1/action-attributes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "value": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Action Attributes
PUT/research-sys/api/v1/action-attributes/

Example URI

PUT /research-sys/api/v1/action-attributes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Action Attributes
PATCH/research-sys/api/v1/action-attributes/(key)

Example URI

PATCH /research-sys/api/v1/action-attributes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "value": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "value": "(val)",
  "_primaryKey": "(val)"
}

Insert Action Attributes
POST/research-sys/api/v1/action-attributes/

Example URI

POST /research-sys/api/v1/action-attributes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "value": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "value": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Action Attributes
POST/research-sys/api/v1/action-attributes/

Example URI

POST /research-sys/api/v1/action-attributes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Action Attributes by Key
DELETE/research-sys/api/v1/action-attributes/(key)

Example URI

DELETE /research-sys/api/v1/action-attributes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Action Attributes
DELETE/research-sys/api/v1/action-attributes/

Example URI

DELETE /research-sys/api/v1/action-attributes/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Action Attributes with Matching
DELETE/research-sys/api/v1/action-attributes/

Example URI

DELETE /research-sys/api/v1/action-attributes/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 
value
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Actions

Get Actions by Key
GET/research-sys/api/v1/actions/(key)

Example URI

GET /research-sys/api/v1/actions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "namespace": "(val)",
  "name": "(val)",
  "description": "(val)",
  "typeId": "(val)",
  "sequenceNumber": "(val)",
  "_primaryKey": "(val)"
}

Get All Actions
GET/research-sys/api/v1/actions/

Example URI

GET /research-sys/api/v1/actions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "namespace": "(val)",
    "name": "(val)",
    "description": "(val)",
    "typeId": "(val)",
    "sequenceNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "namespace": "(val)",
    "name": "(val)",
    "description": "(val)",
    "typeId": "(val)",
    "sequenceNumber": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Actions with Filtering
GET/research-sys/api/v1/actions/

Example URI

GET /research-sys/api/v1/actions/
URI Parameters
HideShow
id
string (optional) 

Action Id.

namespace
string (optional) 

Action Namespace.

name
string (optional) 

Action Name.

description
string (optional) 

Action Description.

typeId
string (optional) 

Action Type Id.

sequenceNumber
string (optional) 

Sequence Number.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "namespace": "(val)",
    "name": "(val)",
    "description": "(val)",
    "typeId": "(val)",
    "sequenceNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "namespace": "(val)",
    "name": "(val)",
    "description": "(val)",
    "typeId": "(val)",
    "sequenceNumber": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Actions
GET/research-sys/api/v1/actions/

Example URI

GET /research-sys/api/v1/actions/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "namespace",
    "name",
    "description",
    "typeId",
    "sequenceNumber"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Actions
GET/research-sys/api/v1/actions/

Example URI

GET /research-sys/api/v1/actions/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Actions.md"
transfer-encoding: chunked

Update Actions
PUT/research-sys/api/v1/actions/(key)

Example URI

PUT /research-sys/api/v1/actions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "namespace": "(val)",
  "name": "(val)",
  "description": "(val)",
  "typeId": "(val)",
  "sequenceNumber": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Actions
PUT/research-sys/api/v1/actions/

Example URI

PUT /research-sys/api/v1/actions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "namespace": "(val)",
    "name": "(val)",
    "description": "(val)",
    "typeId": "(val)",
    "sequenceNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "namespace": "(val)",
    "name": "(val)",
    "description": "(val)",
    "typeId": "(val)",
    "sequenceNumber": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Actions
PATCH/research-sys/api/v1/actions/(key)

Example URI

PATCH /research-sys/api/v1/actions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "namespace": "(val)",
  "name": "(val)",
  "description": "(val)",
  "typeId": "(val)",
  "sequenceNumber": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "namespace": "(val)",
  "name": "(val)",
  "description": "(val)",
  "typeId": "(val)",
  "sequenceNumber": "(val)",
  "_primaryKey": "(val)"
}

Insert Actions
POST/research-sys/api/v1/actions/

Example URI

POST /research-sys/api/v1/actions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "namespace": "(val)",
  "name": "(val)",
  "description": "(val)",
  "typeId": "(val)",
  "sequenceNumber": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "namespace": "(val)",
  "name": "(val)",
  "description": "(val)",
  "typeId": "(val)",
  "sequenceNumber": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Actions
POST/research-sys/api/v1/actions/

Example URI

POST /research-sys/api/v1/actions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "namespace": "(val)",
    "name": "(val)",
    "description": "(val)",
    "typeId": "(val)",
    "sequenceNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "namespace": "(val)",
    "name": "(val)",
    "description": "(val)",
    "typeId": "(val)",
    "sequenceNumber": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "namespace": "(val)",
    "name": "(val)",
    "description": "(val)",
    "typeId": "(val)",
    "sequenceNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "namespace": "(val)",
    "name": "(val)",
    "description": "(val)",
    "typeId": "(val)",
    "sequenceNumber": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Actions by Key
DELETE/research-sys/api/v1/actions/(key)

Example URI

DELETE /research-sys/api/v1/actions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Actions
DELETE/research-sys/api/v1/actions/

Example URI

DELETE /research-sys/api/v1/actions/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Actions with Matching
DELETE/research-sys/api/v1/actions/

Example URI

DELETE /research-sys/api/v1/actions/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 

Action Id.

namespace
string (optional) 

Action Namespace.

name
string (optional) 

Action Name.

description
string (optional) 

Action Description.

typeId
string (optional) 

Action Type Id.

sequenceNumber
string (optional) 

Sequence Number.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Agenda Attributes

Get Agenda Attributes by Key
GET/research-sys/api/v1/agenda-attributes/(key)

Example URI

GET /research-sys/api/v1/agenda-attributes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "value": "(val)",
  "_primaryKey": "(val)"
}

Get All Agenda Attributes
GET/research-sys/api/v1/agenda-attributes/

Example URI

GET /research-sys/api/v1/agenda-attributes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Agenda Attributes with Filtering
GET/research-sys/api/v1/agenda-attributes/

Example URI

GET /research-sys/api/v1/agenda-attributes/
URI Parameters
HideShow
id
string (optional) 
value
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Agenda Attributes
GET/research-sys/api/v1/agenda-attributes/

Example URI

GET /research-sys/api/v1/agenda-attributes/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "value"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Agenda Attributes
GET/research-sys/api/v1/agenda-attributes/

Example URI

GET /research-sys/api/v1/agenda-attributes/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Agenda Attributes.md"
transfer-encoding: chunked

Update Agenda Attributes
PUT/research-sys/api/v1/agenda-attributes/(key)

Example URI

PUT /research-sys/api/v1/agenda-attributes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "value": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Agenda Attributes
PUT/research-sys/api/v1/agenda-attributes/

Example URI

PUT /research-sys/api/v1/agenda-attributes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Agenda Attributes
PATCH/research-sys/api/v1/agenda-attributes/(key)

Example URI

PATCH /research-sys/api/v1/agenda-attributes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "value": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "value": "(val)",
  "_primaryKey": "(val)"
}

Insert Agenda Attributes
POST/research-sys/api/v1/agenda-attributes/

Example URI

POST /research-sys/api/v1/agenda-attributes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "value": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "value": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Agenda Attributes
POST/research-sys/api/v1/agenda-attributes/

Example URI

POST /research-sys/api/v1/agenda-attributes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Agenda Attributes by Key
DELETE/research-sys/api/v1/agenda-attributes/(key)

Example URI

DELETE /research-sys/api/v1/agenda-attributes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Agenda Attributes
DELETE/research-sys/api/v1/agenda-attributes/

Example URI

DELETE /research-sys/api/v1/agenda-attributes/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Agenda Attributes with Matching
DELETE/research-sys/api/v1/agenda-attributes/

Example URI

DELETE /research-sys/api/v1/agenda-attributes/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 
value
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Agenda Items

Get Agenda Items by Key
GET/research-sys/api/v1/agenda-items/(key)

Example URI

GET /research-sys/api/v1/agenda-items/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "agendaId": "(val)",
  "subAgendaId": "(val)",
  "whenTrueId": "(val)",
  "whenFalseId": "(val)",
  "alwaysId": "(val)",
  "_primaryKey": "(val)"
}

Get All Agenda Items
GET/research-sys/api/v1/agenda-items/

Example URI

GET /research-sys/api/v1/agenda-items/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "agendaId": "(val)",
    "subAgendaId": "(val)",
    "whenTrueId": "(val)",
    "whenFalseId": "(val)",
    "alwaysId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "agendaId": "(val)",
    "subAgendaId": "(val)",
    "whenTrueId": "(val)",
    "whenFalseId": "(val)",
    "alwaysId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Agenda Items with Filtering
GET/research-sys/api/v1/agenda-items/

Example URI

GET /research-sys/api/v1/agenda-items/
URI Parameters
HideShow
id
string (optional) 

Id.

agendaId
string (optional) 

Agenda Id.

subAgendaId
string (optional) 

Sub-Agenda Id.

whenTrueId
string (optional) 

whenTrue Id.

whenFalseId
string (optional) 

whenFalse Id.

alwaysId
string (optional) 

Always Id.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "agendaId": "(val)",
    "subAgendaId": "(val)",
    "whenTrueId": "(val)",
    "whenFalseId": "(val)",
    "alwaysId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "agendaId": "(val)",
    "subAgendaId": "(val)",
    "whenTrueId": "(val)",
    "whenFalseId": "(val)",
    "alwaysId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Agenda Items
GET/research-sys/api/v1/agenda-items/

Example URI

GET /research-sys/api/v1/agenda-items/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "agendaId",
    "subAgendaId",
    "whenTrueId",
    "whenFalseId",
    "alwaysId"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Agenda Items
GET/research-sys/api/v1/agenda-items/

Example URI

GET /research-sys/api/v1/agenda-items/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Agenda Items.md"
transfer-encoding: chunked

Update Agenda Items
PUT/research-sys/api/v1/agenda-items/(key)

Example URI

PUT /research-sys/api/v1/agenda-items/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "agendaId": "(val)",
  "subAgendaId": "(val)",
  "whenTrueId": "(val)",
  "whenFalseId": "(val)",
  "alwaysId": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Agenda Items
PUT/research-sys/api/v1/agenda-items/

Example URI

PUT /research-sys/api/v1/agenda-items/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "agendaId": "(val)",
    "subAgendaId": "(val)",
    "whenTrueId": "(val)",
    "whenFalseId": "(val)",
    "alwaysId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "agendaId": "(val)",
    "subAgendaId": "(val)",
    "whenTrueId": "(val)",
    "whenFalseId": "(val)",
    "alwaysId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Agenda Items
PATCH/research-sys/api/v1/agenda-items/(key)

Example URI

PATCH /research-sys/api/v1/agenda-items/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "agendaId": "(val)",
  "subAgendaId": "(val)",
  "whenTrueId": "(val)",
  "whenFalseId": "(val)",
  "alwaysId": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "agendaId": "(val)",
  "subAgendaId": "(val)",
  "whenTrueId": "(val)",
  "whenFalseId": "(val)",
  "alwaysId": "(val)",
  "_primaryKey": "(val)"
}

Insert Agenda Items
POST/research-sys/api/v1/agenda-items/

Example URI

POST /research-sys/api/v1/agenda-items/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "agendaId": "(val)",
  "subAgendaId": "(val)",
  "whenTrueId": "(val)",
  "whenFalseId": "(val)",
  "alwaysId": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "agendaId": "(val)",
  "subAgendaId": "(val)",
  "whenTrueId": "(val)",
  "whenFalseId": "(val)",
  "alwaysId": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Agenda Items
POST/research-sys/api/v1/agenda-items/

Example URI

POST /research-sys/api/v1/agenda-items/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "agendaId": "(val)",
    "subAgendaId": "(val)",
    "whenTrueId": "(val)",
    "whenFalseId": "(val)",
    "alwaysId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "agendaId": "(val)",
    "subAgendaId": "(val)",
    "whenTrueId": "(val)",
    "whenFalseId": "(val)",
    "alwaysId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "agendaId": "(val)",
    "subAgendaId": "(val)",
    "whenTrueId": "(val)",
    "whenFalseId": "(val)",
    "alwaysId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "agendaId": "(val)",
    "subAgendaId": "(val)",
    "whenTrueId": "(val)",
    "whenFalseId": "(val)",
    "alwaysId": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Agenda Items by Key
DELETE/research-sys/api/v1/agenda-items/(key)

Example URI

DELETE /research-sys/api/v1/agenda-items/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Agenda Items
DELETE/research-sys/api/v1/agenda-items/

Example URI

DELETE /research-sys/api/v1/agenda-items/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Agenda Items with Matching
DELETE/research-sys/api/v1/agenda-items/

Example URI

DELETE /research-sys/api/v1/agenda-items/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 

Id.

agendaId
string (optional) 

Agenda Id.

subAgendaId
string (optional) 

Sub-Agenda Id.

whenTrueId
string (optional) 

whenTrue Id.

whenFalseId
string (optional) 

whenFalse Id.

alwaysId
string (optional) 

Always Id.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Agendas

Get Agendas by Key
GET/research-sys/api/v1/agendas/(key)

Example URI

GET /research-sys/api/v1/agendas/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "name": "(val)",
  "typeId": "(val)",
  "contextId": "(val)",
  "active": "(val)",
  "firstItemId": "(val)",
  "_primaryKey": "(val)"
}

Get All Agendas
GET/research-sys/api/v1/agendas/

Example URI

GET /research-sys/api/v1/agendas/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "typeId": "(val)",
    "contextId": "(val)",
    "active": "(val)",
    "firstItemId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "typeId": "(val)",
    "contextId": "(val)",
    "active": "(val)",
    "firstItemId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Agendas with Filtering
GET/research-sys/api/v1/agendas/

Example URI

GET /research-sys/api/v1/agendas/
URI Parameters
HideShow
id
string (optional) 

Agenda Id.

name
string (optional) 

Agenda Name.

typeId
string (optional) 

Agenda typeId.

contextId
string (optional) 

Agenda contextId.

active
string (optional) 

This attribute is used to describe whether the associated object is active or inactive. Maximum length is 1.

firstItemId
string (optional) 

First Item Id.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "typeId": "(val)",
    "contextId": "(val)",
    "active": "(val)",
    "firstItemId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "typeId": "(val)",
    "contextId": "(val)",
    "active": "(val)",
    "firstItemId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Agendas
GET/research-sys/api/v1/agendas/

Example URI

GET /research-sys/api/v1/agendas/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "name",
    "typeId",
    "contextId",
    "active",
    "firstItemId"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Agendas
GET/research-sys/api/v1/agendas/

Example URI

GET /research-sys/api/v1/agendas/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Agendas.md"
transfer-encoding: chunked

Update Agendas
PUT/research-sys/api/v1/agendas/(key)

Example URI

PUT /research-sys/api/v1/agendas/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "name": "(val)",
  "typeId": "(val)",
  "contextId": "(val)",
  "active": "(val)",
  "firstItemId": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Agendas
PUT/research-sys/api/v1/agendas/

Example URI

PUT /research-sys/api/v1/agendas/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "typeId": "(val)",
    "contextId": "(val)",
    "active": "(val)",
    "firstItemId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "typeId": "(val)",
    "contextId": "(val)",
    "active": "(val)",
    "firstItemId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Agendas
PATCH/research-sys/api/v1/agendas/(key)

Example URI

PATCH /research-sys/api/v1/agendas/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "name": "(val)",
  "typeId": "(val)",
  "contextId": "(val)",
  "active": "(val)",
  "firstItemId": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "name": "(val)",
  "typeId": "(val)",
  "contextId": "(val)",
  "active": "(val)",
  "firstItemId": "(val)",
  "_primaryKey": "(val)"
}

Insert Agendas
POST/research-sys/api/v1/agendas/

Example URI

POST /research-sys/api/v1/agendas/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "name": "(val)",
  "typeId": "(val)",
  "contextId": "(val)",
  "active": "(val)",
  "firstItemId": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "name": "(val)",
  "typeId": "(val)",
  "contextId": "(val)",
  "active": "(val)",
  "firstItemId": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Agendas
POST/research-sys/api/v1/agendas/

Example URI

POST /research-sys/api/v1/agendas/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "typeId": "(val)",
    "contextId": "(val)",
    "active": "(val)",
    "firstItemId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "typeId": "(val)",
    "contextId": "(val)",
    "active": "(val)",
    "firstItemId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "typeId": "(val)",
    "contextId": "(val)",
    "active": "(val)",
    "firstItemId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "typeId": "(val)",
    "contextId": "(val)",
    "active": "(val)",
    "firstItemId": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Agendas by Key
DELETE/research-sys/api/v1/agendas/(key)

Example URI

DELETE /research-sys/api/v1/agendas/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Agendas
DELETE/research-sys/api/v1/agendas/

Example URI

DELETE /research-sys/api/v1/agendas/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Agendas with Matching
DELETE/research-sys/api/v1/agendas/

Example URI

DELETE /research-sys/api/v1/agendas/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 

Agenda Id.

name
string (optional) 

Agenda Name.

typeId
string (optional) 

Agenda typeId.

contextId
string (optional) 

Agenda contextId.

active
string (optional) 

This attribute is used to describe whether the associated object is active or inactive. Maximum length is 1.

firstItemId
string (optional) 

First Item Id.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Attachments

Get Attachments by Key
GET/research-sys/api/v1/attachments/(key)

Example URI

GET /research-sys/api/v1/attachments/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "noteIdentifier": "(val)",
  "attachmentMimeTypeCode": "(val)",
  "attachmentFileName": "(val)",
  "attachmentIdentifier": "(val)",
  "attachmentFileSize": "(val)",
  "attachmentTypeCode": "(val)",
  "_primaryKey": "(val)"
}

Get All Attachments
GET/research-sys/api/v1/attachments/

Example URI

GET /research-sys/api/v1/attachments/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "noteIdentifier": "(val)",
    "attachmentMimeTypeCode": "(val)",
    "attachmentFileName": "(val)",
    "attachmentIdentifier": "(val)",
    "attachmentFileSize": "(val)",
    "attachmentTypeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "noteIdentifier": "(val)",
    "attachmentMimeTypeCode": "(val)",
    "attachmentFileName": "(val)",
    "attachmentIdentifier": "(val)",
    "attachmentFileSize": "(val)",
    "attachmentTypeCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Attachments with Filtering
GET/research-sys/api/v1/attachments/

Example URI

GET /research-sys/api/v1/attachments/
URI Parameters
HideShow
noteIdentifier
string (optional) 

noteIdentifier description… Maximum length is 14.

attachmentMimeTypeCode
string (optional) 

attachmentMimeTypeCode description… Maximum length is 40.

attachmentFileName
string (optional) 

attachmentFileName description… Maximum length is 250.

attachmentIdentifier
string (optional) 

attachmentIdentifier description… Maximum length is 36.

attachmentFileSize
string (optional) 

attachmentFileSize description… Maximum length is 14.

attachmentTypeCode
string (optional) 

attachmentTypeCode description… Maximum length is 2.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "noteIdentifier": "(val)",
    "attachmentMimeTypeCode": "(val)",
    "attachmentFileName": "(val)",
    "attachmentIdentifier": "(val)",
    "attachmentFileSize": "(val)",
    "attachmentTypeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "noteIdentifier": "(val)",
    "attachmentMimeTypeCode": "(val)",
    "attachmentFileName": "(val)",
    "attachmentIdentifier": "(val)",
    "attachmentFileSize": "(val)",
    "attachmentTypeCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Attachments
GET/research-sys/api/v1/attachments/

Example URI

GET /research-sys/api/v1/attachments/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "noteIdentifier",
    "attachmentMimeTypeCode",
    "attachmentFileName",
    "attachmentIdentifier",
    "attachmentFileSize",
    "attachmentTypeCode"
  ],
  "primaryKey": "noteIdentifier"
}

Get Blueprint API specification for Attachments
GET/research-sys/api/v1/attachments/

Example URI

GET /research-sys/api/v1/attachments/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Attachments.md"
transfer-encoding: chunked

Update Attachments
PUT/research-sys/api/v1/attachments/(key)

Example URI

PUT /research-sys/api/v1/attachments/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "noteIdentifier": "(val)",
  "attachmentMimeTypeCode": "(val)",
  "attachmentFileName": "(val)",
  "attachmentIdentifier": "(val)",
  "attachmentFileSize": "(val)",
  "attachmentTypeCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Attachments
PUT/research-sys/api/v1/attachments/

Example URI

PUT /research-sys/api/v1/attachments/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "noteIdentifier": "(val)",
    "attachmentMimeTypeCode": "(val)",
    "attachmentFileName": "(val)",
    "attachmentIdentifier": "(val)",
    "attachmentFileSize": "(val)",
    "attachmentTypeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "noteIdentifier": "(val)",
    "attachmentMimeTypeCode": "(val)",
    "attachmentFileName": "(val)",
    "attachmentIdentifier": "(val)",
    "attachmentFileSize": "(val)",
    "attachmentTypeCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Attachments
PATCH/research-sys/api/v1/attachments/(key)

Example URI

PATCH /research-sys/api/v1/attachments/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "noteIdentifier": "(val)",
  "attachmentMimeTypeCode": "(val)",
  "attachmentFileName": "(val)",
  "attachmentIdentifier": "(val)",
  "attachmentFileSize": "(val)",
  "attachmentTypeCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "noteIdentifier": "(val)",
  "attachmentMimeTypeCode": "(val)",
  "attachmentFileName": "(val)",
  "attachmentIdentifier": "(val)",
  "attachmentFileSize": "(val)",
  "attachmentTypeCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Attachments
POST/research-sys/api/v1/attachments/

Example URI

POST /research-sys/api/v1/attachments/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "noteIdentifier": "(val)",
  "attachmentMimeTypeCode": "(val)",
  "attachmentFileName": "(val)",
  "attachmentIdentifier": "(val)",
  "attachmentFileSize": "(val)",
  "attachmentTypeCode": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "noteIdentifier": "(val)",
  "attachmentMimeTypeCode": "(val)",
  "attachmentFileName": "(val)",
  "attachmentIdentifier": "(val)",
  "attachmentFileSize": "(val)",
  "attachmentTypeCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Attachments
POST/research-sys/api/v1/attachments/

Example URI

POST /research-sys/api/v1/attachments/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "noteIdentifier": "(val)",
    "attachmentMimeTypeCode": "(val)",
    "attachmentFileName": "(val)",
    "attachmentIdentifier": "(val)",
    "attachmentFileSize": "(val)",
    "attachmentTypeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "noteIdentifier": "(val)",
    "attachmentMimeTypeCode": "(val)",
    "attachmentFileName": "(val)",
    "attachmentIdentifier": "(val)",
    "attachmentFileSize": "(val)",
    "attachmentTypeCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "noteIdentifier": "(val)",
    "attachmentMimeTypeCode": "(val)",
    "attachmentFileName": "(val)",
    "attachmentIdentifier": "(val)",
    "attachmentFileSize": "(val)",
    "attachmentTypeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "noteIdentifier": "(val)",
    "attachmentMimeTypeCode": "(val)",
    "attachmentFileName": "(val)",
    "attachmentIdentifier": "(val)",
    "attachmentFileSize": "(val)",
    "attachmentTypeCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Attachments by Key
DELETE/research-sys/api/v1/attachments/(key)

Example URI

DELETE /research-sys/api/v1/attachments/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Attachments
DELETE/research-sys/api/v1/attachments/

Example URI

DELETE /research-sys/api/v1/attachments/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Attachments with Matching
DELETE/research-sys/api/v1/attachments/

Example URI

DELETE /research-sys/api/v1/attachments/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

noteIdentifier
string (optional) 

noteIdentifier description… Maximum length is 14.

attachmentMimeTypeCode
string (optional) 

attachmentMimeTypeCode description… Maximum length is 40.

attachmentFileName
string (optional) 

attachmentFileName description… Maximum length is 250.

attachmentIdentifier
string (optional) 

attachmentIdentifier description… Maximum length is 36.

attachmentFileSize
string (optional) 

attachmentFileSize description… Maximum length is 14.

attachmentTypeCode
string (optional) 

attachmentTypeCode description… Maximum length is 2.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Campus Types

Get Campus Types by Key
GET/research-sys/api/v1/campus-types/(key)

Example URI

GET /research-sys/api/v1/campus-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "code": "(val)",
  "name": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Get All Campus Types
GET/research-sys/api/v1/campus-types/

Example URI

GET /research-sys/api/v1/campus-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Campus Types with Filtering
GET/research-sys/api/v1/campus-types/

Example URI

GET /research-sys/api/v1/campus-types/
URI Parameters
HideShow
code
string (optional) 

campusTypeCode description… Maximum length is 1.

name
string (optional) 

campusTypeName description… Maximum length is 40.

active
string (optional) 

Active.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Campus Types
GET/research-sys/api/v1/campus-types/

Example URI

GET /research-sys/api/v1/campus-types/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "code",
    "name",
    "active"
  ],
  "primaryKey": "code"
}

Get Blueprint API specification for Campus Types
GET/research-sys/api/v1/campus-types/

Example URI

GET /research-sys/api/v1/campus-types/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Campus Types.md"
transfer-encoding: chunked

Update Campus Types
PUT/research-sys/api/v1/campus-types/(key)

Example URI

PUT /research-sys/api/v1/campus-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "code": "(val)",
  "name": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Campus Types
PUT/research-sys/api/v1/campus-types/

Example URI

PUT /research-sys/api/v1/campus-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Campus Types
PATCH/research-sys/api/v1/campus-types/(key)

Example URI

PATCH /research-sys/api/v1/campus-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "code": "(val)",
  "name": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "code": "(val)",
  "name": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Campus Types
POST/research-sys/api/v1/campus-types/

Example URI

POST /research-sys/api/v1/campus-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "code": "(val)",
  "name": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "code": "(val)",
  "name": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Campus Types
POST/research-sys/api/v1/campus-types/

Example URI

POST /research-sys/api/v1/campus-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Campus Types by Key
DELETE/research-sys/api/v1/campus-types/(key)

Example URI

DELETE /research-sys/api/v1/campus-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Campus Types
DELETE/research-sys/api/v1/campus-types/

Example URI

DELETE /research-sys/api/v1/campus-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Campus Types with Matching
DELETE/research-sys/api/v1/campus-types/

Example URI

DELETE /research-sys/api/v1/campus-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

code
string (optional) 

campusTypeCode description… Maximum length is 1.

name
string (optional) 

campusTypeName description… Maximum length is 40.

active
string (optional) 

Active.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Campuses

Get Campuses by Key
GET/research-sys/api/v1/campuses/(key)

Example URI

GET /research-sys/api/v1/campuses/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "code": "(val)",
  "name": "(val)",
  "shortName": "(val)",
  "campusTypeCode": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Get All Campuses
GET/research-sys/api/v1/campuses/

Example URI

GET /research-sys/api/v1/campuses/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "code": "(val)",
    "name": "(val)",
    "shortName": "(val)",
    "campusTypeCode": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "code": "(val)",
    "name": "(val)",
    "shortName": "(val)",
    "campusTypeCode": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Campuses with Filtering
GET/research-sys/api/v1/campuses/

Example URI

GET /research-sys/api/v1/campuses/
URI Parameters
HideShow
code
string (optional) 

The code uniquely identifying a particular campus. Maximum length is 2.

name
string (optional) 

Campus Name… Maximum length is 40.

shortName
string (optional) 

Short Name… Maximum length is 12.

campusTypeCode
string (optional) 

The code identifying type of campus. Maximum length is 2.

active
string (optional) 

This attribute is used to describe whether the associated object is active or inactive. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "code": "(val)",
    "name": "(val)",
    "shortName": "(val)",
    "campusTypeCode": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "code": "(val)",
    "name": "(val)",
    "shortName": "(val)",
    "campusTypeCode": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Campuses
GET/research-sys/api/v1/campuses/

Example URI

GET /research-sys/api/v1/campuses/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "code",
    "name",
    "shortName",
    "campusTypeCode",
    "active"
  ],
  "primaryKey": "code"
}

Get Blueprint API specification for Campuses
GET/research-sys/api/v1/campuses/

Example URI

GET /research-sys/api/v1/campuses/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Campuses.md"
transfer-encoding: chunked

Update Campuses
PUT/research-sys/api/v1/campuses/(key)

Example URI

PUT /research-sys/api/v1/campuses/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "code": "(val)",
  "name": "(val)",
  "shortName": "(val)",
  "campusTypeCode": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Campuses
PUT/research-sys/api/v1/campuses/

Example URI

PUT /research-sys/api/v1/campuses/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "code": "(val)",
    "name": "(val)",
    "shortName": "(val)",
    "campusTypeCode": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "code": "(val)",
    "name": "(val)",
    "shortName": "(val)",
    "campusTypeCode": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Campuses
PATCH/research-sys/api/v1/campuses/(key)

Example URI

PATCH /research-sys/api/v1/campuses/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "code": "(val)",
  "name": "(val)",
  "shortName": "(val)",
  "campusTypeCode": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "code": "(val)",
  "name": "(val)",
  "shortName": "(val)",
  "campusTypeCode": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Campuses
POST/research-sys/api/v1/campuses/

Example URI

POST /research-sys/api/v1/campuses/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "code": "(val)",
  "name": "(val)",
  "shortName": "(val)",
  "campusTypeCode": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "code": "(val)",
  "name": "(val)",
  "shortName": "(val)",
  "campusTypeCode": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Campuses
POST/research-sys/api/v1/campuses/

Example URI

POST /research-sys/api/v1/campuses/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "code": "(val)",
    "name": "(val)",
    "shortName": "(val)",
    "campusTypeCode": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "code": "(val)",
    "name": "(val)",
    "shortName": "(val)",
    "campusTypeCode": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "code": "(val)",
    "name": "(val)",
    "shortName": "(val)",
    "campusTypeCode": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "code": "(val)",
    "name": "(val)",
    "shortName": "(val)",
    "campusTypeCode": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Campuses by Key
DELETE/research-sys/api/v1/campuses/(key)

Example URI

DELETE /research-sys/api/v1/campuses/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Campuses
DELETE/research-sys/api/v1/campuses/

Example URI

DELETE /research-sys/api/v1/campuses/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Campuses with Matching
DELETE/research-sys/api/v1/campuses/

Example URI

DELETE /research-sys/api/v1/campuses/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

code
string (optional) 

The code uniquely identifying a particular campus. Maximum length is 2.

name
string (optional) 

Campus Name… Maximum length is 40.

shortName
string (optional) 

Short Name… Maximum length is 12.

campusTypeCode
string (optional) 

The code identifying type of campus. Maximum length is 2.

active
string (optional) 

This attribute is used to describe whether the associated object is active or inactive. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Categories

Get Categories by Key
GET/research-sys/api/v1/categories/(key)

Example URI

GET /research-sys/api/v1/categories/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "name": "(val)",
  "namespace": "(val)",
  "_primaryKey": "(val)"
}

Get All Categories
GET/research-sys/api/v1/categories/

Example URI

GET /research-sys/api/v1/categories/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Categories with Filtering
GET/research-sys/api/v1/categories/

Example URI

GET /research-sys/api/v1/categories/
URI Parameters
HideShow
id
string (optional) 

ID.

name
string (optional) 

Name.

namespace
string (optional) 

Namespace.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Categories
GET/research-sys/api/v1/categories/

Example URI

GET /research-sys/api/v1/categories/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "name",
    "namespace"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Categories
GET/research-sys/api/v1/categories/

Example URI

GET /research-sys/api/v1/categories/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Categories.md"
transfer-encoding: chunked

Update Categories
PUT/research-sys/api/v1/categories/(key)

Example URI

PUT /research-sys/api/v1/categories/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "name": "(val)",
  "namespace": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Categories
PUT/research-sys/api/v1/categories/

Example URI

PUT /research-sys/api/v1/categories/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Categories
PATCH/research-sys/api/v1/categories/(key)

Example URI

PATCH /research-sys/api/v1/categories/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "name": "(val)",
  "namespace": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "name": "(val)",
  "namespace": "(val)",
  "_primaryKey": "(val)"
}

Insert Categories
POST/research-sys/api/v1/categories/

Example URI

POST /research-sys/api/v1/categories/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "name": "(val)",
  "namespace": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "name": "(val)",
  "namespace": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Categories
POST/research-sys/api/v1/categories/

Example URI

POST /research-sys/api/v1/categories/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Categories by Key
DELETE/research-sys/api/v1/categories/(key)

Example URI

DELETE /research-sys/api/v1/categories/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Categories
DELETE/research-sys/api/v1/categories/

Example URI

DELETE /research-sys/api/v1/categories/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Categories with Matching
DELETE/research-sys/api/v1/categories/

Example URI

DELETE /research-sys/api/v1/categories/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 

ID.

name
string (optional) 

Name.

namespace
string (optional) 

Namespace.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Component Sets

Get Component Sets by Key
GET/research-sys/api/v1/component-sets/(key)

Example URI

GET /research-sys/api/v1/component-sets/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "componentSetId": "(val)",
  "lastUpdateTimestamp": "(val)",
  "checksum": "(val)",
  "_primaryKey": "(val)"
}

Get All Component Sets
GET/research-sys/api/v1/component-sets/

Example URI

GET /research-sys/api/v1/component-sets/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "componentSetId": "(val)",
    "lastUpdateTimestamp": "(val)",
    "checksum": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "componentSetId": "(val)",
    "lastUpdateTimestamp": "(val)",
    "checksum": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Component Sets with Filtering
GET/research-sys/api/v1/component-sets/

Example URI

GET /research-sys/api/v1/component-sets/
URI Parameters
HideShow
componentSetId
string (optional) 
lastUpdateTimestamp
string (optional) 
checksum
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "componentSetId": "(val)",
    "lastUpdateTimestamp": "(val)",
    "checksum": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "componentSetId": "(val)",
    "lastUpdateTimestamp": "(val)",
    "checksum": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Component Sets
GET/research-sys/api/v1/component-sets/

Example URI

GET /research-sys/api/v1/component-sets/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "componentSetId",
    "lastUpdateTimestamp",
    "checksum"
  ],
  "primaryKey": "componentSetId"
}

Get Blueprint API specification for Component Sets
GET/research-sys/api/v1/component-sets/

Example URI

GET /research-sys/api/v1/component-sets/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Component Sets.md"
transfer-encoding: chunked

Update Component Sets
PUT/research-sys/api/v1/component-sets/(key)

Example URI

PUT /research-sys/api/v1/component-sets/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "componentSetId": "(val)",
  "lastUpdateTimestamp": "(val)",
  "checksum": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Component Sets
PUT/research-sys/api/v1/component-sets/

Example URI

PUT /research-sys/api/v1/component-sets/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "componentSetId": "(val)",
    "lastUpdateTimestamp": "(val)",
    "checksum": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "componentSetId": "(val)",
    "lastUpdateTimestamp": "(val)",
    "checksum": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Component Sets
PATCH/research-sys/api/v1/component-sets/(key)

Example URI

PATCH /research-sys/api/v1/component-sets/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "componentSetId": "(val)",
  "lastUpdateTimestamp": "(val)",
  "checksum": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "componentSetId": "(val)",
  "lastUpdateTimestamp": "(val)",
  "checksum": "(val)",
  "_primaryKey": "(val)"
}

Insert Component Sets
POST/research-sys/api/v1/component-sets/

Example URI

POST /research-sys/api/v1/component-sets/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "componentSetId": "(val)",
  "lastUpdateTimestamp": "(val)",
  "checksum": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "componentSetId": "(val)",
  "lastUpdateTimestamp": "(val)",
  "checksum": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Component Sets
POST/research-sys/api/v1/component-sets/

Example URI

POST /research-sys/api/v1/component-sets/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "componentSetId": "(val)",
    "lastUpdateTimestamp": "(val)",
    "checksum": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "componentSetId": "(val)",
    "lastUpdateTimestamp": "(val)",
    "checksum": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "componentSetId": "(val)",
    "lastUpdateTimestamp": "(val)",
    "checksum": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "componentSetId": "(val)",
    "lastUpdateTimestamp": "(val)",
    "checksum": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Component Sets by Key
DELETE/research-sys/api/v1/component-sets/(key)

Example URI

DELETE /research-sys/api/v1/component-sets/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Component Sets
DELETE/research-sys/api/v1/component-sets/

Example URI

DELETE /research-sys/api/v1/component-sets/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Component Sets with Matching
DELETE/research-sys/api/v1/component-sets/

Example URI

DELETE /research-sys/api/v1/component-sets/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

componentSetId
string (optional) 
lastUpdateTimestamp
string (optional) 
checksum
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Components

Get Components by Key
GET/research-sys/api/v1/components/(key)

Example URI

GET /research-sys/api/v1/components/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "namespaceCode": "(val)",
  "code": "(val)",
  "name": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Get All Components
GET/research-sys/api/v1/components/

Example URI

GET /research-sys/api/v1/components/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "namespaceCode": "(val)",
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "namespaceCode": "(val)",
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Components with Filtering
GET/research-sys/api/v1/components/

Example URI

GET /research-sys/api/v1/components/
URI Parameters
HideShow
namespaceCode
string (optional) 

Code identifying the namespace. Maximum length is 20.

code
string (optional) 

Code identifying the Component. Maximum length is 100.

name
string (optional) 

The name of the Component. Maximum length is 255.

active
string (optional) 

This attribute is used to describe whether the associated object is active or inactive. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "namespaceCode": "(val)",
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "namespaceCode": "(val)",
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Components
GET/research-sys/api/v1/components/

Example URI

GET /research-sys/api/v1/components/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "namespaceCode",
    "code",
    "name",
    "active"
  ],
  "primaryKey": "code:namespaceCode"
}

Get Blueprint API specification for Components
GET/research-sys/api/v1/components/

Example URI

GET /research-sys/api/v1/components/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Components.md"
transfer-encoding: chunked

Update Components
PUT/research-sys/api/v1/components/(key)

Example URI

PUT /research-sys/api/v1/components/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "namespaceCode": "(val)",
  "code": "(val)",
  "name": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Components
PUT/research-sys/api/v1/components/

Example URI

PUT /research-sys/api/v1/components/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "namespaceCode": "(val)",
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "namespaceCode": "(val)",
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Components
PATCH/research-sys/api/v1/components/(key)

Example URI

PATCH /research-sys/api/v1/components/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "namespaceCode": "(val)",
  "code": "(val)",
  "name": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "namespaceCode": "(val)",
  "code": "(val)",
  "name": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Components
POST/research-sys/api/v1/components/

Example URI

POST /research-sys/api/v1/components/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "namespaceCode": "(val)",
  "code": "(val)",
  "name": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "namespaceCode": "(val)",
  "code": "(val)",
  "name": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Components
POST/research-sys/api/v1/components/

Example URI

POST /research-sys/api/v1/components/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "namespaceCode": "(val)",
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "namespaceCode": "(val)",
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "namespaceCode": "(val)",
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "namespaceCode": "(val)",
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Components by Key
DELETE/research-sys/api/v1/components/(key)

Example URI

DELETE /research-sys/api/v1/components/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Components
DELETE/research-sys/api/v1/components/

Example URI

DELETE /research-sys/api/v1/components/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Components with Matching
DELETE/research-sys/api/v1/components/

Example URI

DELETE /research-sys/api/v1/components/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

namespaceCode
string (optional) 

Code identifying the namespace. Maximum length is 20.

code
string (optional) 

Code identifying the Component. Maximum length is 100.

name
string (optional) 

The name of the Component. Maximum length is 255.

active
string (optional) 

This attribute is used to describe whether the associated object is active or inactive. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Context Attributes

Get Context Attributes by Key
GET/research-sys/api/v1/context-attributes/(key)

Example URI

GET /research-sys/api/v1/context-attributes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "value": "(val)",
  "_primaryKey": "(val)"
}

Get All Context Attributes
GET/research-sys/api/v1/context-attributes/

Example URI

GET /research-sys/api/v1/context-attributes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Context Attributes with Filtering
GET/research-sys/api/v1/context-attributes/

Example URI

GET /research-sys/api/v1/context-attributes/
URI Parameters
HideShow
id
string (optional) 
value
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Context Attributes
GET/research-sys/api/v1/context-attributes/

Example URI

GET /research-sys/api/v1/context-attributes/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "value"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Context Attributes
GET/research-sys/api/v1/context-attributes/

Example URI

GET /research-sys/api/v1/context-attributes/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Context Attributes.md"
transfer-encoding: chunked

Update Context Attributes
PUT/research-sys/api/v1/context-attributes/(key)

Example URI

PUT /research-sys/api/v1/context-attributes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "value": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Context Attributes
PUT/research-sys/api/v1/context-attributes/

Example URI

PUT /research-sys/api/v1/context-attributes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Context Attributes
PATCH/research-sys/api/v1/context-attributes/(key)

Example URI

PATCH /research-sys/api/v1/context-attributes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "value": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "value": "(val)",
  "_primaryKey": "(val)"
}

Insert Context Attributes
POST/research-sys/api/v1/context-attributes/

Example URI

POST /research-sys/api/v1/context-attributes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "value": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "value": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Context Attributes
POST/research-sys/api/v1/context-attributes/

Example URI

POST /research-sys/api/v1/context-attributes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Context Attributes by Key
DELETE/research-sys/api/v1/context-attributes/(key)

Example URI

DELETE /research-sys/api/v1/context-attributes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Context Attributes
DELETE/research-sys/api/v1/context-attributes/

Example URI

DELETE /research-sys/api/v1/context-attributes/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Context Attributes with Matching
DELETE/research-sys/api/v1/context-attributes/

Example URI

DELETE /research-sys/api/v1/context-attributes/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 
value
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Context Valid Actions

Get Context Valid Actions by Key
GET/research-sys/api/v1/context-valid-actions/(key)

Example URI

GET /research-sys/api/v1/context-valid-actions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "contextId": "(val)",
  "actionTypeId": "(val)",
  "_primaryKey": "(val)"
}

Get All Context Valid Actions
GET/research-sys/api/v1/context-valid-actions/

Example URI

GET /research-sys/api/v1/context-valid-actions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "contextId": "(val)",
    "actionTypeId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "contextId": "(val)",
    "actionTypeId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Context Valid Actions with Filtering
GET/research-sys/api/v1/context-valid-actions/

Example URI

GET /research-sys/api/v1/context-valid-actions/
URI Parameters
HideShow
id
string (optional) 
contextId
string (optional) 
actionTypeId
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "contextId": "(val)",
    "actionTypeId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "contextId": "(val)",
    "actionTypeId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Context Valid Actions
GET/research-sys/api/v1/context-valid-actions/

Example URI

GET /research-sys/api/v1/context-valid-actions/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "contextId",
    "actionTypeId"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Context Valid Actions
GET/research-sys/api/v1/context-valid-actions/

Example URI

GET /research-sys/api/v1/context-valid-actions/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Context Valid Actions.md"
transfer-encoding: chunked

Update Context Valid Actions
PUT/research-sys/api/v1/context-valid-actions/(key)

Example URI

PUT /research-sys/api/v1/context-valid-actions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "contextId": "(val)",
  "actionTypeId": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Context Valid Actions
PUT/research-sys/api/v1/context-valid-actions/

Example URI

PUT /research-sys/api/v1/context-valid-actions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "contextId": "(val)",
    "actionTypeId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "contextId": "(val)",
    "actionTypeId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Context Valid Actions
PATCH/research-sys/api/v1/context-valid-actions/(key)

Example URI

PATCH /research-sys/api/v1/context-valid-actions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "contextId": "(val)",
  "actionTypeId": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "contextId": "(val)",
  "actionTypeId": "(val)",
  "_primaryKey": "(val)"
}

Insert Context Valid Actions
POST/research-sys/api/v1/context-valid-actions/

Example URI

POST /research-sys/api/v1/context-valid-actions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "contextId": "(val)",
  "actionTypeId": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "contextId": "(val)",
  "actionTypeId": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Context Valid Actions
POST/research-sys/api/v1/context-valid-actions/

Example URI

POST /research-sys/api/v1/context-valid-actions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "contextId": "(val)",
    "actionTypeId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "contextId": "(val)",
    "actionTypeId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "contextId": "(val)",
    "actionTypeId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "contextId": "(val)",
    "actionTypeId": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Context Valid Actions by Key
DELETE/research-sys/api/v1/context-valid-actions/(key)

Example URI

DELETE /research-sys/api/v1/context-valid-actions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Context Valid Actions
DELETE/research-sys/api/v1/context-valid-actions/

Example URI

DELETE /research-sys/api/v1/context-valid-actions/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Context Valid Actions with Matching
DELETE/research-sys/api/v1/context-valid-actions/

Example URI

DELETE /research-sys/api/v1/context-valid-actions/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 
contextId
string (optional) 
actionTypeId
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Context Valid Agendas

Get Context Valid Agendas by Key
GET/research-sys/api/v1/context-valid-agendas/(key)

Example URI

GET /research-sys/api/v1/context-valid-agendas/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "contextId": "(val)",
  "agendaTypeId": "(val)",
  "_primaryKey": "(val)"
}

Get All Context Valid Agendas
GET/research-sys/api/v1/context-valid-agendas/

Example URI

GET /research-sys/api/v1/context-valid-agendas/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "contextId": "(val)",
    "agendaTypeId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "contextId": "(val)",
    "agendaTypeId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Context Valid Agendas with Filtering
GET/research-sys/api/v1/context-valid-agendas/

Example URI

GET /research-sys/api/v1/context-valid-agendas/
URI Parameters
HideShow
id
string (optional) 
contextId
string (optional) 
agendaTypeId
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "contextId": "(val)",
    "agendaTypeId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "contextId": "(val)",
    "agendaTypeId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Context Valid Agendas
GET/research-sys/api/v1/context-valid-agendas/

Example URI

GET /research-sys/api/v1/context-valid-agendas/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "contextId",
    "agendaTypeId"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Context Valid Agendas
GET/research-sys/api/v1/context-valid-agendas/

Example URI

GET /research-sys/api/v1/context-valid-agendas/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Context Valid Agendas.md"
transfer-encoding: chunked

Update Context Valid Agendas
PUT/research-sys/api/v1/context-valid-agendas/(key)

Example URI

PUT /research-sys/api/v1/context-valid-agendas/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "contextId": "(val)",
  "agendaTypeId": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Context Valid Agendas
PUT/research-sys/api/v1/context-valid-agendas/

Example URI

PUT /research-sys/api/v1/context-valid-agendas/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "contextId": "(val)",
    "agendaTypeId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "contextId": "(val)",
    "agendaTypeId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Context Valid Agendas
PATCH/research-sys/api/v1/context-valid-agendas/(key)

Example URI

PATCH /research-sys/api/v1/context-valid-agendas/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "contextId": "(val)",
  "agendaTypeId": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "contextId": "(val)",
  "agendaTypeId": "(val)",
  "_primaryKey": "(val)"
}

Insert Context Valid Agendas
POST/research-sys/api/v1/context-valid-agendas/

Example URI

POST /research-sys/api/v1/context-valid-agendas/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "contextId": "(val)",
  "agendaTypeId": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "contextId": "(val)",
  "agendaTypeId": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Context Valid Agendas
POST/research-sys/api/v1/context-valid-agendas/

Example URI

POST /research-sys/api/v1/context-valid-agendas/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "contextId": "(val)",
    "agendaTypeId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "contextId": "(val)",
    "agendaTypeId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "contextId": "(val)",
    "agendaTypeId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "contextId": "(val)",
    "agendaTypeId": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Context Valid Agendas by Key
DELETE/research-sys/api/v1/context-valid-agendas/(key)

Example URI

DELETE /research-sys/api/v1/context-valid-agendas/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Context Valid Agendas
DELETE/research-sys/api/v1/context-valid-agendas/

Example URI

DELETE /research-sys/api/v1/context-valid-agendas/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Context Valid Agendas with Matching
DELETE/research-sys/api/v1/context-valid-agendas/

Example URI

DELETE /research-sys/api/v1/context-valid-agendas/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 
contextId
string (optional) 
agendaTypeId
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Context Valid Rules

Get Context Valid Rules by Key
GET/research-sys/api/v1/context-valid-rules/(key)

Example URI

GET /research-sys/api/v1/context-valid-rules/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "contextId": "(val)",
  "ruleTypeId": "(val)",
  "_primaryKey": "(val)"
}

Get All Context Valid Rules
GET/research-sys/api/v1/context-valid-rules/

Example URI

GET /research-sys/api/v1/context-valid-rules/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "contextId": "(val)",
    "ruleTypeId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "contextId": "(val)",
    "ruleTypeId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Context Valid Rules with Filtering
GET/research-sys/api/v1/context-valid-rules/

Example URI

GET /research-sys/api/v1/context-valid-rules/
URI Parameters
HideShow
id
string (optional) 
contextId
string (optional) 
ruleTypeId
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "contextId": "(val)",
    "ruleTypeId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "contextId": "(val)",
    "ruleTypeId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Context Valid Rules
GET/research-sys/api/v1/context-valid-rules/

Example URI

GET /research-sys/api/v1/context-valid-rules/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "contextId",
    "ruleTypeId"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Context Valid Rules
GET/research-sys/api/v1/context-valid-rules/

Example URI

GET /research-sys/api/v1/context-valid-rules/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Context Valid Rules.md"
transfer-encoding: chunked

Update Context Valid Rules
PUT/research-sys/api/v1/context-valid-rules/(key)

Example URI

PUT /research-sys/api/v1/context-valid-rules/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "contextId": "(val)",
  "ruleTypeId": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Context Valid Rules
PUT/research-sys/api/v1/context-valid-rules/

Example URI

PUT /research-sys/api/v1/context-valid-rules/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "contextId": "(val)",
    "ruleTypeId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "contextId": "(val)",
    "ruleTypeId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Context Valid Rules
PATCH/research-sys/api/v1/context-valid-rules/(key)

Example URI

PATCH /research-sys/api/v1/context-valid-rules/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "contextId": "(val)",
  "ruleTypeId": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "contextId": "(val)",
  "ruleTypeId": "(val)",
  "_primaryKey": "(val)"
}

Insert Context Valid Rules
POST/research-sys/api/v1/context-valid-rules/

Example URI

POST /research-sys/api/v1/context-valid-rules/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "contextId": "(val)",
  "ruleTypeId": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "contextId": "(val)",
  "ruleTypeId": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Context Valid Rules
POST/research-sys/api/v1/context-valid-rules/

Example URI

POST /research-sys/api/v1/context-valid-rules/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "contextId": "(val)",
    "ruleTypeId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "contextId": "(val)",
    "ruleTypeId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "contextId": "(val)",
    "ruleTypeId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "contextId": "(val)",
    "ruleTypeId": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Context Valid Rules by Key
DELETE/research-sys/api/v1/context-valid-rules/(key)

Example URI

DELETE /research-sys/api/v1/context-valid-rules/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Context Valid Rules
DELETE/research-sys/api/v1/context-valid-rules/

Example URI

DELETE /research-sys/api/v1/context-valid-rules/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Context Valid Rules with Matching
DELETE/research-sys/api/v1/context-valid-rules/

Example URI

DELETE /research-sys/api/v1/context-valid-rules/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 
contextId
string (optional) 
ruleTypeId
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Context Valid Terms

Get Context Valid Terms by Key
GET/research-sys/api/v1/context-valid-terms/(key)

Example URI

GET /research-sys/api/v1/context-valid-terms/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "contextId": "(val)",
  "_primaryKey": "(val)"
}

Get All Context Valid Terms
GET/research-sys/api/v1/context-valid-terms/

Example URI

GET /research-sys/api/v1/context-valid-terms/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "contextId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "contextId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Context Valid Terms with Filtering
GET/research-sys/api/v1/context-valid-terms/

Example URI

GET /research-sys/api/v1/context-valid-terms/
URI Parameters
HideShow
id
string (optional) 
contextId
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "contextId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "contextId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Context Valid Terms
GET/research-sys/api/v1/context-valid-terms/

Example URI

GET /research-sys/api/v1/context-valid-terms/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "contextId"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Context Valid Terms
GET/research-sys/api/v1/context-valid-terms/

Example URI

GET /research-sys/api/v1/context-valid-terms/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Context Valid Terms.md"
transfer-encoding: chunked

Update Context Valid Terms
PUT/research-sys/api/v1/context-valid-terms/(key)

Example URI

PUT /research-sys/api/v1/context-valid-terms/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "contextId": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Context Valid Terms
PUT/research-sys/api/v1/context-valid-terms/

Example URI

PUT /research-sys/api/v1/context-valid-terms/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "contextId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "contextId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Context Valid Terms
PATCH/research-sys/api/v1/context-valid-terms/(key)

Example URI

PATCH /research-sys/api/v1/context-valid-terms/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "contextId": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "contextId": "(val)",
  "_primaryKey": "(val)"
}

Insert Context Valid Terms
POST/research-sys/api/v1/context-valid-terms/

Example URI

POST /research-sys/api/v1/context-valid-terms/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "contextId": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "contextId": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Context Valid Terms
POST/research-sys/api/v1/context-valid-terms/

Example URI

POST /research-sys/api/v1/context-valid-terms/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "contextId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "contextId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "contextId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "contextId": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Context Valid Terms by Key
DELETE/research-sys/api/v1/context-valid-terms/(key)

Example URI

DELETE /research-sys/api/v1/context-valid-terms/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Context Valid Terms
DELETE/research-sys/api/v1/context-valid-terms/

Example URI

DELETE /research-sys/api/v1/context-valid-terms/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Context Valid Terms with Matching
DELETE/research-sys/api/v1/context-valid-terms/

Example URI

DELETE /research-sys/api/v1/context-valid-terms/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 
contextId
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Contexts

Get Contexts by Key
GET/research-sys/api/v1/contexts/(key)

Example URI

GET /research-sys/api/v1/contexts/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "name": "(val)",
  "namespace": "(val)",
  "typeId": "(val)",
  "description": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Get All Contexts
GET/research-sys/api/v1/contexts/

Example URI

GET /research-sys/api/v1/contexts/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "typeId": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "typeId": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Contexts with Filtering
GET/research-sys/api/v1/contexts/

Example URI

GET /research-sys/api/v1/contexts/
URI Parameters
HideShow
id
string (optional) 

Context Id.

name
string (optional) 

Context Name.

namespace
string (optional) 

Context Namespace.

typeId
string (optional) 

Context Type Id.

description
string (optional) 

Description.

active
string (optional) 

This attribute is used to describe whether the associated object is active or inactive. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "typeId": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "typeId": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Contexts
GET/research-sys/api/v1/contexts/

Example URI

GET /research-sys/api/v1/contexts/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "name",
    "namespace",
    "typeId",
    "description",
    "active"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Contexts
GET/research-sys/api/v1/contexts/

Example URI

GET /research-sys/api/v1/contexts/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Contexts.md"
transfer-encoding: chunked

Update Contexts
PUT/research-sys/api/v1/contexts/(key)

Example URI

PUT /research-sys/api/v1/contexts/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "name": "(val)",
  "namespace": "(val)",
  "typeId": "(val)",
  "description": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Contexts
PUT/research-sys/api/v1/contexts/

Example URI

PUT /research-sys/api/v1/contexts/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "typeId": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "typeId": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Contexts
PATCH/research-sys/api/v1/contexts/(key)

Example URI

PATCH /research-sys/api/v1/contexts/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "name": "(val)",
  "namespace": "(val)",
  "typeId": "(val)",
  "description": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "name": "(val)",
  "namespace": "(val)",
  "typeId": "(val)",
  "description": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Contexts
POST/research-sys/api/v1/contexts/

Example URI

POST /research-sys/api/v1/contexts/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "name": "(val)",
  "namespace": "(val)",
  "typeId": "(val)",
  "description": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "name": "(val)",
  "namespace": "(val)",
  "typeId": "(val)",
  "description": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Contexts
POST/research-sys/api/v1/contexts/

Example URI

POST /research-sys/api/v1/contexts/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "typeId": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "typeId": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "typeId": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "typeId": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Contexts by Key
DELETE/research-sys/api/v1/contexts/(key)

Example URI

DELETE /research-sys/api/v1/contexts/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Contexts
DELETE/research-sys/api/v1/contexts/

Example URI

DELETE /research-sys/api/v1/contexts/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Contexts with Matching
DELETE/research-sys/api/v1/contexts/

Example URI

DELETE /research-sys/api/v1/contexts/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 

Context Id.

name
string (optional) 

Context Name.

namespace
string (optional) 

Context Namespace.

typeId
string (optional) 

Context Type Id.

description
string (optional) 

Description.

active
string (optional) 

This attribute is used to describe whether the associated object is active or inactive. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Counties

Get Counties by Key
GET/research-sys/api/v1/counties/(key)

Example URI

GET /research-sys/api/v1/counties/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "code": "(val)",
  "countryCode": "(val)",
  "stateCode": "(val)",
  "name": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Get All Counties
GET/research-sys/api/v1/counties/

Example URI

GET /research-sys/api/v1/counties/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "code": "(val)",
    "countryCode": "(val)",
    "stateCode": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "code": "(val)",
    "countryCode": "(val)",
    "stateCode": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Counties with Filtering
GET/research-sys/api/v1/counties/

Example URI

GET /research-sys/api/v1/counties/
URI Parameters
HideShow
code
string (optional) 

The ten digit code for a County. Maximum length is 10.

countryCode
string (optional) 

The code uniquely identify a country. Maximum length is 2.

stateCode
string (optional) 

Postal State Code. Maximum length is 2.

name
string (optional) 

The name assigned to this County. Maximum length is 100.

active
string (optional) 

This attribute is used to describe whether the associated object is active or inactive. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "code": "(val)",
    "countryCode": "(val)",
    "stateCode": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "code": "(val)",
    "countryCode": "(val)",
    "stateCode": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Counties
GET/research-sys/api/v1/counties/

Example URI

GET /research-sys/api/v1/counties/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "code",
    "countryCode",
    "stateCode",
    "name",
    "active"
  ],
  "primaryKey": "code:countryCode:stateCode"
}

Get Blueprint API specification for Counties
GET/research-sys/api/v1/counties/

Example URI

GET /research-sys/api/v1/counties/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Counties.md"
transfer-encoding: chunked

Update Counties
PUT/research-sys/api/v1/counties/(key)

Example URI

PUT /research-sys/api/v1/counties/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "code": "(val)",
  "countryCode": "(val)",
  "stateCode": "(val)",
  "name": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Counties
PUT/research-sys/api/v1/counties/

Example URI

PUT /research-sys/api/v1/counties/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "code": "(val)",
    "countryCode": "(val)",
    "stateCode": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "code": "(val)",
    "countryCode": "(val)",
    "stateCode": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Counties
PATCH/research-sys/api/v1/counties/(key)

Example URI

PATCH /research-sys/api/v1/counties/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "code": "(val)",
  "countryCode": "(val)",
  "stateCode": "(val)",
  "name": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "code": "(val)",
  "countryCode": "(val)",
  "stateCode": "(val)",
  "name": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Counties
POST/research-sys/api/v1/counties/

Example URI

POST /research-sys/api/v1/counties/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "code": "(val)",
  "countryCode": "(val)",
  "stateCode": "(val)",
  "name": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "code": "(val)",
  "countryCode": "(val)",
  "stateCode": "(val)",
  "name": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Counties
POST/research-sys/api/v1/counties/

Example URI

POST /research-sys/api/v1/counties/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "code": "(val)",
    "countryCode": "(val)",
    "stateCode": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "code": "(val)",
    "countryCode": "(val)",
    "stateCode": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "code": "(val)",
    "countryCode": "(val)",
    "stateCode": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "code": "(val)",
    "countryCode": "(val)",
    "stateCode": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Counties by Key
DELETE/research-sys/api/v1/counties/(key)

Example URI

DELETE /research-sys/api/v1/counties/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Counties
DELETE/research-sys/api/v1/counties/

Example URI

DELETE /research-sys/api/v1/counties/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Counties with Matching
DELETE/research-sys/api/v1/counties/

Example URI

DELETE /research-sys/api/v1/counties/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

code
string (optional) 

The ten digit code for a County. Maximum length is 10.

countryCode
string (optional) 

The code uniquely identify a country. Maximum length is 2.

stateCode
string (optional) 

Postal State Code. Maximum length is 2.

name
string (optional) 

The name assigned to this County. Maximum length is 100.

active
string (optional) 

This attribute is used to describe whether the associated object is active or inactive. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Countries

Get Countries by Key
GET/research-sys/api/v1/countries/(key)

Example URI

GET /research-sys/api/v1/countries/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "code": "(val)",
  "alternateCode": "(val)",
  "name": "(val)",
  "restricted": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Get All Countries
GET/research-sys/api/v1/countries/

Example URI

GET /research-sys/api/v1/countries/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "code": "(val)",
    "alternateCode": "(val)",
    "name": "(val)",
    "restricted": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "code": "(val)",
    "alternateCode": "(val)",
    "name": "(val)",
    "restricted": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Countries with Filtering
GET/research-sys/api/v1/countries/

Example URI

GET /research-sys/api/v1/countries/
URI Parameters
HideShow
code
string (optional) 

The code uniquely identify a country. Maximum length is 2.

alternateCode
string (optional) 

The code uniquely identify a country. Maximum length is 3.

name
string (optional) 

Postal Country Name… Maximum length is 255.

restricted
string (optional) 

Restricted.

active
string (optional) 

This attribute is used to describe whether the associated object is active or inactive. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "code": "(val)",
    "alternateCode": "(val)",
    "name": "(val)",
    "restricted": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "code": "(val)",
    "alternateCode": "(val)",
    "name": "(val)",
    "restricted": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Countries
GET/research-sys/api/v1/countries/

Example URI

GET /research-sys/api/v1/countries/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "code",
    "alternateCode",
    "name",
    "restricted",
    "active"
  ],
  "primaryKey": "code"
}

Get Blueprint API specification for Countries
GET/research-sys/api/v1/countries/

Example URI

GET /research-sys/api/v1/countries/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Countries.md"
transfer-encoding: chunked

Update Countries
PUT/research-sys/api/v1/countries/(key)

Example URI

PUT /research-sys/api/v1/countries/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "code": "(val)",
  "alternateCode": "(val)",
  "name": "(val)",
  "restricted": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Countries
PUT/research-sys/api/v1/countries/

Example URI

PUT /research-sys/api/v1/countries/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "code": "(val)",
    "alternateCode": "(val)",
    "name": "(val)",
    "restricted": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "code": "(val)",
    "alternateCode": "(val)",
    "name": "(val)",
    "restricted": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Countries
PATCH/research-sys/api/v1/countries/(key)

Example URI

PATCH /research-sys/api/v1/countries/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "code": "(val)",
  "alternateCode": "(val)",
  "name": "(val)",
  "restricted": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "code": "(val)",
  "alternateCode": "(val)",
  "name": "(val)",
  "restricted": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Countries
POST/research-sys/api/v1/countries/

Example URI

POST /research-sys/api/v1/countries/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "code": "(val)",
  "alternateCode": "(val)",
  "name": "(val)",
  "restricted": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "code": "(val)",
  "alternateCode": "(val)",
  "name": "(val)",
  "restricted": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Countries
POST/research-sys/api/v1/countries/

Example URI

POST /research-sys/api/v1/countries/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "code": "(val)",
    "alternateCode": "(val)",
    "name": "(val)",
    "restricted": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "code": "(val)",
    "alternateCode": "(val)",
    "name": "(val)",
    "restricted": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "code": "(val)",
    "alternateCode": "(val)",
    "name": "(val)",
    "restricted": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "code": "(val)",
    "alternateCode": "(val)",
    "name": "(val)",
    "restricted": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Countries by Key
DELETE/research-sys/api/v1/countries/(key)

Example URI

DELETE /research-sys/api/v1/countries/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Countries
DELETE/research-sys/api/v1/countries/

Example URI

DELETE /research-sys/api/v1/countries/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Countries with Matching
DELETE/research-sys/api/v1/countries/

Example URI

DELETE /research-sys/api/v1/countries/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

code
string (optional) 

The code uniquely identify a country. Maximum length is 2.

alternateCode
string (optional) 

The code uniquely identify a country. Maximum length is 3.

name
string (optional) 

Postal Country Name… Maximum length is 255.

restricted
string (optional) 

Restricted.

active
string (optional) 

This attribute is used to describe whether the associated object is active or inactive. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delegate Member Attribute Data

Get Delegate Member Attribute Data by Key
GET/research-sys/api/v1/delegate-member-attribute-data/(key)

Example URI

GET /research-sys/api/v1/delegate-member-attribute-data/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "assignedToId": "(val)",
  "attributeValue": "(val)",
  "kimTypeId": "(val)",
  "kimAttributeId": "(val)",
  "_primaryKey": "(val)"
}

Get All Delegate Member Attribute Data
GET/research-sys/api/v1/delegate-member-attribute-data/

Example URI

GET /research-sys/api/v1/delegate-member-attribute-data/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "assignedToId": "(val)",
    "attributeValue": "(val)",
    "kimTypeId": "(val)",
    "kimAttributeId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "assignedToId": "(val)",
    "attributeValue": "(val)",
    "kimTypeId": "(val)",
    "kimAttributeId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Delegate Member Attribute Data with Filtering
GET/research-sys/api/v1/delegate-member-attribute-data/

Example URI

GET /research-sys/api/v1/delegate-member-attribute-data/
URI Parameters
HideShow
id
string (optional) 
assignedToId
string (optional) 
attributeValue
string (optional) 
kimTypeId
string (optional) 
kimAttributeId
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "assignedToId": "(val)",
    "attributeValue": "(val)",
    "kimTypeId": "(val)",
    "kimAttributeId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "assignedToId": "(val)",
    "attributeValue": "(val)",
    "kimTypeId": "(val)",
    "kimAttributeId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Delegate Member Attribute Data
GET/research-sys/api/v1/delegate-member-attribute-data/

Example URI

GET /research-sys/api/v1/delegate-member-attribute-data/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "assignedToId",
    "attributeValue",
    "kimTypeId",
    "kimAttributeId"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Delegate Member Attribute Data
GET/research-sys/api/v1/delegate-member-attribute-data/

Example URI

GET /research-sys/api/v1/delegate-member-attribute-data/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Delegate Member Attribute Data.md"
transfer-encoding: chunked

Update Delegate Member Attribute Data
PUT/research-sys/api/v1/delegate-member-attribute-data/(key)

Example URI

PUT /research-sys/api/v1/delegate-member-attribute-data/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "assignedToId": "(val)",
  "attributeValue": "(val)",
  "kimTypeId": "(val)",
  "kimAttributeId": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Delegate Member Attribute Data
PUT/research-sys/api/v1/delegate-member-attribute-data/

Example URI

PUT /research-sys/api/v1/delegate-member-attribute-data/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "assignedToId": "(val)",
    "attributeValue": "(val)",
    "kimTypeId": "(val)",
    "kimAttributeId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "assignedToId": "(val)",
    "attributeValue": "(val)",
    "kimTypeId": "(val)",
    "kimAttributeId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Delegate Member Attribute Data
PATCH/research-sys/api/v1/delegate-member-attribute-data/(key)

Example URI

PATCH /research-sys/api/v1/delegate-member-attribute-data/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "assignedToId": "(val)",
  "attributeValue": "(val)",
  "kimTypeId": "(val)",
  "kimAttributeId": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "assignedToId": "(val)",
  "attributeValue": "(val)",
  "kimTypeId": "(val)",
  "kimAttributeId": "(val)",
  "_primaryKey": "(val)"
}

Insert Delegate Member Attribute Data
POST/research-sys/api/v1/delegate-member-attribute-data/

Example URI

POST /research-sys/api/v1/delegate-member-attribute-data/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "assignedToId": "(val)",
  "attributeValue": "(val)",
  "kimTypeId": "(val)",
  "kimAttributeId": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "assignedToId": "(val)",
  "attributeValue": "(val)",
  "kimTypeId": "(val)",
  "kimAttributeId": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Delegate Member Attribute Data
POST/research-sys/api/v1/delegate-member-attribute-data/

Example URI

POST /research-sys/api/v1/delegate-member-attribute-data/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "assignedToId": "(val)",
    "attributeValue": "(val)",
    "kimTypeId": "(val)",
    "kimAttributeId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "assignedToId": "(val)",
    "attributeValue": "(val)",
    "kimTypeId": "(val)",
    "kimAttributeId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "assignedToId": "(val)",
    "attributeValue": "(val)",
    "kimTypeId": "(val)",
    "kimAttributeId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "assignedToId": "(val)",
    "attributeValue": "(val)",
    "kimTypeId": "(val)",
    "kimAttributeId": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Delegate Member Attribute Data by Key
DELETE/research-sys/api/v1/delegate-member-attribute-data/(key)

Example URI

DELETE /research-sys/api/v1/delegate-member-attribute-data/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Delegate Member Attribute Data
DELETE/research-sys/api/v1/delegate-member-attribute-data/

Example URI

DELETE /research-sys/api/v1/delegate-member-attribute-data/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Delegate Member Attribute Data with Matching
DELETE/research-sys/api/v1/delegate-member-attribute-data/

Example URI

DELETE /research-sys/api/v1/delegate-member-attribute-data/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 
assignedToId
string (optional) 
attributeValue
string (optional) 
kimTypeId
string (optional) 
kimAttributeId
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delegate Members

Get Delegate Members by Key
GET/research-sys/api/v1/delegate-members/(key)

Example URI

GET /research-sys/api/v1/delegate-members/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "delegationMemberId": "(val)",
  "delegationId": "(val)",
  "roleMemberId": "(val)",
  "activeFromDateValue": "(val)",
  "activeToDateValue": "(val)",
  "memberId": "(val)",
  "typeCode": "(val)",
  "_primaryKey": "(val)"
}

Get All Delegate Members
GET/research-sys/api/v1/delegate-members/

Example URI

GET /research-sys/api/v1/delegate-members/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "delegationMemberId": "(val)",
    "delegationId": "(val)",
    "roleMemberId": "(val)",
    "activeFromDateValue": "(val)",
    "activeToDateValue": "(val)",
    "memberId": "(val)",
    "typeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "delegationMemberId": "(val)",
    "delegationId": "(val)",
    "roleMemberId": "(val)",
    "activeFromDateValue": "(val)",
    "activeToDateValue": "(val)",
    "memberId": "(val)",
    "typeCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Delegate Members with Filtering
GET/research-sys/api/v1/delegate-members/

Example URI

GET /research-sys/api/v1/delegate-members/
URI Parameters
HideShow
delegationMemberId
string (optional) 
delegationId
string (optional) 
roleMemberId
string (optional) 
activeFromDateValue
string (optional) 
activeToDateValue
string (optional) 
memberId
string (optional) 
typeCode
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "delegationMemberId": "(val)",
    "delegationId": "(val)",
    "roleMemberId": "(val)",
    "activeFromDateValue": "(val)",
    "activeToDateValue": "(val)",
    "memberId": "(val)",
    "typeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "delegationMemberId": "(val)",
    "delegationId": "(val)",
    "roleMemberId": "(val)",
    "activeFromDateValue": "(val)",
    "activeToDateValue": "(val)",
    "memberId": "(val)",
    "typeCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Delegate Members
GET/research-sys/api/v1/delegate-members/

Example URI

GET /research-sys/api/v1/delegate-members/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "delegationMemberId",
    "delegationId",
    "roleMemberId",
    "activeFromDateValue",
    "activeToDateValue",
    "memberId",
    "typeCode"
  ],
  "primaryKey": "delegationMemberId"
}

Get Blueprint API specification for Delegate Members
GET/research-sys/api/v1/delegate-members/

Example URI

GET /research-sys/api/v1/delegate-members/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Delegate Members.md"
transfer-encoding: chunked

Update Delegate Members
PUT/research-sys/api/v1/delegate-members/(key)

Example URI

PUT /research-sys/api/v1/delegate-members/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "delegationMemberId": "(val)",
  "delegationId": "(val)",
  "roleMemberId": "(val)",
  "activeFromDateValue": "(val)",
  "activeToDateValue": "(val)",
  "memberId": "(val)",
  "typeCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Delegate Members
PUT/research-sys/api/v1/delegate-members/

Example URI

PUT /research-sys/api/v1/delegate-members/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "delegationMemberId": "(val)",
    "delegationId": "(val)",
    "roleMemberId": "(val)",
    "activeFromDateValue": "(val)",
    "activeToDateValue": "(val)",
    "memberId": "(val)",
    "typeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "delegationMemberId": "(val)",
    "delegationId": "(val)",
    "roleMemberId": "(val)",
    "activeFromDateValue": "(val)",
    "activeToDateValue": "(val)",
    "memberId": "(val)",
    "typeCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Delegate Members
PATCH/research-sys/api/v1/delegate-members/(key)

Example URI

PATCH /research-sys/api/v1/delegate-members/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "delegationMemberId": "(val)",
  "delegationId": "(val)",
  "roleMemberId": "(val)",
  "activeFromDateValue": "(val)",
  "activeToDateValue": "(val)",
  "memberId": "(val)",
  "typeCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "delegationMemberId": "(val)",
  "delegationId": "(val)",
  "roleMemberId": "(val)",
  "activeFromDateValue": "(val)",
  "activeToDateValue": "(val)",
  "memberId": "(val)",
  "typeCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Delegate Members
POST/research-sys/api/v1/delegate-members/

Example URI

POST /research-sys/api/v1/delegate-members/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "delegationMemberId": "(val)",
  "delegationId": "(val)",
  "roleMemberId": "(val)",
  "activeFromDateValue": "(val)",
  "activeToDateValue": "(val)",
  "memberId": "(val)",
  "typeCode": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "delegationMemberId": "(val)",
  "delegationId": "(val)",
  "roleMemberId": "(val)",
  "activeFromDateValue": "(val)",
  "activeToDateValue": "(val)",
  "memberId": "(val)",
  "typeCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Delegate Members
POST/research-sys/api/v1/delegate-members/

Example URI

POST /research-sys/api/v1/delegate-members/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "delegationMemberId": "(val)",
    "delegationId": "(val)",
    "roleMemberId": "(val)",
    "activeFromDateValue": "(val)",
    "activeToDateValue": "(val)",
    "memberId": "(val)",
    "typeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "delegationMemberId": "(val)",
    "delegationId": "(val)",
    "roleMemberId": "(val)",
    "activeFromDateValue": "(val)",
    "activeToDateValue": "(val)",
    "memberId": "(val)",
    "typeCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "delegationMemberId": "(val)",
    "delegationId": "(val)",
    "roleMemberId": "(val)",
    "activeFromDateValue": "(val)",
    "activeToDateValue": "(val)",
    "memberId": "(val)",
    "typeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "delegationMemberId": "(val)",
    "delegationId": "(val)",
    "roleMemberId": "(val)",
    "activeFromDateValue": "(val)",
    "activeToDateValue": "(val)",
    "memberId": "(val)",
    "typeCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Delegate Members by Key
DELETE/research-sys/api/v1/delegate-members/(key)

Example URI

DELETE /research-sys/api/v1/delegate-members/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Delegate Members
DELETE/research-sys/api/v1/delegate-members/

Example URI

DELETE /research-sys/api/v1/delegate-members/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Delegate Members with Matching
DELETE/research-sys/api/v1/delegate-members/

Example URI

DELETE /research-sys/api/v1/delegate-members/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

delegationMemberId
string (optional) 
delegationId
string (optional) 
roleMemberId
string (optional) 
activeFromDateValue
string (optional) 
activeToDateValue
string (optional) 
memberId
string (optional) 
typeCode
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delegate Types

Get Delegate Types by Key
GET/research-sys/api/v1/delegate-types/(key)

Example URI

GET /research-sys/api/v1/delegate-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "delegationId": "(val)",
  "roleId": "(val)",
  "active": "(val)",
  "kimTypeId": "(val)",
  "delegationTypeCode": "(val)",
  "_primaryKey": "(val)"
}

Get All Delegate Types
GET/research-sys/api/v1/delegate-types/

Example URI

GET /research-sys/api/v1/delegate-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "delegationId": "(val)",
    "roleId": "(val)",
    "active": "(val)",
    "kimTypeId": "(val)",
    "delegationTypeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "delegationId": "(val)",
    "roleId": "(val)",
    "active": "(val)",
    "kimTypeId": "(val)",
    "delegationTypeCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Delegate Types with Filtering
GET/research-sys/api/v1/delegate-types/

Example URI

GET /research-sys/api/v1/delegate-types/
URI Parameters
HideShow
delegationId
string (optional) 

Delegation. Maximum length is 10.

roleId
string (optional) 

Role. Maximum length is 10.

active
string (optional) 

This attribute is used to describe whether the associated object is active or inactive. Maximum length is 1.

kimTypeId
string (optional) 

Delegation Type. Maximum length is 40.

delegationTypeCode
string (optional) 

Delegation Type Code. Maximum length is 40.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "delegationId": "(val)",
    "roleId": "(val)",
    "active": "(val)",
    "kimTypeId": "(val)",
    "delegationTypeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "delegationId": "(val)",
    "roleId": "(val)",
    "active": "(val)",
    "kimTypeId": "(val)",
    "delegationTypeCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Delegate Types
GET/research-sys/api/v1/delegate-types/

Example URI

GET /research-sys/api/v1/delegate-types/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "delegationId",
    "roleId",
    "active",
    "kimTypeId",
    "delegationTypeCode"
  ],
  "primaryKey": "delegationId"
}

Get Blueprint API specification for Delegate Types
GET/research-sys/api/v1/delegate-types/

Example URI

GET /research-sys/api/v1/delegate-types/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Delegate Types.md"
transfer-encoding: chunked

Update Delegate Types
PUT/research-sys/api/v1/delegate-types/(key)

Example URI

PUT /research-sys/api/v1/delegate-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "delegationId": "(val)",
  "roleId": "(val)",
  "active": "(val)",
  "kimTypeId": "(val)",
  "delegationTypeCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Delegate Types
PUT/research-sys/api/v1/delegate-types/

Example URI

PUT /research-sys/api/v1/delegate-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "delegationId": "(val)",
    "roleId": "(val)",
    "active": "(val)",
    "kimTypeId": "(val)",
    "delegationTypeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "delegationId": "(val)",
    "roleId": "(val)",
    "active": "(val)",
    "kimTypeId": "(val)",
    "delegationTypeCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Delegate Types
PATCH/research-sys/api/v1/delegate-types/(key)

Example URI

PATCH /research-sys/api/v1/delegate-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "delegationId": "(val)",
  "roleId": "(val)",
  "active": "(val)",
  "kimTypeId": "(val)",
  "delegationTypeCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "delegationId": "(val)",
  "roleId": "(val)",
  "active": "(val)",
  "kimTypeId": "(val)",
  "delegationTypeCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Delegate Types
POST/research-sys/api/v1/delegate-types/

Example URI

POST /research-sys/api/v1/delegate-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "delegationId": "(val)",
  "roleId": "(val)",
  "active": "(val)",
  "kimTypeId": "(val)",
  "delegationTypeCode": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "delegationId": "(val)",
  "roleId": "(val)",
  "active": "(val)",
  "kimTypeId": "(val)",
  "delegationTypeCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Delegate Types
POST/research-sys/api/v1/delegate-types/

Example URI

POST /research-sys/api/v1/delegate-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "delegationId": "(val)",
    "roleId": "(val)",
    "active": "(val)",
    "kimTypeId": "(val)",
    "delegationTypeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "delegationId": "(val)",
    "roleId": "(val)",
    "active": "(val)",
    "kimTypeId": "(val)",
    "delegationTypeCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "delegationId": "(val)",
    "roleId": "(val)",
    "active": "(val)",
    "kimTypeId": "(val)",
    "delegationTypeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "delegationId": "(val)",
    "roleId": "(val)",
    "active": "(val)",
    "kimTypeId": "(val)",
    "delegationTypeCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Delegate Types by Key
DELETE/research-sys/api/v1/delegate-types/(key)

Example URI

DELETE /research-sys/api/v1/delegate-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Delegate Types
DELETE/research-sys/api/v1/delegate-types/

Example URI

DELETE /research-sys/api/v1/delegate-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Delegate Types with Matching
DELETE/research-sys/api/v1/delegate-types/

Example URI

DELETE /research-sys/api/v1/delegate-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

delegationId
string (optional) 

Delegation. Maximum length is 10.

roleId
string (optional) 

Role. Maximum length is 10.

active
string (optional) 

This attribute is used to describe whether the associated object is active or inactive. Maximum length is 1.

kimTypeId
string (optional) 

Delegation Type. Maximum length is 40.

delegationTypeCode
string (optional) 

Delegation Type Code. Maximum length is 40.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Derived Components

Get Derived Components by Key
GET/research-sys/api/v1/derived-components/(key)

Example URI

GET /research-sys/api/v1/derived-components/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "namespaceCode": "(val)",
  "code": "(val)",
  "name": "(val)",
  "componentSetId": "(val)",
  "_primaryKey": "(val)"
}

Get All Derived Components
GET/research-sys/api/v1/derived-components/

Example URI

GET /research-sys/api/v1/derived-components/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "namespaceCode": "(val)",
    "code": "(val)",
    "name": "(val)",
    "componentSetId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "namespaceCode": "(val)",
    "code": "(val)",
    "name": "(val)",
    "componentSetId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Derived Components with Filtering
GET/research-sys/api/v1/derived-components/

Example URI

GET /research-sys/api/v1/derived-components/
URI Parameters
HideShow
namespaceCode
string (optional) 
code
string (optional) 
name
string (optional) 
componentSetId
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "namespaceCode": "(val)",
    "code": "(val)",
    "name": "(val)",
    "componentSetId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "namespaceCode": "(val)",
    "code": "(val)",
    "name": "(val)",
    "componentSetId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Derived Components
GET/research-sys/api/v1/derived-components/

Example URI

GET /research-sys/api/v1/derived-components/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "namespaceCode",
    "code",
    "name",
    "componentSetId"
  ],
  "primaryKey": "code:namespaceCode"
}

Get Blueprint API specification for Derived Components
GET/research-sys/api/v1/derived-components/

Example URI

GET /research-sys/api/v1/derived-components/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Derived Components.md"
transfer-encoding: chunked

Update Derived Components
PUT/research-sys/api/v1/derived-components/(key)

Example URI

PUT /research-sys/api/v1/derived-components/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "namespaceCode": "(val)",
  "code": "(val)",
  "name": "(val)",
  "componentSetId": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Derived Components
PUT/research-sys/api/v1/derived-components/

Example URI

PUT /research-sys/api/v1/derived-components/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "namespaceCode": "(val)",
    "code": "(val)",
    "name": "(val)",
    "componentSetId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "namespaceCode": "(val)",
    "code": "(val)",
    "name": "(val)",
    "componentSetId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Derived Components
PATCH/research-sys/api/v1/derived-components/(key)

Example URI

PATCH /research-sys/api/v1/derived-components/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "namespaceCode": "(val)",
  "code": "(val)",
  "name": "(val)",
  "componentSetId": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "namespaceCode": "(val)",
  "code": "(val)",
  "name": "(val)",
  "componentSetId": "(val)",
  "_primaryKey": "(val)"
}

Insert Derived Components
POST/research-sys/api/v1/derived-components/

Example URI

POST /research-sys/api/v1/derived-components/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "namespaceCode": "(val)",
  "code": "(val)",
  "name": "(val)",
  "componentSetId": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "namespaceCode": "(val)",
  "code": "(val)",
  "name": "(val)",
  "componentSetId": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Derived Components
POST/research-sys/api/v1/derived-components/

Example URI

POST /research-sys/api/v1/derived-components/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "namespaceCode": "(val)",
    "code": "(val)",
    "name": "(val)",
    "componentSetId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "namespaceCode": "(val)",
    "code": "(val)",
    "name": "(val)",
    "componentSetId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "namespaceCode": "(val)",
    "code": "(val)",
    "name": "(val)",
    "componentSetId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "namespaceCode": "(val)",
    "code": "(val)",
    "name": "(val)",
    "componentSetId": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Derived Components by Key
DELETE/research-sys/api/v1/derived-components/(key)

Example URI

DELETE /research-sys/api/v1/derived-components/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Derived Components
DELETE/research-sys/api/v1/derived-components/

Example URI

DELETE /research-sys/api/v1/derived-components/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Derived Components with Matching
DELETE/research-sys/api/v1/derived-components/

Example URI

DELETE /research-sys/api/v1/derived-components/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

namespaceCode
string (optional) 
code
string (optional) 
name
string (optional) 
componentSetId
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Document Attachments

Get Document Attachments by Key
GET/research-sys/api/v1/document-attachments/(key)

Example URI

GET /research-sys/api/v1/document-attachments/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "documentNumber": "(val)",
  "fileName": "(val)",
  "attachmentContent": "(val)",
  "contentType": "(val)",
  "_primaryKey": "(val)"
}

Get All Document Attachments
GET/research-sys/api/v1/document-attachments/

Example URI

GET /research-sys/api/v1/document-attachments/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "documentNumber": "(val)",
    "fileName": "(val)",
    "attachmentContent": "(val)",
    "contentType": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "documentNumber": "(val)",
    "fileName": "(val)",
    "attachmentContent": "(val)",
    "contentType": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Document Attachments with Filtering
GET/research-sys/api/v1/document-attachments/

Example URI

GET /research-sys/api/v1/document-attachments/
URI Parameters
HideShow
documentNumber
string (optional) 
fileName
string (optional) 
attachmentContent
string (optional) 
contentType
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "documentNumber": "(val)",
    "fileName": "(val)",
    "attachmentContent": "(val)",
    "contentType": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "documentNumber": "(val)",
    "fileName": "(val)",
    "attachmentContent": "(val)",
    "contentType": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Document Attachments
GET/research-sys/api/v1/document-attachments/

Example URI

GET /research-sys/api/v1/document-attachments/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "documentNumber",
    "fileName",
    "attachmentContent",
    "contentType"
  ],
  "primaryKey": "documentNumber"
}

Get Blueprint API specification for Document Attachments
GET/research-sys/api/v1/document-attachments/

Example URI

GET /research-sys/api/v1/document-attachments/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Document Attachments.md"
transfer-encoding: chunked

Update Document Attachments
PUT/research-sys/api/v1/document-attachments/(key)

Example URI

PUT /research-sys/api/v1/document-attachments/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "documentNumber": "(val)",
  "fileName": "(val)",
  "attachmentContent": "(val)",
  "contentType": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Document Attachments
PUT/research-sys/api/v1/document-attachments/

Example URI

PUT /research-sys/api/v1/document-attachments/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "documentNumber": "(val)",
    "fileName": "(val)",
    "attachmentContent": "(val)",
    "contentType": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "documentNumber": "(val)",
    "fileName": "(val)",
    "attachmentContent": "(val)",
    "contentType": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Document Attachments
PATCH/research-sys/api/v1/document-attachments/(key)

Example URI

PATCH /research-sys/api/v1/document-attachments/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "documentNumber": "(val)",
  "fileName": "(val)",
  "attachmentContent": "(val)",
  "contentType": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "documentNumber": "(val)",
  "fileName": "(val)",
  "attachmentContent": "(val)",
  "contentType": "(val)",
  "_primaryKey": "(val)"
}

Insert Document Attachments
POST/research-sys/api/v1/document-attachments/

Example URI

POST /research-sys/api/v1/document-attachments/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "documentNumber": "(val)",
  "fileName": "(val)",
  "attachmentContent": "(val)",
  "contentType": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "documentNumber": "(val)",
  "fileName": "(val)",
  "attachmentContent": "(val)",
  "contentType": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Document Attachments
POST/research-sys/api/v1/document-attachments/

Example URI

POST /research-sys/api/v1/document-attachments/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "documentNumber": "(val)",
    "fileName": "(val)",
    "attachmentContent": "(val)",
    "contentType": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "documentNumber": "(val)",
    "fileName": "(val)",
    "attachmentContent": "(val)",
    "contentType": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "documentNumber": "(val)",
    "fileName": "(val)",
    "attachmentContent": "(val)",
    "contentType": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "documentNumber": "(val)",
    "fileName": "(val)",
    "attachmentContent": "(val)",
    "contentType": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Document Attachments by Key
DELETE/research-sys/api/v1/document-attachments/(key)

Example URI

DELETE /research-sys/api/v1/document-attachments/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Document Attachments
DELETE/research-sys/api/v1/document-attachments/

Example URI

DELETE /research-sys/api/v1/document-attachments/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Document Attachments with Matching
DELETE/research-sys/api/v1/document-attachments/

Example URI

DELETE /research-sys/api/v1/document-attachments/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

documentNumber
string (optional) 
fileName
string (optional) 
attachmentContent
string (optional) 
contentType
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Document Headers

Get Document Headers by Key
GET/research-sys/api/v1/document-headers/(key)

Example URI

GET /research-sys/api/v1/document-headers/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "documentNumber": "(val)",
  "documentDescription": "(val)",
  "organizationDocumentNumber": "(val)",
  "documentTemplateNumber": "(val)",
  "explanation": "(val)",
  "_primaryKey": "(val)"
}

Get All Document Headers
GET/research-sys/api/v1/document-headers/

Example URI

GET /research-sys/api/v1/document-headers/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "documentNumber": "(val)",
    "documentDescription": "(val)",
    "organizationDocumentNumber": "(val)",
    "documentTemplateNumber": "(val)",
    "explanation": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "documentNumber": "(val)",
    "documentDescription": "(val)",
    "organizationDocumentNumber": "(val)",
    "documentTemplateNumber": "(val)",
    "explanation": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Document Headers with Filtering
GET/research-sys/api/v1/document-headers/

Example URI

GET /research-sys/api/v1/document-headers/
URI Parameters
HideShow
documentNumber
string (optional) 

The document id is generated by the workflow environment and is unique to each installation of Kuali… Maximum length is 14.

documentDescription
string (optional) 

A free-form text field that describes the purpose or function of the document. Maximum length is 255.

organizationDocumentNumber
string (optional) 

The numeric document identification that may include departmental or organizational information. This number is not the same as the Document Number assigned by the Kuali System. Maximum length is 10.

documentTemplateNumber
string (optional) 

The document id is generated by the workflow environment and is unique to each installation of Kuali… Maximum length is 14.

explanation
string (optional) 

A free-form text field that explains the purpose of the document in more detail than the Description. Maximum length is 400.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "documentNumber": "(val)",
    "documentDescription": "(val)",
    "organizationDocumentNumber": "(val)",
    "documentTemplateNumber": "(val)",
    "explanation": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "documentNumber": "(val)",
    "documentDescription": "(val)",
    "organizationDocumentNumber": "(val)",
    "documentTemplateNumber": "(val)",
    "explanation": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Document Headers
GET/research-sys/api/v1/document-headers/

Example URI

GET /research-sys/api/v1/document-headers/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "documentNumber",
    "documentDescription",
    "organizationDocumentNumber",
    "documentTemplateNumber",
    "explanation"
  ],
  "primaryKey": "documentNumber"
}

Get Blueprint API specification for Document Headers
GET/research-sys/api/v1/document-headers/

Example URI

GET /research-sys/api/v1/document-headers/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Document Headers.md"
transfer-encoding: chunked

Update Document Headers
PUT/research-sys/api/v1/document-headers/(key)

Example URI

PUT /research-sys/api/v1/document-headers/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "documentNumber": "(val)",
  "documentDescription": "(val)",
  "organizationDocumentNumber": "(val)",
  "documentTemplateNumber": "(val)",
  "explanation": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Document Headers
PUT/research-sys/api/v1/document-headers/

Example URI

PUT /research-sys/api/v1/document-headers/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "documentNumber": "(val)",
    "documentDescription": "(val)",
    "organizationDocumentNumber": "(val)",
    "documentTemplateNumber": "(val)",
    "explanation": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "documentNumber": "(val)",
    "documentDescription": "(val)",
    "organizationDocumentNumber": "(val)",
    "documentTemplateNumber": "(val)",
    "explanation": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Document Headers
PATCH/research-sys/api/v1/document-headers/(key)

Example URI

PATCH /research-sys/api/v1/document-headers/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "documentNumber": "(val)",
  "documentDescription": "(val)",
  "organizationDocumentNumber": "(val)",
  "documentTemplateNumber": "(val)",
  "explanation": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "documentNumber": "(val)",
  "documentDescription": "(val)",
  "organizationDocumentNumber": "(val)",
  "documentTemplateNumber": "(val)",
  "explanation": "(val)",
  "_primaryKey": "(val)"
}

Insert Document Headers
POST/research-sys/api/v1/document-headers/

Example URI

POST /research-sys/api/v1/document-headers/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "documentNumber": "(val)",
  "documentDescription": "(val)",
  "organizationDocumentNumber": "(val)",
  "documentTemplateNumber": "(val)",
  "explanation": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "documentNumber": "(val)",
  "documentDescription": "(val)",
  "organizationDocumentNumber": "(val)",
  "documentTemplateNumber": "(val)",
  "explanation": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Document Headers
POST/research-sys/api/v1/document-headers/

Example URI

POST /research-sys/api/v1/document-headers/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "documentNumber": "(val)",
    "documentDescription": "(val)",
    "organizationDocumentNumber": "(val)",
    "documentTemplateNumber": "(val)",
    "explanation": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "documentNumber": "(val)",
    "documentDescription": "(val)",
    "organizationDocumentNumber": "(val)",
    "documentTemplateNumber": "(val)",
    "explanation": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "documentNumber": "(val)",
    "documentDescription": "(val)",
    "organizationDocumentNumber": "(val)",
    "documentTemplateNumber": "(val)",
    "explanation": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "documentNumber": "(val)",
    "documentDescription": "(val)",
    "organizationDocumentNumber": "(val)",
    "documentTemplateNumber": "(val)",
    "explanation": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Document Headers by Key
DELETE/research-sys/api/v1/document-headers/(key)

Example URI

DELETE /research-sys/api/v1/document-headers/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Document Headers
DELETE/research-sys/api/v1/document-headers/

Example URI

DELETE /research-sys/api/v1/document-headers/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Document Headers with Matching
DELETE/research-sys/api/v1/document-headers/

Example URI

DELETE /research-sys/api/v1/document-headers/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

documentNumber
string (optional) 

The document id is generated by the workflow environment and is unique to each installation of Kuali… Maximum length is 14.

documentDescription
string (optional) 

A free-form text field that describes the purpose or function of the document. Maximum length is 255.

organizationDocumentNumber
string (optional) 

The numeric document identification that may include departmental or organizational information. This number is not the same as the Document Number assigned by the Kuali System. Maximum length is 10.

documentTemplateNumber
string (optional) 

The document id is generated by the workflow environment and is unique to each installation of Kuali… Maximum length is 14.

explanation
string (optional) 

A free-form text field that explains the purpose of the document in more detail than the Description. Maximum length is 400.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Document Route Header Values

Get Document Route Header Values by Key
GET/research-sys/api/v1/document-route-header-values/(key)

Example URI

GET /research-sys/api/v1/document-route-header-values/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "documentId": "(val)",
  "documentTypeId": "(val)",
  "docRouteStatus": "(val)",
  "docRouteLevel": "(val)",
  "dateModified": "(val)",
  "createDate": "(val)",
  "approvedDate": "(val)",
  "finalizedDate": "(val)",
  "docTitle": "(val)",
  "appDocId": "(val)",
  "docVersion": "(val)",
  "initiatorWorkflowId": "(val)",
  "routedByUserWorkflowId": "(val)",
  "routeStatusDate": "(val)",
  "appDocStatus": "(val)",
  "appDocStatusDate": "(val)",
  "_primaryKey": "(val)"
}

Get All Document Route Header Values
GET/research-sys/api/v1/document-route-header-values/

Example URI

GET /research-sys/api/v1/document-route-header-values/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "documentId": "(val)",
    "documentTypeId": "(val)",
    "docRouteStatus": "(val)",
    "docRouteLevel": "(val)",
    "dateModified": "(val)",
    "createDate": "(val)",
    "approvedDate": "(val)",
    "finalizedDate": "(val)",
    "docTitle": "(val)",
    "appDocId": "(val)",
    "docVersion": "(val)",
    "initiatorWorkflowId": "(val)",
    "routedByUserWorkflowId": "(val)",
    "routeStatusDate": "(val)",
    "appDocStatus": "(val)",
    "appDocStatusDate": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "documentId": "(val)",
    "documentTypeId": "(val)",
    "docRouteStatus": "(val)",
    "docRouteLevel": "(val)",
    "dateModified": "(val)",
    "createDate": "(val)",
    "approvedDate": "(val)",
    "finalizedDate": "(val)",
    "docTitle": "(val)",
    "appDocId": "(val)",
    "docVersion": "(val)",
    "initiatorWorkflowId": "(val)",
    "routedByUserWorkflowId": "(val)",
    "routeStatusDate": "(val)",
    "appDocStatus": "(val)",
    "appDocStatusDate": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Document Route Header Values with Filtering
GET/research-sys/api/v1/document-route-header-values/

Example URI

GET /research-sys/api/v1/document-route-header-values/
URI Parameters
HideShow
documentId
string (optional) 

Document/Notification Id. Maximum length is 30.

documentTypeId
string (optional) 

Document Type Id.

docRouteStatus
string (optional) 

Doc Route Status.

docRouteLevel
string (optional) 

Doc Route Level.

dateModified
string (optional) 

Date Modified.

createDate
string (optional) 

This attribute should always be overriden on the descriptive elements. Maximum length is 21.

approvedDate
string (optional) 

Approved Date.

finalizedDate
string (optional) 

Finalized Date.

docTitle
string (optional) 

Title. Maximum length is 265.

appDocId
string (optional) 

App Doc Id.

docVersion
string (optional) 

Doc Version.

initiatorWorkflowId
string (optional) 

Initiator Workflow Id.

routedByUserWorkflowId
string (optional) 

Routed By User Workflow Id.

routeStatusDate
string (optional) 

Route Status Date.

appDocStatus
string (optional) 

Application Status. Maximum length is 64.

appDocStatusDate
string (optional) 

App Doc Status Date.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "documentId": "(val)",
    "documentTypeId": "(val)",
    "docRouteStatus": "(val)",
    "docRouteLevel": "(val)",
    "dateModified": "(val)",
    "createDate": "(val)",
    "approvedDate": "(val)",
    "finalizedDate": "(val)",
    "docTitle": "(val)",
    "appDocId": "(val)",
    "docVersion": "(val)",
    "initiatorWorkflowId": "(val)",
    "routedByUserWorkflowId": "(val)",
    "routeStatusDate": "(val)",
    "appDocStatus": "(val)",
    "appDocStatusDate": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "documentId": "(val)",
    "documentTypeId": "(val)",
    "docRouteStatus": "(val)",
    "docRouteLevel": "(val)",
    "dateModified": "(val)",
    "createDate": "(val)",
    "approvedDate": "(val)",
    "finalizedDate": "(val)",
    "docTitle": "(val)",
    "appDocId": "(val)",
    "docVersion": "(val)",
    "initiatorWorkflowId": "(val)",
    "routedByUserWorkflowId": "(val)",
    "routeStatusDate": "(val)",
    "appDocStatus": "(val)",
    "appDocStatusDate": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Document Route Header Values
GET/research-sys/api/v1/document-route-header-values/

Example URI

GET /research-sys/api/v1/document-route-header-values/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "documentId",
    "documentTypeId",
    "docRouteStatus",
    "docRouteLevel",
    "dateModified",
    "createDate",
    "approvedDate",
    "finalizedDate",
    "docTitle",
    "appDocId",
    "docVersion",
    "initiatorWorkflowId",
    "routedByUserWorkflowId",
    "routeStatusDate",
    "appDocStatus",
    "appDocStatusDate"
  ],
  "primaryKey": "documentId"
}

Get Blueprint API specification for Document Route Header Values
GET/research-sys/api/v1/document-route-header-values/

Example URI

GET /research-sys/api/v1/document-route-header-values/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Document Route Header Values.md"
transfer-encoding: chunked

Update Document Route Header Values
PUT/research-sys/api/v1/document-route-header-values/(key)

Example URI

PUT /research-sys/api/v1/document-route-header-values/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "documentId": "(val)",
  "documentTypeId": "(val)",
  "docRouteStatus": "(val)",
  "docRouteLevel": "(val)",
  "dateModified": "(val)",
  "createDate": "(val)",
  "approvedDate": "(val)",
  "finalizedDate": "(val)",
  "docTitle": "(val)",
  "appDocId": "(val)",
  "docVersion": "(val)",
  "initiatorWorkflowId": "(val)",
  "routedByUserWorkflowId": "(val)",
  "routeStatusDate": "(val)",
  "appDocStatus": "(val)",
  "appDocStatusDate": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Document Route Header Values
PUT/research-sys/api/v1/document-route-header-values/

Example URI

PUT /research-sys/api/v1/document-route-header-values/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "documentId": "(val)",
    "documentTypeId": "(val)",
    "docRouteStatus": "(val)",
    "docRouteLevel": "(val)",
    "dateModified": "(val)",
    "createDate": "(val)",
    "approvedDate": "(val)",
    "finalizedDate": "(val)",
    "docTitle": "(val)",
    "appDocId": "(val)",
    "docVersion": "(val)",
    "initiatorWorkflowId": "(val)",
    "routedByUserWorkflowId": "(val)",
    "routeStatusDate": "(val)",
    "appDocStatus": "(val)",
    "appDocStatusDate": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "documentId": "(val)",
    "documentTypeId": "(val)",
    "docRouteStatus": "(val)",
    "docRouteLevel": "(val)",
    "dateModified": "(val)",
    "createDate": "(val)",
    "approvedDate": "(val)",
    "finalizedDate": "(val)",
    "docTitle": "(val)",
    "appDocId": "(val)",
    "docVersion": "(val)",
    "initiatorWorkflowId": "(val)",
    "routedByUserWorkflowId": "(val)",
    "routeStatusDate": "(val)",
    "appDocStatus": "(val)",
    "appDocStatusDate": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Document Route Header Values
PATCH/research-sys/api/v1/document-route-header-values/(key)

Example URI

PATCH /research-sys/api/v1/document-route-header-values/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "documentId": "(val)",
  "documentTypeId": "(val)",
  "docRouteStatus": "(val)",
  "docRouteLevel": "(val)",
  "dateModified": "(val)",
  "createDate": "(val)",
  "approvedDate": "(val)",
  "finalizedDate": "(val)",
  "docTitle": "(val)",
  "appDocId": "(val)",
  "docVersion": "(val)",
  "initiatorWorkflowId": "(val)",
  "routedByUserWorkflowId": "(val)",
  "routeStatusDate": "(val)",
  "appDocStatus": "(val)",
  "appDocStatusDate": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "documentId": "(val)",
  "documentTypeId": "(val)",
  "docRouteStatus": "(val)",
  "docRouteLevel": "(val)",
  "dateModified": "(val)",
  "createDate": "(val)",
  "approvedDate": "(val)",
  "finalizedDate": "(val)",
  "docTitle": "(val)",
  "appDocId": "(val)",
  "docVersion": "(val)",
  "initiatorWorkflowId": "(val)",
  "routedByUserWorkflowId": "(val)",
  "routeStatusDate": "(val)",
  "appDocStatus": "(val)",
  "appDocStatusDate": "(val)",
  "_primaryKey": "(val)"
}

Insert Document Route Header Values
POST/research-sys/api/v1/document-route-header-values/

Example URI

POST /research-sys/api/v1/document-route-header-values/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "documentId": "(val)",
  "documentTypeId": "(val)",
  "docRouteStatus": "(val)",
  "docRouteLevel": "(val)",
  "dateModified": "(val)",
  "createDate": "(val)",
  "approvedDate": "(val)",
  "finalizedDate": "(val)",
  "docTitle": "(val)",
  "appDocId": "(val)",
  "docVersion": "(val)",
  "initiatorWorkflowId": "(val)",
  "routedByUserWorkflowId": "(val)",
  "routeStatusDate": "(val)",
  "appDocStatus": "(val)",
  "appDocStatusDate": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "documentId": "(val)",
  "documentTypeId": "(val)",
  "docRouteStatus": "(val)",
  "docRouteLevel": "(val)",
  "dateModified": "(val)",
  "createDate": "(val)",
  "approvedDate": "(val)",
  "finalizedDate": "(val)",
  "docTitle": "(val)",
  "appDocId": "(val)",
  "docVersion": "(val)",
  "initiatorWorkflowId": "(val)",
  "routedByUserWorkflowId": "(val)",
  "routeStatusDate": "(val)",
  "appDocStatus": "(val)",
  "appDocStatusDate": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Document Route Header Values
POST/research-sys/api/v1/document-route-header-values/

Example URI

POST /research-sys/api/v1/document-route-header-values/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "documentId": "(val)",
    "documentTypeId": "(val)",
    "docRouteStatus": "(val)",
    "docRouteLevel": "(val)",
    "dateModified": "(val)",
    "createDate": "(val)",
    "approvedDate": "(val)",
    "finalizedDate": "(val)",
    "docTitle": "(val)",
    "appDocId": "(val)",
    "docVersion": "(val)",
    "initiatorWorkflowId": "(val)",
    "routedByUserWorkflowId": "(val)",
    "routeStatusDate": "(val)",
    "appDocStatus": "(val)",
    "appDocStatusDate": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "documentId": "(val)",
    "documentTypeId": "(val)",
    "docRouteStatus": "(val)",
    "docRouteLevel": "(val)",
    "dateModified": "(val)",
    "createDate": "(val)",
    "approvedDate": "(val)",
    "finalizedDate": "(val)",
    "docTitle": "(val)",
    "appDocId": "(val)",
    "docVersion": "(val)",
    "initiatorWorkflowId": "(val)",
    "routedByUserWorkflowId": "(val)",
    "routeStatusDate": "(val)",
    "appDocStatus": "(val)",
    "appDocStatusDate": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "documentId": "(val)",
    "documentTypeId": "(val)",
    "docRouteStatus": "(val)",
    "docRouteLevel": "(val)",
    "dateModified": "(val)",
    "createDate": "(val)",
    "approvedDate": "(val)",
    "finalizedDate": "(val)",
    "docTitle": "(val)",
    "appDocId": "(val)",
    "docVersion": "(val)",
    "initiatorWorkflowId": "(val)",
    "routedByUserWorkflowId": "(val)",
    "routeStatusDate": "(val)",
    "appDocStatus": "(val)",
    "appDocStatusDate": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "documentId": "(val)",
    "documentTypeId": "(val)",
    "docRouteStatus": "(val)",
    "docRouteLevel": "(val)",
    "dateModified": "(val)",
    "createDate": "(val)",
    "approvedDate": "(val)",
    "finalizedDate": "(val)",
    "docTitle": "(val)",
    "appDocId": "(val)",
    "docVersion": "(val)",
    "initiatorWorkflowId": "(val)",
    "routedByUserWorkflowId": "(val)",
    "routeStatusDate": "(val)",
    "appDocStatus": "(val)",
    "appDocStatusDate": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Document Route Header Values by Key
DELETE/research-sys/api/v1/document-route-header-values/(key)

Example URI

DELETE /research-sys/api/v1/document-route-header-values/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Document Route Header Values
DELETE/research-sys/api/v1/document-route-header-values/

Example URI

DELETE /research-sys/api/v1/document-route-header-values/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Document Route Header Values with Matching
DELETE/research-sys/api/v1/document-route-header-values/

Example URI

DELETE /research-sys/api/v1/document-route-header-values/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

documentId
string (optional) 

Document/Notification Id. Maximum length is 30.

documentTypeId
string (optional) 

Document Type Id.

docRouteStatus
string (optional) 

Doc Route Status.

docRouteLevel
string (optional) 

Doc Route Level.

dateModified
string (optional) 

Date Modified.

createDate
string (optional) 

This attribute should always be overriden on the descriptive elements. Maximum length is 21.

approvedDate
string (optional) 

Approved Date.

finalizedDate
string (optional) 

Finalized Date.

docTitle
string (optional) 

Title. Maximum length is 265.

appDocId
string (optional) 

App Doc Id.

docVersion
string (optional) 

Doc Version.

initiatorWorkflowId
string (optional) 

Initiator Workflow Id.

routedByUserWorkflowId
string (optional) 

Routed By User Workflow Id.

routeStatusDate
string (optional) 

Route Status Date.

appDocStatus
string (optional) 

Application Status. Maximum length is 64.

appDocStatusDate
string (optional) 

App Doc Status Date.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Document Type Attributes

Get Document Type Attributes by Key
GET/research-sys/api/v1/document-type-attributes/(key)

Example URI

GET /research-sys/api/v1/document-type-attributes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "ruleAttributeId": "(val)",
  "documentTypeId": "(val)",
  "orderIndex": "(val)",
  "_primaryKey": "(val)"
}

Get All Document Type Attributes
GET/research-sys/api/v1/document-type-attributes/

Example URI

GET /research-sys/api/v1/document-type-attributes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "ruleAttributeId": "(val)",
    "documentTypeId": "(val)",
    "orderIndex": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "ruleAttributeId": "(val)",
    "documentTypeId": "(val)",
    "orderIndex": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Document Type Attributes with Filtering
GET/research-sys/api/v1/document-type-attributes/

Example URI

GET /research-sys/api/v1/document-type-attributes/
URI Parameters
HideShow
id
string (optional) 
ruleAttributeId
string (optional) 
documentTypeId
string (optional) 
orderIndex
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "ruleAttributeId": "(val)",
    "documentTypeId": "(val)",
    "orderIndex": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "ruleAttributeId": "(val)",
    "documentTypeId": "(val)",
    "orderIndex": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Document Type Attributes
GET/research-sys/api/v1/document-type-attributes/

Example URI

GET /research-sys/api/v1/document-type-attributes/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "ruleAttributeId",
    "documentTypeId",
    "orderIndex"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Document Type Attributes
GET/research-sys/api/v1/document-type-attributes/

Example URI

GET /research-sys/api/v1/document-type-attributes/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Document Type Attributes.md"
transfer-encoding: chunked

Update Document Type Attributes
PUT/research-sys/api/v1/document-type-attributes/(key)

Example URI

PUT /research-sys/api/v1/document-type-attributes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "ruleAttributeId": "(val)",
  "documentTypeId": "(val)",
  "orderIndex": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Document Type Attributes
PUT/research-sys/api/v1/document-type-attributes/

Example URI

PUT /research-sys/api/v1/document-type-attributes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "ruleAttributeId": "(val)",
    "documentTypeId": "(val)",
    "orderIndex": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "ruleAttributeId": "(val)",
    "documentTypeId": "(val)",
    "orderIndex": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Document Type Attributes
PATCH/research-sys/api/v1/document-type-attributes/(key)

Example URI

PATCH /research-sys/api/v1/document-type-attributes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "ruleAttributeId": "(val)",
  "documentTypeId": "(val)",
  "orderIndex": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "ruleAttributeId": "(val)",
  "documentTypeId": "(val)",
  "orderIndex": "(val)",
  "_primaryKey": "(val)"
}

Insert Document Type Attributes
POST/research-sys/api/v1/document-type-attributes/

Example URI

POST /research-sys/api/v1/document-type-attributes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "ruleAttributeId": "(val)",
  "documentTypeId": "(val)",
  "orderIndex": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "ruleAttributeId": "(val)",
  "documentTypeId": "(val)",
  "orderIndex": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Document Type Attributes
POST/research-sys/api/v1/document-type-attributes/

Example URI

POST /research-sys/api/v1/document-type-attributes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "ruleAttributeId": "(val)",
    "documentTypeId": "(val)",
    "orderIndex": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "ruleAttributeId": "(val)",
    "documentTypeId": "(val)",
    "orderIndex": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "ruleAttributeId": "(val)",
    "documentTypeId": "(val)",
    "orderIndex": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "ruleAttributeId": "(val)",
    "documentTypeId": "(val)",
    "orderIndex": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Document Type Attributes by Key
DELETE/research-sys/api/v1/document-type-attributes/(key)

Example URI

DELETE /research-sys/api/v1/document-type-attributes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Document Type Attributes
DELETE/research-sys/api/v1/document-type-attributes/

Example URI

DELETE /research-sys/api/v1/document-type-attributes/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Document Type Attributes with Matching
DELETE/research-sys/api/v1/document-type-attributes/

Example URI

DELETE /research-sys/api/v1/document-type-attributes/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 
ruleAttributeId
string (optional) 
documentTypeId
string (optional) 
orderIndex
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Document Type Policies

Get Document Type Policies by Key
GET/research-sys/api/v1/document-type-policies/(key)

Example URI

GET /research-sys/api/v1/document-type-policies/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "policyName": "(val)",
  "policyValue": "(val)",
  "policyStringValue": "(val)",
  "_primaryKey": "(val)"
}

Get All Document Type Policies
GET/research-sys/api/v1/document-type-policies/

Example URI

GET /research-sys/api/v1/document-type-policies/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "policyName": "(val)",
    "policyValue": "(val)",
    "policyStringValue": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "policyName": "(val)",
    "policyValue": "(val)",
    "policyStringValue": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Document Type Policies with Filtering
GET/research-sys/api/v1/document-type-policies/

Example URI

GET /research-sys/api/v1/document-type-policies/
URI Parameters
HideShow
policyName
string (optional) 
policyValue
string (optional) 
policyStringValue
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "policyName": "(val)",
    "policyValue": "(val)",
    "policyStringValue": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "policyName": "(val)",
    "policyValue": "(val)",
    "policyStringValue": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Document Type Policies
GET/research-sys/api/v1/document-type-policies/

Example URI

GET /research-sys/api/v1/document-type-policies/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "policyName",
    "policyValue",
    "policyStringValue"
  ],
  "primaryKey": "documentType:policyName"
}

Get Blueprint API specification for Document Type Policies
GET/research-sys/api/v1/document-type-policies/

Example URI

GET /research-sys/api/v1/document-type-policies/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Document Type Policies.md"
transfer-encoding: chunked

Update Document Type Policies
PUT/research-sys/api/v1/document-type-policies/(key)

Example URI

PUT /research-sys/api/v1/document-type-policies/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "policyName": "(val)",
  "policyValue": "(val)",
  "policyStringValue": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Document Type Policies
PUT/research-sys/api/v1/document-type-policies/

Example URI

PUT /research-sys/api/v1/document-type-policies/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "policyName": "(val)",
    "policyValue": "(val)",
    "policyStringValue": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "policyName": "(val)",
    "policyValue": "(val)",
    "policyStringValue": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Document Type Policies
PATCH/research-sys/api/v1/document-type-policies/(key)

Example URI

PATCH /research-sys/api/v1/document-type-policies/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "policyName": "(val)",
  "policyValue": "(val)",
  "policyStringValue": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "policyName": "(val)",
  "policyValue": "(val)",
  "policyStringValue": "(val)",
  "_primaryKey": "(val)"
}

Insert Document Type Policies
POST/research-sys/api/v1/document-type-policies/

Example URI

POST /research-sys/api/v1/document-type-policies/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "policyName": "(val)",
  "policyValue": "(val)",
  "policyStringValue": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "policyName": "(val)",
  "policyValue": "(val)",
  "policyStringValue": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Document Type Policies
POST/research-sys/api/v1/document-type-policies/

Example URI

POST /research-sys/api/v1/document-type-policies/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "policyName": "(val)",
    "policyValue": "(val)",
    "policyStringValue": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "policyName": "(val)",
    "policyValue": "(val)",
    "policyStringValue": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "policyName": "(val)",
    "policyValue": "(val)",
    "policyStringValue": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "policyName": "(val)",
    "policyValue": "(val)",
    "policyStringValue": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Document Type Policies by Key
DELETE/research-sys/api/v1/document-type-policies/(key)

Example URI

DELETE /research-sys/api/v1/document-type-policies/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Document Type Policies
DELETE/research-sys/api/v1/document-type-policies/

Example URI

DELETE /research-sys/api/v1/document-type-policies/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Document Type Policies with Matching
DELETE/research-sys/api/v1/document-type-policies/

Example URI

DELETE /research-sys/api/v1/document-type-policies/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

policyName
string (optional) 
policyValue
string (optional) 
policyStringValue
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Document Types

Get Document Types by Key
GET/research-sys/api/v1/document-types/(key)

Example URI

GET /research-sys/api/v1/document-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "documentTypeId": "(val)",
  "docTypeParentId": "(val)",
  "name": "(val)",
  "version": "(val)",
  "active": "(val)",
  "currentInd": "(val)",
  "description": "(val)",
  "label": "(val)",
  "previousVersionId": "(val)",
  "documentId": "(val)",
  "unresolvedHelpDefinitionUrl": "(val)",
  "unresolvedDocSearchHelpUrl": "(val)",
  "unresolvedDocHandlerUrl": "(val)",
  "postProcessorName": "(val)",
  "workgroupId": "(val)",
  "blanketApproveWorkgroupId": "(val)",
  "blanketApprovePolicy": "(val)",
  "reportingWorkgroupId": "(val)",
  "actualApplicationId": "(val)",
  "authorizer": "(val)",
  "routingVersion": "(val)",
  "actualNotificationFromAddress": "(val)",
  "documentTypeSecurityXml": "(val)",
  "customEmailStylesheet": "(val)",
  "_primaryKey": "(val)"
}

Get All Document Types
GET/research-sys/api/v1/document-types/

Example URI

GET /research-sys/api/v1/document-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "documentTypeId": "(val)",
    "docTypeParentId": "(val)",
    "name": "(val)",
    "version": "(val)",
    "active": "(val)",
    "currentInd": "(val)",
    "description": "(val)",
    "label": "(val)",
    "previousVersionId": "(val)",
    "documentId": "(val)",
    "unresolvedHelpDefinitionUrl": "(val)",
    "unresolvedDocSearchHelpUrl": "(val)",
    "unresolvedDocHandlerUrl": "(val)",
    "postProcessorName": "(val)",
    "workgroupId": "(val)",
    "blanketApproveWorkgroupId": "(val)",
    "blanketApprovePolicy": "(val)",
    "reportingWorkgroupId": "(val)",
    "actualApplicationId": "(val)",
    "authorizer": "(val)",
    "routingVersion": "(val)",
    "actualNotificationFromAddress": "(val)",
    "documentTypeSecurityXml": "(val)",
    "customEmailStylesheet": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "documentTypeId": "(val)",
    "docTypeParentId": "(val)",
    "name": "(val)",
    "version": "(val)",
    "active": "(val)",
    "currentInd": "(val)",
    "description": "(val)",
    "label": "(val)",
    "previousVersionId": "(val)",
    "documentId": "(val)",
    "unresolvedHelpDefinitionUrl": "(val)",
    "unresolvedDocSearchHelpUrl": "(val)",
    "unresolvedDocHandlerUrl": "(val)",
    "postProcessorName": "(val)",
    "workgroupId": "(val)",
    "blanketApproveWorkgroupId": "(val)",
    "blanketApprovePolicy": "(val)",
    "reportingWorkgroupId": "(val)",
    "actualApplicationId": "(val)",
    "authorizer": "(val)",
    "routingVersion": "(val)",
    "actualNotificationFromAddress": "(val)",
    "documentTypeSecurityXml": "(val)",
    "customEmailStylesheet": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Document Types with Filtering
GET/research-sys/api/v1/document-types/

Example URI

GET /research-sys/api/v1/document-types/
URI Parameters
HideShow
documentTypeId
string (optional) 

Id. Maximum length is 19.

docTypeParentId
string (optional) 

Parent Id. Maximum length is 19.

name
string (optional) 

Name. Maximum length is 64.

version
string (optional) 

Version.

active
string (optional) 

Active Indicator. Maximum length is 1.

currentInd
string (optional) 

Current Ind.

description
string (optional) 

Description. Maximum length is 4000.

label
string (optional) 

Label. Maximum length is 128.

previousVersionId
string (optional) 

Previous Version Id.

documentId
string (optional) 

Document Id.

unresolvedHelpDefinitionUrl
string (optional) 

Help Definition URL. Maximum length is 255.

unresolvedDocSearchHelpUrl
string (optional) 

Document Search Help URL. Maximum length is 255.

unresolvedDocHandlerUrl
string (optional) 

Document Handler URL. Maximum length is 255.

postProcessorName
string (optional) 

Post Processor Name.

workgroupId
string (optional) 

Workgroup Id.

blanketApproveWorkgroupId
string (optional) 

Blanket Approve Workgroup Id.

blanketApprovePolicy
string (optional) 

Blanket Approve Policy.

reportingWorkgroupId
string (optional) 

Reporting Workgroup Id.

actualApplicationId
string (optional) 

Actual Application Id.

authorizer
string (optional) 

Authorizer.

routingVersion
string (optional) 

Routing Version.

actualNotificationFromAddress
string (optional) 

Notification From Address. Maximum length is 255.

documentTypeSecurityXml
string (optional) 

Document Type Security Xml.

customEmailStylesheet
string (optional) 

Custom Email Stylesheet.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "documentTypeId": "(val)",
    "docTypeParentId": "(val)",
    "name": "(val)",
    "version": "(val)",
    "active": "(val)",
    "currentInd": "(val)",
    "description": "(val)",
    "label": "(val)",
    "previousVersionId": "(val)",
    "documentId": "(val)",
    "unresolvedHelpDefinitionUrl": "(val)",
    "unresolvedDocSearchHelpUrl": "(val)",
    "unresolvedDocHandlerUrl": "(val)",
    "postProcessorName": "(val)",
    "workgroupId": "(val)",
    "blanketApproveWorkgroupId": "(val)",
    "blanketApprovePolicy": "(val)",
    "reportingWorkgroupId": "(val)",
    "actualApplicationId": "(val)",
    "authorizer": "(val)",
    "routingVersion": "(val)",
    "actualNotificationFromAddress": "(val)",
    "documentTypeSecurityXml": "(val)",
    "customEmailStylesheet": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "documentTypeId": "(val)",
    "docTypeParentId": "(val)",
    "name": "(val)",
    "version": "(val)",
    "active": "(val)",
    "currentInd": "(val)",
    "description": "(val)",
    "label": "(val)",
    "previousVersionId": "(val)",
    "documentId": "(val)",
    "unresolvedHelpDefinitionUrl": "(val)",
    "unresolvedDocSearchHelpUrl": "(val)",
    "unresolvedDocHandlerUrl": "(val)",
    "postProcessorName": "(val)",
    "workgroupId": "(val)",
    "blanketApproveWorkgroupId": "(val)",
    "blanketApprovePolicy": "(val)",
    "reportingWorkgroupId": "(val)",
    "actualApplicationId": "(val)",
    "authorizer": "(val)",
    "routingVersion": "(val)",
    "actualNotificationFromAddress": "(val)",
    "documentTypeSecurityXml": "(val)",
    "customEmailStylesheet": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Document Types
GET/research-sys/api/v1/document-types/

Example URI

GET /research-sys/api/v1/document-types/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "documentTypeId",
    "docTypeParentId",
    "name",
    "version",
    "active",
    "currentInd",
    "description",
    "label",
    "previousVersionId",
    "documentId",
    "unresolvedHelpDefinitionUrl",
    "unresolvedDocSearchHelpUrl",
    "unresolvedDocHandlerUrl",
    "postProcessorName",
    "workgroupId",
    "blanketApproveWorkgroupId",
    "blanketApprovePolicy",
    "reportingWorkgroupId",
    "actualApplicationId",
    "authorizer",
    "routingVersion",
    "actualNotificationFromAddress",
    "documentTypeSecurityXml",
    "customEmailStylesheet"
  ],
  "primaryKey": "documentTypeId"
}

Get Blueprint API specification for Document Types
GET/research-sys/api/v1/document-types/

Example URI

GET /research-sys/api/v1/document-types/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Document Types.md"
transfer-encoding: chunked

Update Document Types
PUT/research-sys/api/v1/document-types/(key)

Example URI

PUT /research-sys/api/v1/document-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "documentTypeId": "(val)",
  "docTypeParentId": "(val)",
  "name": "(val)",
  "version": "(val)",
  "active": "(val)",
  "currentInd": "(val)",
  "description": "(val)",
  "label": "(val)",
  "previousVersionId": "(val)",
  "documentId": "(val)",
  "unresolvedHelpDefinitionUrl": "(val)",
  "unresolvedDocSearchHelpUrl": "(val)",
  "unresolvedDocHandlerUrl": "(val)",
  "postProcessorName": "(val)",
  "workgroupId": "(val)",
  "blanketApproveWorkgroupId": "(val)",
  "blanketApprovePolicy": "(val)",
  "reportingWorkgroupId": "(val)",
  "actualApplicationId": "(val)",
  "authorizer": "(val)",
  "routingVersion": "(val)",
  "actualNotificationFromAddress": "(val)",
  "documentTypeSecurityXml": "(val)",
  "customEmailStylesheet": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Document Types
PUT/research-sys/api/v1/document-types/

Example URI

PUT /research-sys/api/v1/document-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "documentTypeId": "(val)",
    "docTypeParentId": "(val)",
    "name": "(val)",
    "version": "(val)",
    "active": "(val)",
    "currentInd": "(val)",
    "description": "(val)",
    "label": "(val)",
    "previousVersionId": "(val)",
    "documentId": "(val)",
    "unresolvedHelpDefinitionUrl": "(val)",
    "unresolvedDocSearchHelpUrl": "(val)",
    "unresolvedDocHandlerUrl": "(val)",
    "postProcessorName": "(val)",
    "workgroupId": "(val)",
    "blanketApproveWorkgroupId": "(val)",
    "blanketApprovePolicy": "(val)",
    "reportingWorkgroupId": "(val)",
    "actualApplicationId": "(val)",
    "authorizer": "(val)",
    "routingVersion": "(val)",
    "actualNotificationFromAddress": "(val)",
    "documentTypeSecurityXml": "(val)",
    "customEmailStylesheet": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "documentTypeId": "(val)",
    "docTypeParentId": "(val)",
    "name": "(val)",
    "version": "(val)",
    "active": "(val)",
    "currentInd": "(val)",
    "description": "(val)",
    "label": "(val)",
    "previousVersionId": "(val)",
    "documentId": "(val)",
    "unresolvedHelpDefinitionUrl": "(val)",
    "unresolvedDocSearchHelpUrl": "(val)",
    "unresolvedDocHandlerUrl": "(val)",
    "postProcessorName": "(val)",
    "workgroupId": "(val)",
    "blanketApproveWorkgroupId": "(val)",
    "blanketApprovePolicy": "(val)",
    "reportingWorkgroupId": "(val)",
    "actualApplicationId": "(val)",
    "authorizer": "(val)",
    "routingVersion": "(val)",
    "actualNotificationFromAddress": "(val)",
    "documentTypeSecurityXml": "(val)",
    "customEmailStylesheet": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Document Types
PATCH/research-sys/api/v1/document-types/(key)

Example URI

PATCH /research-sys/api/v1/document-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "documentTypeId": "(val)",
  "docTypeParentId": "(val)",
  "name": "(val)",
  "version": "(val)",
  "active": "(val)",
  "currentInd": "(val)",
  "description": "(val)",
  "label": "(val)",
  "previousVersionId": "(val)",
  "documentId": "(val)",
  "unresolvedHelpDefinitionUrl": "(val)",
  "unresolvedDocSearchHelpUrl": "(val)",
  "unresolvedDocHandlerUrl": "(val)",
  "postProcessorName": "(val)",
  "workgroupId": "(val)",
  "blanketApproveWorkgroupId": "(val)",
  "blanketApprovePolicy": "(val)",
  "reportingWorkgroupId": "(val)",
  "actualApplicationId": "(val)",
  "authorizer": "(val)",
  "routingVersion": "(val)",
  "actualNotificationFromAddress": "(val)",
  "documentTypeSecurityXml": "(val)",
  "customEmailStylesheet": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "documentTypeId": "(val)",
  "docTypeParentId": "(val)",
  "name": "(val)",
  "version": "(val)",
  "active": "(val)",
  "currentInd": "(val)",
  "description": "(val)",
  "label": "(val)",
  "previousVersionId": "(val)",
  "documentId": "(val)",
  "unresolvedHelpDefinitionUrl": "(val)",
  "unresolvedDocSearchHelpUrl": "(val)",
  "unresolvedDocHandlerUrl": "(val)",
  "postProcessorName": "(val)",
  "workgroupId": "(val)",
  "blanketApproveWorkgroupId": "(val)",
  "blanketApprovePolicy": "(val)",
  "reportingWorkgroupId": "(val)",
  "actualApplicationId": "(val)",
  "authorizer": "(val)",
  "routingVersion": "(val)",
  "actualNotificationFromAddress": "(val)",
  "documentTypeSecurityXml": "(val)",
  "customEmailStylesheet": "(val)",
  "_primaryKey": "(val)"
}

Insert Document Types
POST/research-sys/api/v1/document-types/

Example URI

POST /research-sys/api/v1/document-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "documentTypeId": "(val)",
  "docTypeParentId": "(val)",
  "name": "(val)",
  "version": "(val)",
  "active": "(val)",
  "currentInd": "(val)",
  "description": "(val)",
  "label": "(val)",
  "previousVersionId": "(val)",
  "documentId": "(val)",
  "unresolvedHelpDefinitionUrl": "(val)",
  "unresolvedDocSearchHelpUrl": "(val)",
  "unresolvedDocHandlerUrl": "(val)",
  "postProcessorName": "(val)",
  "workgroupId": "(val)",
  "blanketApproveWorkgroupId": "(val)",
  "blanketApprovePolicy": "(val)",
  "reportingWorkgroupId": "(val)",
  "actualApplicationId": "(val)",
  "authorizer": "(val)",
  "routingVersion": "(val)",
  "actualNotificationFromAddress": "(val)",
  "documentTypeSecurityXml": "(val)",
  "customEmailStylesheet": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "documentTypeId": "(val)",
  "docTypeParentId": "(val)",
  "name": "(val)",
  "version": "(val)",
  "active": "(val)",
  "currentInd": "(val)",
  "description": "(val)",
  "label": "(val)",
  "previousVersionId": "(val)",
  "documentId": "(val)",
  "unresolvedHelpDefinitionUrl": "(val)",
  "unresolvedDocSearchHelpUrl": "(val)",
  "unresolvedDocHandlerUrl": "(val)",
  "postProcessorName": "(val)",
  "workgroupId": "(val)",
  "blanketApproveWorkgroupId": "(val)",
  "blanketApprovePolicy": "(val)",
  "reportingWorkgroupId": "(val)",
  "actualApplicationId": "(val)",
  "authorizer": "(val)",
  "routingVersion": "(val)",
  "actualNotificationFromAddress": "(val)",
  "documentTypeSecurityXml": "(val)",
  "customEmailStylesheet": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Document Types
POST/research-sys/api/v1/document-types/

Example URI

POST /research-sys/api/v1/document-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "documentTypeId": "(val)",
    "docTypeParentId": "(val)",
    "name": "(val)",
    "version": "(val)",
    "active": "(val)",
    "currentInd": "(val)",
    "description": "(val)",
    "label": "(val)",
    "previousVersionId": "(val)",
    "documentId": "(val)",
    "unresolvedHelpDefinitionUrl": "(val)",
    "unresolvedDocSearchHelpUrl": "(val)",
    "unresolvedDocHandlerUrl": "(val)",
    "postProcessorName": "(val)",
    "workgroupId": "(val)",
    "blanketApproveWorkgroupId": "(val)",
    "blanketApprovePolicy": "(val)",
    "reportingWorkgroupId": "(val)",
    "actualApplicationId": "(val)",
    "authorizer": "(val)",
    "routingVersion": "(val)",
    "actualNotificationFromAddress": "(val)",
    "documentTypeSecurityXml": "(val)",
    "customEmailStylesheet": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "documentTypeId": "(val)",
    "docTypeParentId": "(val)",
    "name": "(val)",
    "version": "(val)",
    "active": "(val)",
    "currentInd": "(val)",
    "description": "(val)",
    "label": "(val)",
    "previousVersionId": "(val)",
    "documentId": "(val)",
    "unresolvedHelpDefinitionUrl": "(val)",
    "unresolvedDocSearchHelpUrl": "(val)",
    "unresolvedDocHandlerUrl": "(val)",
    "postProcessorName": "(val)",
    "workgroupId": "(val)",
    "blanketApproveWorkgroupId": "(val)",
    "blanketApprovePolicy": "(val)",
    "reportingWorkgroupId": "(val)",
    "actualApplicationId": "(val)",
    "authorizer": "(val)",
    "routingVersion": "(val)",
    "actualNotificationFromAddress": "(val)",
    "documentTypeSecurityXml": "(val)",
    "customEmailStylesheet": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "documentTypeId": "(val)",
    "docTypeParentId": "(val)",
    "name": "(val)",
    "version": "(val)",
    "active": "(val)",
    "currentInd": "(val)",
    "description": "(val)",
    "label": "(val)",
    "previousVersionId": "(val)",
    "documentId": "(val)",
    "unresolvedHelpDefinitionUrl": "(val)",
    "unresolvedDocSearchHelpUrl": "(val)",
    "unresolvedDocHandlerUrl": "(val)",
    "postProcessorName": "(val)",
    "workgroupId": "(val)",
    "blanketApproveWorkgroupId": "(val)",
    "blanketApprovePolicy": "(val)",
    "reportingWorkgroupId": "(val)",
    "actualApplicationId": "(val)",
    "authorizer": "(val)",
    "routingVersion": "(val)",
    "actualNotificationFromAddress": "(val)",
    "documentTypeSecurityXml": "(val)",
    "customEmailStylesheet": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "documentTypeId": "(val)",
    "docTypeParentId": "(val)",
    "name": "(val)",
    "version": "(val)",
    "active": "(val)",
    "currentInd": "(val)",
    "description": "(val)",
    "label": "(val)",
    "previousVersionId": "(val)",
    "documentId": "(val)",
    "unresolvedHelpDefinitionUrl": "(val)",
    "unresolvedDocSearchHelpUrl": "(val)",
    "unresolvedDocHandlerUrl": "(val)",
    "postProcessorName": "(val)",
    "workgroupId": "(val)",
    "blanketApproveWorkgroupId": "(val)",
    "blanketApprovePolicy": "(val)",
    "reportingWorkgroupId": "(val)",
    "actualApplicationId": "(val)",
    "authorizer": "(val)",
    "routingVersion": "(val)",
    "actualNotificationFromAddress": "(val)",
    "documentTypeSecurityXml": "(val)",
    "customEmailStylesheet": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Document Types by Key
DELETE/research-sys/api/v1/document-types/(key)

Example URI

DELETE /research-sys/api/v1/document-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Document Types
DELETE/research-sys/api/v1/document-types/

Example URI

DELETE /research-sys/api/v1/document-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Document Types with Matching
DELETE/research-sys/api/v1/document-types/

Example URI

DELETE /research-sys/api/v1/document-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

documentTypeId
string (optional) 

Id. Maximum length is 19.

docTypeParentId
string (optional) 

Parent Id. Maximum length is 19.

name
string (optional) 

Name. Maximum length is 64.

version
string (optional) 

Version.

active
string (optional) 

Active Indicator. Maximum length is 1.

currentInd
string (optional) 

Current Ind.

description
string (optional) 

Description. Maximum length is 4000.

label
string (optional) 

Label. Maximum length is 128.

previousVersionId
string (optional) 

Previous Version Id.

documentId
string (optional) 

Document Id.

unresolvedHelpDefinitionUrl
string (optional) 

Help Definition URL. Maximum length is 255.

unresolvedDocSearchHelpUrl
string (optional) 

Document Search Help URL. Maximum length is 255.

unresolvedDocHandlerUrl
string (optional) 

Document Handler URL. Maximum length is 255.

postProcessorName
string (optional) 

Post Processor Name.

workgroupId
string (optional) 

Workgroup Id.

blanketApproveWorkgroupId
string (optional) 

Blanket Approve Workgroup Id.

blanketApprovePolicy
string (optional) 

Blanket Approve Policy.

reportingWorkgroupId
string (optional) 

Reporting Workgroup Id.

actualApplicationId
string (optional) 

Actual Application Id.

authorizer
string (optional) 

Authorizer.

routingVersion
string (optional) 

Routing Version.

actualNotificationFromAddress
string (optional) 

Notification From Address. Maximum length is 255.

documentTypeSecurityXml
string (optional) 

Document Type Security Xml.

customEmailStylesheet
string (optional) 

Custom Email Stylesheet.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Entities

Get Entities by Key
GET/research-sys/api/v1/entities/(key)

Example URI

GET /research-sys/api/v1/entities/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Get All Entities
GET/research-sys/api/v1/entities/

Example URI

GET /research-sys/api/v1/entities/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Entities with Filtering
GET/research-sys/api/v1/entities/

Example URI

GET /research-sys/api/v1/entities/
URI Parameters
HideShow
id
string (optional) 
active
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Entities
GET/research-sys/api/v1/entities/

Example URI

GET /research-sys/api/v1/entities/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "active"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Entities
GET/research-sys/api/v1/entities/

Example URI

GET /research-sys/api/v1/entities/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Entities.md"
transfer-encoding: chunked

Update Entities
PUT/research-sys/api/v1/entities/(key)

Example URI

PUT /research-sys/api/v1/entities/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Entities
PUT/research-sys/api/v1/entities/

Example URI

PUT /research-sys/api/v1/entities/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Entities
PATCH/research-sys/api/v1/entities/(key)

Example URI

PATCH /research-sys/api/v1/entities/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Entities
POST/research-sys/api/v1/entities/

Example URI

POST /research-sys/api/v1/entities/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Entities
POST/research-sys/api/v1/entities/

Example URI

POST /research-sys/api/v1/entities/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Entities by Key
DELETE/research-sys/api/v1/entities/(key)

Example URI

DELETE /research-sys/api/v1/entities/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Entities
DELETE/research-sys/api/v1/entities/

Example URI

DELETE /research-sys/api/v1/entities/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Entities with Matching
DELETE/research-sys/api/v1/entities/

Example URI

DELETE /research-sys/api/v1/entities/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 
active
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Entity Address Types

Get Entity Address Types by Key
GET/research-sys/api/v1/entity-address-types/(key)

Example URI

GET /research-sys/api/v1/entity-address-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}

Get All Entity Address Types
GET/research-sys/api/v1/entity-address-types/

Example URI

GET /research-sys/api/v1/entity-address-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Entity Address Types with Filtering
GET/research-sys/api/v1/entity-address-types/

Example URI

GET /research-sys/api/v1/entity-address-types/
URI Parameters
HideShow
name
string (optional) 

Descriptive text. Maximum length is 10.

active
string (optional) 

This attribute is used to describe whether the associated object is active or inactive. Maximum length is 1.

code
string (optional) 

The address type code. Maximum length is 2.

sortCode
string (optional) 

Descriptive text. Maximum length is 10.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Entity Address Types
GET/research-sys/api/v1/entity-address-types/

Example URI

GET /research-sys/api/v1/entity-address-types/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "name",
    "active",
    "code",
    "sortCode"
  ],
  "primaryKey": "code"
}

Get Blueprint API specification for Entity Address Types
GET/research-sys/api/v1/entity-address-types/

Example URI

GET /research-sys/api/v1/entity-address-types/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Entity Address Types.md"
transfer-encoding: chunked

Update Entity Address Types
PUT/research-sys/api/v1/entity-address-types/(key)

Example URI

PUT /research-sys/api/v1/entity-address-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Entity Address Types
PUT/research-sys/api/v1/entity-address-types/

Example URI

PUT /research-sys/api/v1/entity-address-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Entity Address Types
PATCH/research-sys/api/v1/entity-address-types/(key)

Example URI

PATCH /research-sys/api/v1/entity-address-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Entity Address Types
POST/research-sys/api/v1/entity-address-types/

Example URI

POST /research-sys/api/v1/entity-address-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Entity Address Types
POST/research-sys/api/v1/entity-address-types/

Example URI

POST /research-sys/api/v1/entity-address-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Entity Address Types by Key
DELETE/research-sys/api/v1/entity-address-types/(key)

Example URI

DELETE /research-sys/api/v1/entity-address-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Entity Address Types
DELETE/research-sys/api/v1/entity-address-types/

Example URI

DELETE /research-sys/api/v1/entity-address-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Entity Address Types with Matching
DELETE/research-sys/api/v1/entity-address-types/

Example URI

DELETE /research-sys/api/v1/entity-address-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

name
string (optional) 

Descriptive text. Maximum length is 10.

active
string (optional) 

This attribute is used to describe whether the associated object is active or inactive. Maximum length is 1.

code
string (optional) 

The address type code. Maximum length is 2.

sortCode
string (optional) 

Descriptive text. Maximum length is 10.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Entity Addresses

Get Entity Addresses by Key
GET/research-sys/api/v1/entity-addresses/(key)

Example URI

GET /research-sys/api/v1/entity-addresses/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "city": "(val)",
  "defaultValue": "(val)",
  "addressFormat": "(val)",
  "postalCode": "(val)",
  "active": "(val)",
  "entityId": "(val)",
  "attentionLine": "(val)",
  "noteMessage": "(val)",
  "stateProvinceCode": "(val)",
  "addressTypeCode": "(val)",
  "validated": "(val)",
  "countryCode": "(val)",
  "entityTypeCode": "(val)",
  "validatedDate": "(val)",
  "modifiedDate": "(val)",
  "line3": "(val)",
  "line2": "(val)",
  "line1": "(val)",
  "_primaryKey": "(val)"
}

Get All Entity Addresses
GET/research-sys/api/v1/entity-addresses/

Example URI

GET /research-sys/api/v1/entity-addresses/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "city": "(val)",
    "defaultValue": "(val)",
    "addressFormat": "(val)",
    "postalCode": "(val)",
    "active": "(val)",
    "entityId": "(val)",
    "attentionLine": "(val)",
    "noteMessage": "(val)",
    "stateProvinceCode": "(val)",
    "addressTypeCode": "(val)",
    "validated": "(val)",
    "countryCode": "(val)",
    "entityTypeCode": "(val)",
    "validatedDate": "(val)",
    "modifiedDate": "(val)",
    "line3": "(val)",
    "line2": "(val)",
    "line1": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "city": "(val)",
    "defaultValue": "(val)",
    "addressFormat": "(val)",
    "postalCode": "(val)",
    "active": "(val)",
    "entityId": "(val)",
    "attentionLine": "(val)",
    "noteMessage": "(val)",
    "stateProvinceCode": "(val)",
    "addressTypeCode": "(val)",
    "validated": "(val)",
    "countryCode": "(val)",
    "entityTypeCode": "(val)",
    "validatedDate": "(val)",
    "modifiedDate": "(val)",
    "line3": "(val)",
    "line2": "(val)",
    "line1": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Entity Addresses with Filtering
GET/research-sys/api/v1/entity-addresses/

Example URI

GET /research-sys/api/v1/entity-addresses/
URI Parameters
HideShow
id
string (optional) 
city
string (optional) 
defaultValue
string (optional) 
addressFormat
string (optional) 
postalCode
string (optional) 
active
string (optional) 
entityId
string (optional) 
attentionLine
string (optional) 
noteMessage
string (optional) 
stateProvinceCode
string (optional) 
addressTypeCode
string (optional) 
validated
string (optional) 
countryCode
string (optional) 
entityTypeCode
string (optional) 
validatedDate
string (optional) 
modifiedDate
string (optional) 
line3
string (optional) 
line2
string (optional) 
line1
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "city": "(val)",
    "defaultValue": "(val)",
    "addressFormat": "(val)",
    "postalCode": "(val)",
    "active": "(val)",
    "entityId": "(val)",
    "attentionLine": "(val)",
    "noteMessage": "(val)",
    "stateProvinceCode": "(val)",
    "addressTypeCode": "(val)",
    "validated": "(val)",
    "countryCode": "(val)",
    "entityTypeCode": "(val)",
    "validatedDate": "(val)",
    "modifiedDate": "(val)",
    "line3": "(val)",
    "line2": "(val)",
    "line1": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "city": "(val)",
    "defaultValue": "(val)",
    "addressFormat": "(val)",
    "postalCode": "(val)",
    "active": "(val)",
    "entityId": "(val)",
    "attentionLine": "(val)",
    "noteMessage": "(val)",
    "stateProvinceCode": "(val)",
    "addressTypeCode": "(val)",
    "validated": "(val)",
    "countryCode": "(val)",
    "entityTypeCode": "(val)",
    "validatedDate": "(val)",
    "modifiedDate": "(val)",
    "line3": "(val)",
    "line2": "(val)",
    "line1": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Entity Addresses
GET/research-sys/api/v1/entity-addresses/

Example URI

GET /research-sys/api/v1/entity-addresses/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "city",
    "defaultValue",
    "addressFormat",
    "postalCode",
    "active",
    "entityId",
    "attentionLine",
    "noteMessage",
    "stateProvinceCode",
    "addressTypeCode",
    "validated",
    "countryCode",
    "entityTypeCode",
    "validatedDate",
    "modifiedDate",
    "line3",
    "line2",
    "line1"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Entity Addresses
GET/research-sys/api/v1/entity-addresses/

Example URI

GET /research-sys/api/v1/entity-addresses/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Entity Addresses.md"
transfer-encoding: chunked

Update Entity Addresses
PUT/research-sys/api/v1/entity-addresses/(key)

Example URI

PUT /research-sys/api/v1/entity-addresses/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "city": "(val)",
  "defaultValue": "(val)",
  "addressFormat": "(val)",
  "postalCode": "(val)",
  "active": "(val)",
  "entityId": "(val)",
  "attentionLine": "(val)",
  "noteMessage": "(val)",
  "stateProvinceCode": "(val)",
  "addressTypeCode": "(val)",
  "validated": "(val)",
  "countryCode": "(val)",
  "entityTypeCode": "(val)",
  "validatedDate": "(val)",
  "modifiedDate": "(val)",
  "line3": "(val)",
  "line2": "(val)",
  "line1": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Entity Addresses
PUT/research-sys/api/v1/entity-addresses/

Example URI

PUT /research-sys/api/v1/entity-addresses/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "city": "(val)",
    "defaultValue": "(val)",
    "addressFormat": "(val)",
    "postalCode": "(val)",
    "active": "(val)",
    "entityId": "(val)",
    "attentionLine": "(val)",
    "noteMessage": "(val)",
    "stateProvinceCode": "(val)",
    "addressTypeCode": "(val)",
    "validated": "(val)",
    "countryCode": "(val)",
    "entityTypeCode": "(val)",
    "validatedDate": "(val)",
    "modifiedDate": "(val)",
    "line3": "(val)",
    "line2": "(val)",
    "line1": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "city": "(val)",
    "defaultValue": "(val)",
    "addressFormat": "(val)",
    "postalCode": "(val)",
    "active": "(val)",
    "entityId": "(val)",
    "attentionLine": "(val)",
    "noteMessage": "(val)",
    "stateProvinceCode": "(val)",
    "addressTypeCode": "(val)",
    "validated": "(val)",
    "countryCode": "(val)",
    "entityTypeCode": "(val)",
    "validatedDate": "(val)",
    "modifiedDate": "(val)",
    "line3": "(val)",
    "line2": "(val)",
    "line1": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Entity Addresses
PATCH/research-sys/api/v1/entity-addresses/(key)

Example URI

PATCH /research-sys/api/v1/entity-addresses/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "city": "(val)",
  "defaultValue": "(val)",
  "addressFormat": "(val)",
  "postalCode": "(val)",
  "active": "(val)",
  "entityId": "(val)",
  "attentionLine": "(val)",
  "noteMessage": "(val)",
  "stateProvinceCode": "(val)",
  "addressTypeCode": "(val)",
  "validated": "(val)",
  "countryCode": "(val)",
  "entityTypeCode": "(val)",
  "validatedDate": "(val)",
  "modifiedDate": "(val)",
  "line3": "(val)",
  "line2": "(val)",
  "line1": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "city": "(val)",
  "defaultValue": "(val)",
  "addressFormat": "(val)",
  "postalCode": "(val)",
  "active": "(val)",
  "entityId": "(val)",
  "attentionLine": "(val)",
  "noteMessage": "(val)",
  "stateProvinceCode": "(val)",
  "addressTypeCode": "(val)",
  "validated": "(val)",
  "countryCode": "(val)",
  "entityTypeCode": "(val)",
  "validatedDate": "(val)",
  "modifiedDate": "(val)",
  "line3": "(val)",
  "line2": "(val)",
  "line1": "(val)",
  "_primaryKey": "(val)"
}

Insert Entity Addresses
POST/research-sys/api/v1/entity-addresses/

Example URI

POST /research-sys/api/v1/entity-addresses/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "city": "(val)",
  "defaultValue": "(val)",
  "addressFormat": "(val)",
  "postalCode": "(val)",
  "active": "(val)",
  "entityId": "(val)",
  "attentionLine": "(val)",
  "noteMessage": "(val)",
  "stateProvinceCode": "(val)",
  "addressTypeCode": "(val)",
  "validated": "(val)",
  "countryCode": "(val)",
  "entityTypeCode": "(val)",
  "validatedDate": "(val)",
  "modifiedDate": "(val)",
  "line3": "(val)",
  "line2": "(val)",
  "line1": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "city": "(val)",
  "defaultValue": "(val)",
  "addressFormat": "(val)",
  "postalCode": "(val)",
  "active": "(val)",
  "entityId": "(val)",
  "attentionLine": "(val)",
  "noteMessage": "(val)",
  "stateProvinceCode": "(val)",
  "addressTypeCode": "(val)",
  "validated": "(val)",
  "countryCode": "(val)",
  "entityTypeCode": "(val)",
  "validatedDate": "(val)",
  "modifiedDate": "(val)",
  "line3": "(val)",
  "line2": "(val)",
  "line1": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Entity Addresses
POST/research-sys/api/v1/entity-addresses/

Example URI

POST /research-sys/api/v1/entity-addresses/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "city": "(val)",
    "defaultValue": "(val)",
    "addressFormat": "(val)",
    "postalCode": "(val)",
    "active": "(val)",
    "entityId": "(val)",
    "attentionLine": "(val)",
    "noteMessage": "(val)",
    "stateProvinceCode": "(val)",
    "addressTypeCode": "(val)",
    "validated": "(val)",
    "countryCode": "(val)",
    "entityTypeCode": "(val)",
    "validatedDate": "(val)",
    "modifiedDate": "(val)",
    "line3": "(val)",
    "line2": "(val)",
    "line1": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "city": "(val)",
    "defaultValue": "(val)",
    "addressFormat": "(val)",
    "postalCode": "(val)",
    "active": "(val)",
    "entityId": "(val)",
    "attentionLine": "(val)",
    "noteMessage": "(val)",
    "stateProvinceCode": "(val)",
    "addressTypeCode": "(val)",
    "validated": "(val)",
    "countryCode": "(val)",
    "entityTypeCode": "(val)",
    "validatedDate": "(val)",
    "modifiedDate": "(val)",
    "line3": "(val)",
    "line2": "(val)",
    "line1": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "city": "(val)",
    "defaultValue": "(val)",
    "addressFormat": "(val)",
    "postalCode": "(val)",
    "active": "(val)",
    "entityId": "(val)",
    "attentionLine": "(val)",
    "noteMessage": "(val)",
    "stateProvinceCode": "(val)",
    "addressTypeCode": "(val)",
    "validated": "(val)",
    "countryCode": "(val)",
    "entityTypeCode": "(val)",
    "validatedDate": "(val)",
    "modifiedDate": "(val)",
    "line3": "(val)",
    "line2": "(val)",
    "line1": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "city": "(val)",
    "defaultValue": "(val)",
    "addressFormat": "(val)",
    "postalCode": "(val)",
    "active": "(val)",
    "entityId": "(val)",
    "attentionLine": "(val)",
    "noteMessage": "(val)",
    "stateProvinceCode": "(val)",
    "addressTypeCode": "(val)",
    "validated": "(val)",
    "countryCode": "(val)",
    "entityTypeCode": "(val)",
    "validatedDate": "(val)",
    "modifiedDate": "(val)",
    "line3": "(val)",
    "line2": "(val)",
    "line1": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Entity Addresses by Key
DELETE/research-sys/api/v1/entity-addresses/(key)

Example URI

DELETE /research-sys/api/v1/entity-addresses/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Entity Addresses
DELETE/research-sys/api/v1/entity-addresses/

Example URI

DELETE /research-sys/api/v1/entity-addresses/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Entity Addresses with Matching
DELETE/research-sys/api/v1/entity-addresses/

Example URI

DELETE /research-sys/api/v1/entity-addresses/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 
city
string (optional) 
defaultValue
string (optional) 
addressFormat
string (optional) 
postalCode
string (optional) 
active
string (optional) 
entityId
string (optional) 
attentionLine
string (optional) 
noteMessage
string (optional) 
stateProvinceCode
string (optional) 
addressTypeCode
string (optional) 
validated
string (optional) 
countryCode
string (optional) 
entityTypeCode
string (optional) 
validatedDate
string (optional) 
modifiedDate
string (optional) 
line3
string (optional) 
line2
string (optional) 
line1
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Entity Affiliation Types

Get Entity Affiliation Types by Key
GET/research-sys/api/v1/entity-affiliation-types/(key)

Example URI

GET /research-sys/api/v1/entity-affiliation-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "employmentAffiliationType": "(val)",
  "code": "(val)",
  "name": "(val)",
  "active": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}

Get All Entity Affiliation Types
GET/research-sys/api/v1/entity-affiliation-types/

Example URI

GET /research-sys/api/v1/entity-affiliation-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "employmentAffiliationType": "(val)",
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "employmentAffiliationType": "(val)",
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Entity Affiliation Types with Filtering
GET/research-sys/api/v1/entity-affiliation-types/

Example URI

GET /research-sys/api/v1/entity-affiliation-types/
URI Parameters
HideShow
employmentAffiliationType
string (optional) 

Employment Affiliation Type.

code
string (optional) 

The affiliation type code. Maximum length is 7.

name
string (optional) 

Descriptive text. Maximum length is 50.

active
string (optional) 

This attribute is used to describe whether the associated object is active or inactive. Maximum length is 1.

sortCode
string (optional) 

Descriptive text. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "employmentAffiliationType": "(val)",
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "employmentAffiliationType": "(val)",
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Entity Affiliation Types
GET/research-sys/api/v1/entity-affiliation-types/

Example URI

GET /research-sys/api/v1/entity-affiliation-types/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "employmentAffiliationType",
    "code",
    "name",
    "active",
    "sortCode"
  ],
  "primaryKey": "code"
}

Get Blueprint API specification for Entity Affiliation Types
GET/research-sys/api/v1/entity-affiliation-types/

Example URI

GET /research-sys/api/v1/entity-affiliation-types/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Entity Affiliation Types.md"
transfer-encoding: chunked

Update Entity Affiliation Types
PUT/research-sys/api/v1/entity-affiliation-types/(key)

Example URI

PUT /research-sys/api/v1/entity-affiliation-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "employmentAffiliationType": "(val)",
  "code": "(val)",
  "name": "(val)",
  "active": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Entity Affiliation Types
PUT/research-sys/api/v1/entity-affiliation-types/

Example URI

PUT /research-sys/api/v1/entity-affiliation-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "employmentAffiliationType": "(val)",
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "employmentAffiliationType": "(val)",
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Entity Affiliation Types
PATCH/research-sys/api/v1/entity-affiliation-types/(key)

Example URI

PATCH /research-sys/api/v1/entity-affiliation-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "employmentAffiliationType": "(val)",
  "code": "(val)",
  "name": "(val)",
  "active": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "employmentAffiliationType": "(val)",
  "code": "(val)",
  "name": "(val)",
  "active": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Entity Affiliation Types
POST/research-sys/api/v1/entity-affiliation-types/

Example URI

POST /research-sys/api/v1/entity-affiliation-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "employmentAffiliationType": "(val)",
  "code": "(val)",
  "name": "(val)",
  "active": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "employmentAffiliationType": "(val)",
  "code": "(val)",
  "name": "(val)",
  "active": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Entity Affiliation Types
POST/research-sys/api/v1/entity-affiliation-types/

Example URI

POST /research-sys/api/v1/entity-affiliation-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "employmentAffiliationType": "(val)",
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "employmentAffiliationType": "(val)",
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "employmentAffiliationType": "(val)",
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "employmentAffiliationType": "(val)",
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Entity Affiliation Types by Key
DELETE/research-sys/api/v1/entity-affiliation-types/(key)

Example URI

DELETE /research-sys/api/v1/entity-affiliation-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Entity Affiliation Types
DELETE/research-sys/api/v1/entity-affiliation-types/

Example URI

DELETE /research-sys/api/v1/entity-affiliation-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Entity Affiliation Types with Matching
DELETE/research-sys/api/v1/entity-affiliation-types/

Example URI

DELETE /research-sys/api/v1/entity-affiliation-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

employmentAffiliationType
string (optional) 

Employment Affiliation Type.

code
string (optional) 

The affiliation type code. Maximum length is 7.

name
string (optional) 

Descriptive text. Maximum length is 50.

active
string (optional) 

This attribute is used to describe whether the associated object is active or inactive. Maximum length is 1.

sortCode
string (optional) 

Descriptive text. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Entity Affiliations

Get Entity Affiliations by Key
GET/research-sys/api/v1/entity-affiliations/(key)

Example URI

GET /research-sys/api/v1/entity-affiliations/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "campusCode": "(val)",
  "defaultValue": "(val)",
  "active": "(val)",
  "affiliationTypeCode": "(val)",
  "entityId": "(val)",
  "_primaryKey": "(val)"
}

Get All Entity Affiliations
GET/research-sys/api/v1/entity-affiliations/

Example URI

GET /research-sys/api/v1/entity-affiliations/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "campusCode": "(val)",
    "defaultValue": "(val)",
    "active": "(val)",
    "affiliationTypeCode": "(val)",
    "entityId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "campusCode": "(val)",
    "defaultValue": "(val)",
    "active": "(val)",
    "affiliationTypeCode": "(val)",
    "entityId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Entity Affiliations with Filtering
GET/research-sys/api/v1/entity-affiliations/

Example URI

GET /research-sys/api/v1/entity-affiliations/
URI Parameters
HideShow
id
string (optional) 
campusCode
string (optional) 
defaultValue
string (optional) 
active
string (optional) 
affiliationTypeCode
string (optional) 
entityId
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "campusCode": "(val)",
    "defaultValue": "(val)",
    "active": "(val)",
    "affiliationTypeCode": "(val)",
    "entityId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "campusCode": "(val)",
    "defaultValue": "(val)",
    "active": "(val)",
    "affiliationTypeCode": "(val)",
    "entityId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Entity Affiliations
GET/research-sys/api/v1/entity-affiliations/

Example URI

GET /research-sys/api/v1/entity-affiliations/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "campusCode",
    "defaultValue",
    "active",
    "affiliationTypeCode",
    "entityId"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Entity Affiliations
GET/research-sys/api/v1/entity-affiliations/

Example URI

GET /research-sys/api/v1/entity-affiliations/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Entity Affiliations.md"
transfer-encoding: chunked

Update Entity Affiliations
PUT/research-sys/api/v1/entity-affiliations/(key)

Example URI

PUT /research-sys/api/v1/entity-affiliations/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "campusCode": "(val)",
  "defaultValue": "(val)",
  "active": "(val)",
  "affiliationTypeCode": "(val)",
  "entityId": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Entity Affiliations
PUT/research-sys/api/v1/entity-affiliations/

Example URI

PUT /research-sys/api/v1/entity-affiliations/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "campusCode": "(val)",
    "defaultValue": "(val)",
    "active": "(val)",
    "affiliationTypeCode": "(val)",
    "entityId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "campusCode": "(val)",
    "defaultValue": "(val)",
    "active": "(val)",
    "affiliationTypeCode": "(val)",
    "entityId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Entity Affiliations
PATCH/research-sys/api/v1/entity-affiliations/(key)

Example URI

PATCH /research-sys/api/v1/entity-affiliations/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "campusCode": "(val)",
  "defaultValue": "(val)",
  "active": "(val)",
  "affiliationTypeCode": "(val)",
  "entityId": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "campusCode": "(val)",
  "defaultValue": "(val)",
  "active": "(val)",
  "affiliationTypeCode": "(val)",
  "entityId": "(val)",
  "_primaryKey": "(val)"
}

Insert Entity Affiliations
POST/research-sys/api/v1/entity-affiliations/

Example URI

POST /research-sys/api/v1/entity-affiliations/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "campusCode": "(val)",
  "defaultValue": "(val)",
  "active": "(val)",
  "affiliationTypeCode": "(val)",
  "entityId": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "campusCode": "(val)",
  "defaultValue": "(val)",
  "active": "(val)",
  "affiliationTypeCode": "(val)",
  "entityId": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Entity Affiliations
POST/research-sys/api/v1/entity-affiliations/

Example URI

POST /research-sys/api/v1/entity-affiliations/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "campusCode": "(val)",
    "defaultValue": "(val)",
    "active": "(val)",
    "affiliationTypeCode": "(val)",
    "entityId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "campusCode": "(val)",
    "defaultValue": "(val)",
    "active": "(val)",
    "affiliationTypeCode": "(val)",
    "entityId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "campusCode": "(val)",
    "defaultValue": "(val)",
    "active": "(val)",
    "affiliationTypeCode": "(val)",
    "entityId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "campusCode": "(val)",
    "defaultValue": "(val)",
    "active": "(val)",
    "affiliationTypeCode": "(val)",
    "entityId": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Entity Affiliations by Key
DELETE/research-sys/api/v1/entity-affiliations/(key)

Example URI

DELETE /research-sys/api/v1/entity-affiliations/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Entity Affiliations
DELETE/research-sys/api/v1/entity-affiliations/

Example URI

DELETE /research-sys/api/v1/entity-affiliations/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Entity Affiliations with Matching
DELETE/research-sys/api/v1/entity-affiliations/

Example URI

DELETE /research-sys/api/v1/entity-affiliations/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 
campusCode
string (optional) 
defaultValue
string (optional) 
active
string (optional) 
affiliationTypeCode
string (optional) 
entityId
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Entity Bio Demographics

Get Entity Bio Demographics by Key
GET/research-sys/api/v1/entity-bio-demographics/(key)

Example URI

GET /research-sys/api/v1/entity-bio-demographics/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "entityId": "(val)",
  "birthDateValue": "(val)",
  "genderCode": "(val)",
  "genderChangeCode": "(val)",
  "deceasedDateValue": "(val)",
  "maritalStatusCode": "(val)",
  "primaryLanguageCode": "(val)",
  "secondaryLanguageCode": "(val)",
  "birthCountry": "(val)",
  "birthStateProvinceCode": "(val)",
  "birthCity": "(val)",
  "geographicOrigin": "(val)",
  "noteMessage": "(val)",
  "_primaryKey": "(val)"
}

Get All Entity Bio Demographics
GET/research-sys/api/v1/entity-bio-demographics/

Example URI

GET /research-sys/api/v1/entity-bio-demographics/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "entityId": "(val)",
    "birthDateValue": "(val)",
    "genderCode": "(val)",
    "genderChangeCode": "(val)",
    "deceasedDateValue": "(val)",
    "maritalStatusCode": "(val)",
    "primaryLanguageCode": "(val)",
    "secondaryLanguageCode": "(val)",
    "birthCountry": "(val)",
    "birthStateProvinceCode": "(val)",
    "birthCity": "(val)",
    "geographicOrigin": "(val)",
    "noteMessage": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "entityId": "(val)",
    "birthDateValue": "(val)",
    "genderCode": "(val)",
    "genderChangeCode": "(val)",
    "deceasedDateValue": "(val)",
    "maritalStatusCode": "(val)",
    "primaryLanguageCode": "(val)",
    "secondaryLanguageCode": "(val)",
    "birthCountry": "(val)",
    "birthStateProvinceCode": "(val)",
    "birthCity": "(val)",
    "geographicOrigin": "(val)",
    "noteMessage": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Entity Bio Demographics with Filtering
GET/research-sys/api/v1/entity-bio-demographics/

Example URI

GET /research-sys/api/v1/entity-bio-demographics/
URI Parameters
HideShow
entityId
string (optional) 
birthDateValue
string (optional) 
genderCode
string (optional) 
genderChangeCode
string (optional) 
deceasedDateValue
string (optional) 
maritalStatusCode
string (optional) 
primaryLanguageCode
string (optional) 
secondaryLanguageCode
string (optional) 
birthCountry
string (optional) 
birthStateProvinceCode
string (optional) 
birthCity
string (optional) 
geographicOrigin
string (optional) 
noteMessage
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "entityId": "(val)",
    "birthDateValue": "(val)",
    "genderCode": "(val)",
    "genderChangeCode": "(val)",
    "deceasedDateValue": "(val)",
    "maritalStatusCode": "(val)",
    "primaryLanguageCode": "(val)",
    "secondaryLanguageCode": "(val)",
    "birthCountry": "(val)",
    "birthStateProvinceCode": "(val)",
    "birthCity": "(val)",
    "geographicOrigin": "(val)",
    "noteMessage": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "entityId": "(val)",
    "birthDateValue": "(val)",
    "genderCode": "(val)",
    "genderChangeCode": "(val)",
    "deceasedDateValue": "(val)",
    "maritalStatusCode": "(val)",
    "primaryLanguageCode": "(val)",
    "secondaryLanguageCode": "(val)",
    "birthCountry": "(val)",
    "birthStateProvinceCode": "(val)",
    "birthCity": "(val)",
    "geographicOrigin": "(val)",
    "noteMessage": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Entity Bio Demographics
GET/research-sys/api/v1/entity-bio-demographics/

Example URI

GET /research-sys/api/v1/entity-bio-demographics/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "entityId",
    "birthDateValue",
    "genderCode",
    "genderChangeCode",
    "deceasedDateValue",
    "maritalStatusCode",
    "primaryLanguageCode",
    "secondaryLanguageCode",
    "birthCountry",
    "birthStateProvinceCode",
    "birthCity",
    "geographicOrigin",
    "noteMessage"
  ],
  "primaryKey": "entityId"
}

Get Blueprint API specification for Entity Bio Demographics
GET/research-sys/api/v1/entity-bio-demographics/

Example URI

GET /research-sys/api/v1/entity-bio-demographics/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Entity Bio Demographics.md"
transfer-encoding: chunked

Update Entity Bio Demographics
PUT/research-sys/api/v1/entity-bio-demographics/(key)

Example URI

PUT /research-sys/api/v1/entity-bio-demographics/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "entityId": "(val)",
  "birthDateValue": "(val)",
  "genderCode": "(val)",
  "genderChangeCode": "(val)",
  "deceasedDateValue": "(val)",
  "maritalStatusCode": "(val)",
  "primaryLanguageCode": "(val)",
  "secondaryLanguageCode": "(val)",
  "birthCountry": "(val)",
  "birthStateProvinceCode": "(val)",
  "birthCity": "(val)",
  "geographicOrigin": "(val)",
  "noteMessage": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Entity Bio Demographics
PUT/research-sys/api/v1/entity-bio-demographics/

Example URI

PUT /research-sys/api/v1/entity-bio-demographics/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "entityId": "(val)",
    "birthDateValue": "(val)",
    "genderCode": "(val)",
    "genderChangeCode": "(val)",
    "deceasedDateValue": "(val)",
    "maritalStatusCode": "(val)",
    "primaryLanguageCode": "(val)",
    "secondaryLanguageCode": "(val)",
    "birthCountry": "(val)",
    "birthStateProvinceCode": "(val)",
    "birthCity": "(val)",
    "geographicOrigin": "(val)",
    "noteMessage": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "entityId": "(val)",
    "birthDateValue": "(val)",
    "genderCode": "(val)",
    "genderChangeCode": "(val)",
    "deceasedDateValue": "(val)",
    "maritalStatusCode": "(val)",
    "primaryLanguageCode": "(val)",
    "secondaryLanguageCode": "(val)",
    "birthCountry": "(val)",
    "birthStateProvinceCode": "(val)",
    "birthCity": "(val)",
    "geographicOrigin": "(val)",
    "noteMessage": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Entity Bio Demographics
PATCH/research-sys/api/v1/entity-bio-demographics/(key)

Example URI

PATCH /research-sys/api/v1/entity-bio-demographics/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "entityId": "(val)",
  "birthDateValue": "(val)",
  "genderCode": "(val)",
  "genderChangeCode": "(val)",
  "deceasedDateValue": "(val)",
  "maritalStatusCode": "(val)",
  "primaryLanguageCode": "(val)",
  "secondaryLanguageCode": "(val)",
  "birthCountry": "(val)",
  "birthStateProvinceCode": "(val)",
  "birthCity": "(val)",
  "geographicOrigin": "(val)",
  "noteMessage": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "entityId": "(val)",
  "birthDateValue": "(val)",
  "genderCode": "(val)",
  "genderChangeCode": "(val)",
  "deceasedDateValue": "(val)",
  "maritalStatusCode": "(val)",
  "primaryLanguageCode": "(val)",
  "secondaryLanguageCode": "(val)",
  "birthCountry": "(val)",
  "birthStateProvinceCode": "(val)",
  "birthCity": "(val)",
  "geographicOrigin": "(val)",
  "noteMessage": "(val)",
  "_primaryKey": "(val)"
}

Insert Entity Bio Demographics
POST/research-sys/api/v1/entity-bio-demographics/

Example URI

POST /research-sys/api/v1/entity-bio-demographics/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "entityId": "(val)",
  "birthDateValue": "(val)",
  "genderCode": "(val)",
  "genderChangeCode": "(val)",
  "deceasedDateValue": "(val)",
  "maritalStatusCode": "(val)",
  "primaryLanguageCode": "(val)",
  "secondaryLanguageCode": "(val)",
  "birthCountry": "(val)",
  "birthStateProvinceCode": "(val)",
  "birthCity": "(val)",
  "geographicOrigin": "(val)",
  "noteMessage": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "entityId": "(val)",
  "birthDateValue": "(val)",
  "genderCode": "(val)",
  "genderChangeCode": "(val)",
  "deceasedDateValue": "(val)",
  "maritalStatusCode": "(val)",
  "primaryLanguageCode": "(val)",
  "secondaryLanguageCode": "(val)",
  "birthCountry": "(val)",
  "birthStateProvinceCode": "(val)",
  "birthCity": "(val)",
  "geographicOrigin": "(val)",
  "noteMessage": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Entity Bio Demographics
POST/research-sys/api/v1/entity-bio-demographics/

Example URI

POST /research-sys/api/v1/entity-bio-demographics/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "entityId": "(val)",
    "birthDateValue": "(val)",
    "genderCode": "(val)",
    "genderChangeCode": "(val)",
    "deceasedDateValue": "(val)",
    "maritalStatusCode": "(val)",
    "primaryLanguageCode": "(val)",
    "secondaryLanguageCode": "(val)",
    "birthCountry": "(val)",
    "birthStateProvinceCode": "(val)",
    "birthCity": "(val)",
    "geographicOrigin": "(val)",
    "noteMessage": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "entityId": "(val)",
    "birthDateValue": "(val)",
    "genderCode": "(val)",
    "genderChangeCode": "(val)",
    "deceasedDateValue": "(val)",
    "maritalStatusCode": "(val)",
    "primaryLanguageCode": "(val)",
    "secondaryLanguageCode": "(val)",
    "birthCountry": "(val)",
    "birthStateProvinceCode": "(val)",
    "birthCity": "(val)",
    "geographicOrigin": "(val)",
    "noteMessage": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "entityId": "(val)",
    "birthDateValue": "(val)",
    "genderCode": "(val)",
    "genderChangeCode": "(val)",
    "deceasedDateValue": "(val)",
    "maritalStatusCode": "(val)",
    "primaryLanguageCode": "(val)",
    "secondaryLanguageCode": "(val)",
    "birthCountry": "(val)",
    "birthStateProvinceCode": "(val)",
    "birthCity": "(val)",
    "geographicOrigin": "(val)",
    "noteMessage": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "entityId": "(val)",
    "birthDateValue": "(val)",
    "genderCode": "(val)",
    "genderChangeCode": "(val)",
    "deceasedDateValue": "(val)",
    "maritalStatusCode": "(val)",
    "primaryLanguageCode": "(val)",
    "secondaryLanguageCode": "(val)",
    "birthCountry": "(val)",
    "birthStateProvinceCode": "(val)",
    "birthCity": "(val)",
    "geographicOrigin": "(val)",
    "noteMessage": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Entity Bio Demographics by Key
DELETE/research-sys/api/v1/entity-bio-demographics/(key)

Example URI

DELETE /research-sys/api/v1/entity-bio-demographics/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Entity Bio Demographics
DELETE/research-sys/api/v1/entity-bio-demographics/

Example URI

DELETE /research-sys/api/v1/entity-bio-demographics/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Entity Bio Demographics with Matching
DELETE/research-sys/api/v1/entity-bio-demographics/

Example URI

DELETE /research-sys/api/v1/entity-bio-demographics/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

entityId
string (optional) 
birthDateValue
string (optional) 
genderCode
string (optional) 
genderChangeCode
string (optional) 
deceasedDateValue
string (optional) 
maritalStatusCode
string (optional) 
primaryLanguageCode
string (optional) 
secondaryLanguageCode
string (optional) 
birthCountry
string (optional) 
birthStateProvinceCode
string (optional) 
birthCity
string (optional) 
geographicOrigin
string (optional) 
noteMessage
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Entity Citizenship Change Types

Get Entity Citizenship Change Types by Key
GET/research-sys/api/v1/entity-citizenship-change-types/(key)

Example URI

GET /research-sys/api/v1/entity-citizenship-change-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}

Get All Entity Citizenship Change Types
GET/research-sys/api/v1/entity-citizenship-change-types/

Example URI

GET /research-sys/api/v1/entity-citizenship-change-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Entity Citizenship Change Types with Filtering
GET/research-sys/api/v1/entity-citizenship-change-types/

Example URI

GET /research-sys/api/v1/entity-citizenship-change-types/
URI Parameters
HideShow
name
string (optional) 
active
string (optional) 
code
string (optional) 
sortCode
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Entity Citizenship Change Types
GET/research-sys/api/v1/entity-citizenship-change-types/

Example URI

GET /research-sys/api/v1/entity-citizenship-change-types/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "name",
    "active",
    "code",
    "sortCode"
  ],
  "primaryKey": "code"
}

Get Blueprint API specification for Entity Citizenship Change Types
GET/research-sys/api/v1/entity-citizenship-change-types/

Example URI

GET /research-sys/api/v1/entity-citizenship-change-types/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Entity Citizenship Change Types.md"
transfer-encoding: chunked

Update Entity Citizenship Change Types
PUT/research-sys/api/v1/entity-citizenship-change-types/(key)

Example URI

PUT /research-sys/api/v1/entity-citizenship-change-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Entity Citizenship Change Types
PUT/research-sys/api/v1/entity-citizenship-change-types/

Example URI

PUT /research-sys/api/v1/entity-citizenship-change-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Entity Citizenship Change Types
PATCH/research-sys/api/v1/entity-citizenship-change-types/(key)

Example URI

PATCH /research-sys/api/v1/entity-citizenship-change-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Entity Citizenship Change Types
POST/research-sys/api/v1/entity-citizenship-change-types/

Example URI

POST /research-sys/api/v1/entity-citizenship-change-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Entity Citizenship Change Types
POST/research-sys/api/v1/entity-citizenship-change-types/

Example URI

POST /research-sys/api/v1/entity-citizenship-change-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Entity Citizenship Change Types by Key
DELETE/research-sys/api/v1/entity-citizenship-change-types/(key)

Example URI

DELETE /research-sys/api/v1/entity-citizenship-change-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Entity Citizenship Change Types
DELETE/research-sys/api/v1/entity-citizenship-change-types/

Example URI

DELETE /research-sys/api/v1/entity-citizenship-change-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Entity Citizenship Change Types with Matching
DELETE/research-sys/api/v1/entity-citizenship-change-types/

Example URI

DELETE /research-sys/api/v1/entity-citizenship-change-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

name
string (optional) 
active
string (optional) 
code
string (optional) 
sortCode
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Entity Citizenship Statuses

Get Entity Citizenship Statuses by Key
GET/research-sys/api/v1/entity-citizenship-statuses/(key)

Example URI

GET /research-sys/api/v1/entity-citizenship-statuses/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}

Get All Entity Citizenship Statuses
GET/research-sys/api/v1/entity-citizenship-statuses/

Example URI

GET /research-sys/api/v1/entity-citizenship-statuses/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Entity Citizenship Statuses with Filtering
GET/research-sys/api/v1/entity-citizenship-statuses/

Example URI

GET /research-sys/api/v1/entity-citizenship-statuses/
URI Parameters
HideShow
name
string (optional) 

Descriptive text. Maximum length is 50.

active
string (optional) 

This attribute is used to describe whether the associated object is active or inactive. Maximum length is 1.

code
string (optional) 

The citizenship status code. Maximum length is 7.

sortCode
string (optional) 

Descriptive text. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Entity Citizenship Statuses
GET/research-sys/api/v1/entity-citizenship-statuses/

Example URI

GET /research-sys/api/v1/entity-citizenship-statuses/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "name",
    "active",
    "code",
    "sortCode"
  ],
  "primaryKey": "code"
}

Get Blueprint API specification for Entity Citizenship Statuses
GET/research-sys/api/v1/entity-citizenship-statuses/

Example URI

GET /research-sys/api/v1/entity-citizenship-statuses/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Entity Citizenship Statuses.md"
transfer-encoding: chunked

Update Entity Citizenship Statuses
PUT/research-sys/api/v1/entity-citizenship-statuses/(key)

Example URI

PUT /research-sys/api/v1/entity-citizenship-statuses/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Entity Citizenship Statuses
PUT/research-sys/api/v1/entity-citizenship-statuses/

Example URI

PUT /research-sys/api/v1/entity-citizenship-statuses/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Entity Citizenship Statuses
PATCH/research-sys/api/v1/entity-citizenship-statuses/(key)

Example URI

PATCH /research-sys/api/v1/entity-citizenship-statuses/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Entity Citizenship Statuses
POST/research-sys/api/v1/entity-citizenship-statuses/

Example URI

POST /research-sys/api/v1/entity-citizenship-statuses/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Entity Citizenship Statuses
POST/research-sys/api/v1/entity-citizenship-statuses/

Example URI

POST /research-sys/api/v1/entity-citizenship-statuses/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Entity Citizenship Statuses by Key
DELETE/research-sys/api/v1/entity-citizenship-statuses/(key)

Example URI

DELETE /research-sys/api/v1/entity-citizenship-statuses/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Entity Citizenship Statuses
DELETE/research-sys/api/v1/entity-citizenship-statuses/

Example URI

DELETE /research-sys/api/v1/entity-citizenship-statuses/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Entity Citizenship Statuses with Matching
DELETE/research-sys/api/v1/entity-citizenship-statuses/

Example URI

DELETE /research-sys/api/v1/entity-citizenship-statuses/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

name
string (optional) 

Descriptive text. Maximum length is 50.

active
string (optional) 

This attribute is used to describe whether the associated object is active or inactive. Maximum length is 1.

code
string (optional) 

The citizenship status code. Maximum length is 7.

sortCode
string (optional) 

Descriptive text. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Entity Citizenships

Get Entity Citizenships by Key
GET/research-sys/api/v1/entity-citizenships/(key)

Example URI

GET /research-sys/api/v1/entity-citizenships/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "startDateValue": "(val)",
  "countryCode": "(val)",
  "endDateValue": "(val)",
  "active": "(val)",
  "entityId": "(val)",
  "statusCode": "(val)",
  "_primaryKey": "(val)"
}

Get All Entity Citizenships
GET/research-sys/api/v1/entity-citizenships/

Example URI

GET /research-sys/api/v1/entity-citizenships/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "startDateValue": "(val)",
    "countryCode": "(val)",
    "endDateValue": "(val)",
    "active": "(val)",
    "entityId": "(val)",
    "statusCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "startDateValue": "(val)",
    "countryCode": "(val)",
    "endDateValue": "(val)",
    "active": "(val)",
    "entityId": "(val)",
    "statusCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Entity Citizenships with Filtering
GET/research-sys/api/v1/entity-citizenships/

Example URI

GET /research-sys/api/v1/entity-citizenships/
URI Parameters
HideShow
id
string (optional) 
startDateValue
string (optional) 
countryCode
string (optional) 
endDateValue
string (optional) 
active
string (optional) 
entityId
string (optional) 
statusCode
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "startDateValue": "(val)",
    "countryCode": "(val)",
    "endDateValue": "(val)",
    "active": "(val)",
    "entityId": "(val)",
    "statusCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "startDateValue": "(val)",
    "countryCode": "(val)",
    "endDateValue": "(val)",
    "active": "(val)",
    "entityId": "(val)",
    "statusCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Entity Citizenships
GET/research-sys/api/v1/entity-citizenships/

Example URI

GET /research-sys/api/v1/entity-citizenships/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "startDateValue",
    "countryCode",
    "endDateValue",
    "active",
    "entityId",
    "statusCode"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Entity Citizenships
GET/research-sys/api/v1/entity-citizenships/

Example URI

GET /research-sys/api/v1/entity-citizenships/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Entity Citizenships.md"
transfer-encoding: chunked

Update Entity Citizenships
PUT/research-sys/api/v1/entity-citizenships/(key)

Example URI

PUT /research-sys/api/v1/entity-citizenships/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "startDateValue": "(val)",
  "countryCode": "(val)",
  "endDateValue": "(val)",
  "active": "(val)",
  "entityId": "(val)",
  "statusCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Entity Citizenships
PUT/research-sys/api/v1/entity-citizenships/

Example URI

PUT /research-sys/api/v1/entity-citizenships/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "startDateValue": "(val)",
    "countryCode": "(val)",
    "endDateValue": "(val)",
    "active": "(val)",
    "entityId": "(val)",
    "statusCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "startDateValue": "(val)",
    "countryCode": "(val)",
    "endDateValue": "(val)",
    "active": "(val)",
    "entityId": "(val)",
    "statusCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Entity Citizenships
PATCH/research-sys/api/v1/entity-citizenships/(key)

Example URI

PATCH /research-sys/api/v1/entity-citizenships/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "startDateValue": "(val)",
  "countryCode": "(val)",
  "endDateValue": "(val)",
  "active": "(val)",
  "entityId": "(val)",
  "statusCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "startDateValue": "(val)",
  "countryCode": "(val)",
  "endDateValue": "(val)",
  "active": "(val)",
  "entityId": "(val)",
  "statusCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Entity Citizenships
POST/research-sys/api/v1/entity-citizenships/

Example URI

POST /research-sys/api/v1/entity-citizenships/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "startDateValue": "(val)",
  "countryCode": "(val)",
  "endDateValue": "(val)",
  "active": "(val)",
  "entityId": "(val)",
  "statusCode": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "startDateValue": "(val)",
  "countryCode": "(val)",
  "endDateValue": "(val)",
  "active": "(val)",
  "entityId": "(val)",
  "statusCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Entity Citizenships
POST/research-sys/api/v1/entity-citizenships/

Example URI

POST /research-sys/api/v1/entity-citizenships/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "startDateValue": "(val)",
    "countryCode": "(val)",
    "endDateValue": "(val)",
    "active": "(val)",
    "entityId": "(val)",
    "statusCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "startDateValue": "(val)",
    "countryCode": "(val)",
    "endDateValue": "(val)",
    "active": "(val)",
    "entityId": "(val)",
    "statusCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "startDateValue": "(val)",
    "countryCode": "(val)",
    "endDateValue": "(val)",
    "active": "(val)",
    "entityId": "(val)",
    "statusCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "startDateValue": "(val)",
    "countryCode": "(val)",
    "endDateValue": "(val)",
    "active": "(val)",
    "entityId": "(val)",
    "statusCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Entity Citizenships by Key
DELETE/research-sys/api/v1/entity-citizenships/(key)

Example URI

DELETE /research-sys/api/v1/entity-citizenships/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Entity Citizenships
DELETE/research-sys/api/v1/entity-citizenships/

Example URI

DELETE /research-sys/api/v1/entity-citizenships/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Entity Citizenships with Matching
DELETE/research-sys/api/v1/entity-citizenships/

Example URI

DELETE /research-sys/api/v1/entity-citizenships/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 
startDateValue
string (optional) 
countryCode
string (optional) 
endDateValue
string (optional) 
active
string (optional) 
entityId
string (optional) 
statusCode
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Entity Default Info Caches

Get Entity Default Info Caches by Key
GET/research-sys/api/v1/entity-default-info-caches/(key)

Example URI

GET /research-sys/api/v1/entity-default-info-caches/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "principalId": "(val)",
  "principalName": "(val)",
  "entityId": "(val)",
  "entityTypeCode": "(val)",
  "firstName": "(val)",
  "middleName": "(val)",
  "lastName": "(val)",
  "name": "(val)",
  "campusCode": "(val)",
  "primaryDepartmentCode": "(val)",
  "employeeId": "(val)",
  "lastUpdateTimestamp": "(val)",
  "_primaryKey": "(val)"
}

Get All Entity Default Info Caches
GET/research-sys/api/v1/entity-default-info-caches/

Example URI

GET /research-sys/api/v1/entity-default-info-caches/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "principalId": "(val)",
    "principalName": "(val)",
    "entityId": "(val)",
    "entityTypeCode": "(val)",
    "firstName": "(val)",
    "middleName": "(val)",
    "lastName": "(val)",
    "name": "(val)",
    "campusCode": "(val)",
    "primaryDepartmentCode": "(val)",
    "employeeId": "(val)",
    "lastUpdateTimestamp": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "principalId": "(val)",
    "principalName": "(val)",
    "entityId": "(val)",
    "entityTypeCode": "(val)",
    "firstName": "(val)",
    "middleName": "(val)",
    "lastName": "(val)",
    "name": "(val)",
    "campusCode": "(val)",
    "primaryDepartmentCode": "(val)",
    "employeeId": "(val)",
    "lastUpdateTimestamp": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Entity Default Info Caches with Filtering
GET/research-sys/api/v1/entity-default-info-caches/

Example URI

GET /research-sys/api/v1/entity-default-info-caches/
URI Parameters
HideShow
principalId
string (optional) 
principalName
string (optional) 
entityId
string (optional) 
entityTypeCode
string (optional) 
firstName
string (optional) 
middleName
string (optional) 
lastName
string (optional) 
name
string (optional) 
campusCode
string (optional) 
primaryDepartmentCode
string (optional) 
employeeId
string (optional) 
lastUpdateTimestamp
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "principalId": "(val)",
    "principalName": "(val)",
    "entityId": "(val)",
    "entityTypeCode": "(val)",
    "firstName": "(val)",
    "middleName": "(val)",
    "lastName": "(val)",
    "name": "(val)",
    "campusCode": "(val)",
    "primaryDepartmentCode": "(val)",
    "employeeId": "(val)",
    "lastUpdateTimestamp": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "principalId": "(val)",
    "principalName": "(val)",
    "entityId": "(val)",
    "entityTypeCode": "(val)",
    "firstName": "(val)",
    "middleName": "(val)",
    "lastName": "(val)",
    "name": "(val)",
    "campusCode": "(val)",
    "primaryDepartmentCode": "(val)",
    "employeeId": "(val)",
    "lastUpdateTimestamp": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Entity Default Info Caches
GET/research-sys/api/v1/entity-default-info-caches/

Example URI

GET /research-sys/api/v1/entity-default-info-caches/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "principalId",
    "principalName",
    "entityId",
    "entityTypeCode",
    "firstName",
    "middleName",
    "lastName",
    "name",
    "campusCode",
    "primaryDepartmentCode",
    "employeeId",
    "lastUpdateTimestamp"
  ],
  "primaryKey": "principalId"
}

Get Blueprint API specification for Entity Default Info Caches
GET/research-sys/api/v1/entity-default-info-caches/

Example URI

GET /research-sys/api/v1/entity-default-info-caches/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Entity Default Info Caches.md"
transfer-encoding: chunked

Update Entity Default Info Caches
PUT/research-sys/api/v1/entity-default-info-caches/(key)

Example URI

PUT /research-sys/api/v1/entity-default-info-caches/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "principalId": "(val)",
  "principalName": "(val)",
  "entityId": "(val)",
  "entityTypeCode": "(val)",
  "firstName": "(val)",
  "middleName": "(val)",
  "lastName": "(val)",
  "name": "(val)",
  "campusCode": "(val)",
  "primaryDepartmentCode": "(val)",
  "employeeId": "(val)",
  "lastUpdateTimestamp": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Entity Default Info Caches
PUT/research-sys/api/v1/entity-default-info-caches/

Example URI

PUT /research-sys/api/v1/entity-default-info-caches/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "principalId": "(val)",
    "principalName": "(val)",
    "entityId": "(val)",
    "entityTypeCode": "(val)",
    "firstName": "(val)",
    "middleName": "(val)",
    "lastName": "(val)",
    "name": "(val)",
    "campusCode": "(val)",
    "primaryDepartmentCode": "(val)",
    "employeeId": "(val)",
    "lastUpdateTimestamp": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "principalId": "(val)",
    "principalName": "(val)",
    "entityId": "(val)",
    "entityTypeCode": "(val)",
    "firstName": "(val)",
    "middleName": "(val)",
    "lastName": "(val)",
    "name": "(val)",
    "campusCode": "(val)",
    "primaryDepartmentCode": "(val)",
    "employeeId": "(val)",
    "lastUpdateTimestamp": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Entity Default Info Caches
PATCH/research-sys/api/v1/entity-default-info-caches/(key)

Example URI

PATCH /research-sys/api/v1/entity-default-info-caches/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "principalId": "(val)",
  "principalName": "(val)",
  "entityId": "(val)",
  "entityTypeCode": "(val)",
  "firstName": "(val)",
  "middleName": "(val)",
  "lastName": "(val)",
  "name": "(val)",
  "campusCode": "(val)",
  "primaryDepartmentCode": "(val)",
  "employeeId": "(val)",
  "lastUpdateTimestamp": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "principalId": "(val)",
  "principalName": "(val)",
  "entityId": "(val)",
  "entityTypeCode": "(val)",
  "firstName": "(val)",
  "middleName": "(val)",
  "lastName": "(val)",
  "name": "(val)",
  "campusCode": "(val)",
  "primaryDepartmentCode": "(val)",
  "employeeId": "(val)",
  "lastUpdateTimestamp": "(val)",
  "_primaryKey": "(val)"
}

Insert Entity Default Info Caches
POST/research-sys/api/v1/entity-default-info-caches/

Example URI

POST /research-sys/api/v1/entity-default-info-caches/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "principalId": "(val)",
  "principalName": "(val)",
  "entityId": "(val)",
  "entityTypeCode": "(val)",
  "firstName": "(val)",
  "middleName": "(val)",
  "lastName": "(val)",
  "name": "(val)",
  "campusCode": "(val)",
  "primaryDepartmentCode": "(val)",
  "employeeId": "(val)",
  "lastUpdateTimestamp": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "principalId": "(val)",
  "principalName": "(val)",
  "entityId": "(val)",
  "entityTypeCode": "(val)",
  "firstName": "(val)",
  "middleName": "(val)",
  "lastName": "(val)",
  "name": "(val)",
  "campusCode": "(val)",
  "primaryDepartmentCode": "(val)",
  "employeeId": "(val)",
  "lastUpdateTimestamp": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Entity Default Info Caches
POST/research-sys/api/v1/entity-default-info-caches/

Example URI

POST /research-sys/api/v1/entity-default-info-caches/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "principalId": "(val)",
    "principalName": "(val)",
    "entityId": "(val)",
    "entityTypeCode": "(val)",
    "firstName": "(val)",
    "middleName": "(val)",
    "lastName": "(val)",
    "name": "(val)",
    "campusCode": "(val)",
    "primaryDepartmentCode": "(val)",
    "employeeId": "(val)",
    "lastUpdateTimestamp": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "principalId": "(val)",
    "principalName": "(val)",
    "entityId": "(val)",
    "entityTypeCode": "(val)",
    "firstName": "(val)",
    "middleName": "(val)",
    "lastName": "(val)",
    "name": "(val)",
    "campusCode": "(val)",
    "primaryDepartmentCode": "(val)",
    "employeeId": "(val)",
    "lastUpdateTimestamp": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "principalId": "(val)",
    "principalName": "(val)",
    "entityId": "(val)",
    "entityTypeCode": "(val)",
    "firstName": "(val)",
    "middleName": "(val)",
    "lastName": "(val)",
    "name": "(val)",
    "campusCode": "(val)",
    "primaryDepartmentCode": "(val)",
    "employeeId": "(val)",
    "lastUpdateTimestamp": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "principalId": "(val)",
    "principalName": "(val)",
    "entityId": "(val)",
    "entityTypeCode": "(val)",
    "firstName": "(val)",
    "middleName": "(val)",
    "lastName": "(val)",
    "name": "(val)",
    "campusCode": "(val)",
    "primaryDepartmentCode": "(val)",
    "employeeId": "(val)",
    "lastUpdateTimestamp": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Entity Default Info Caches by Key
DELETE/research-sys/api/v1/entity-default-info-caches/(key)

Example URI

DELETE /research-sys/api/v1/entity-default-info-caches/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Entity Default Info Caches
DELETE/research-sys/api/v1/entity-default-info-caches/

Example URI

DELETE /research-sys/api/v1/entity-default-info-caches/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Entity Default Info Caches with Matching
DELETE/research-sys/api/v1/entity-default-info-caches/

Example URI

DELETE /research-sys/api/v1/entity-default-info-caches/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

principalId
string (optional) 
principalName
string (optional) 
entityId
string (optional) 
entityTypeCode
string (optional) 
firstName
string (optional) 
middleName
string (optional) 
lastName
string (optional) 
name
string (optional) 
campusCode
string (optional) 
primaryDepartmentCode
string (optional) 
employeeId
string (optional) 
lastUpdateTimestamp
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Entity Disability Accomodation Needed Entries

Get Entity Disability Accomodation Needed Entries by Key
GET/research-sys/api/v1/entity-disability-accomodation-needed-entries/(key)

Example URI

GET /research-sys/api/v1/entity-disability-accomodation-needed-entries/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}

Get All Entity Disability Accomodation Needed Entries
GET/research-sys/api/v1/entity-disability-accomodation-needed-entries/

Example URI

GET /research-sys/api/v1/entity-disability-accomodation-needed-entries/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Entity Disability Accomodation Needed Entries with Filtering
GET/research-sys/api/v1/entity-disability-accomodation-needed-entries/

Example URI

GET /research-sys/api/v1/entity-disability-accomodation-needed-entries/
URI Parameters
HideShow
name
string (optional) 
active
string (optional) 
code
string (optional) 
sortCode
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Entity Disability Accomodation Needed Entries
GET/research-sys/api/v1/entity-disability-accomodation-needed-entries/

Example URI

GET /research-sys/api/v1/entity-disability-accomodation-needed-entries/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "name",
    "active",
    "code",
    "sortCode"
  ],
  "primaryKey": "code"
}

Get Blueprint API specification for Entity Disability Accomodation Needed Entries
GET/research-sys/api/v1/entity-disability-accomodation-needed-entries/

Example URI

GET /research-sys/api/v1/entity-disability-accomodation-needed-entries/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Entity Disability Accomodation Needed Entries.md"
transfer-encoding: chunked

Update Entity Disability Accomodation Needed Entries
PUT/research-sys/api/v1/entity-disability-accomodation-needed-entries/(key)

Example URI

PUT /research-sys/api/v1/entity-disability-accomodation-needed-entries/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Entity Disability Accomodation Needed Entries
PUT/research-sys/api/v1/entity-disability-accomodation-needed-entries/

Example URI

PUT /research-sys/api/v1/entity-disability-accomodation-needed-entries/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Entity Disability Accomodation Needed Entries
PATCH/research-sys/api/v1/entity-disability-accomodation-needed-entries/(key)

Example URI

PATCH /research-sys/api/v1/entity-disability-accomodation-needed-entries/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Entity Disability Accomodation Needed Entries
POST/research-sys/api/v1/entity-disability-accomodation-needed-entries/

Example URI

POST /research-sys/api/v1/entity-disability-accomodation-needed-entries/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Entity Disability Accomodation Needed Entries
POST/research-sys/api/v1/entity-disability-accomodation-needed-entries/

Example URI

POST /research-sys/api/v1/entity-disability-accomodation-needed-entries/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Entity Disability Accomodation Needed Entries by Key
DELETE/research-sys/api/v1/entity-disability-accomodation-needed-entries/(key)

Example URI

DELETE /research-sys/api/v1/entity-disability-accomodation-needed-entries/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Entity Disability Accomodation Needed Entries
DELETE/research-sys/api/v1/entity-disability-accomodation-needed-entries/

Example URI

DELETE /research-sys/api/v1/entity-disability-accomodation-needed-entries/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Entity Disability Accomodation Needed Entries with Matching
DELETE/research-sys/api/v1/entity-disability-accomodation-needed-entries/

Example URI

DELETE /research-sys/api/v1/entity-disability-accomodation-needed-entries/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

name
string (optional) 
active
string (optional) 
code
string (optional) 
sortCode
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Entity Email Types

Get Entity Email Types by Key
GET/research-sys/api/v1/entity-email-types/(key)

Example URI

GET /research-sys/api/v1/entity-email-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}

Get All Entity Email Types
GET/research-sys/api/v1/entity-email-types/

Example URI

GET /research-sys/api/v1/entity-email-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Entity Email Types with Filtering
GET/research-sys/api/v1/entity-email-types/

Example URI

GET /research-sys/api/v1/entity-email-types/
URI Parameters
HideShow
name
string (optional) 

Descriptive text. Maximum length is 10.

active
string (optional) 

This attribute is used to describe whether the associated object is active or inactive. Maximum length is 1.

code
string (optional) 

The email type code. Maximum length is 2.

sortCode
string (optional) 

Descriptive text. Maximum length is 10.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Entity Email Types
GET/research-sys/api/v1/entity-email-types/

Example URI

GET /research-sys/api/v1/entity-email-types/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "name",
    "active",
    "code",
    "sortCode"
  ],
  "primaryKey": "code"
}

Get Blueprint API specification for Entity Email Types
GET/research-sys/api/v1/entity-email-types/

Example URI

GET /research-sys/api/v1/entity-email-types/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Entity Email Types.md"
transfer-encoding: chunked

Update Entity Email Types
PUT/research-sys/api/v1/entity-email-types/(key)

Example URI

PUT /research-sys/api/v1/entity-email-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Entity Email Types
PUT/research-sys/api/v1/entity-email-types/

Example URI

PUT /research-sys/api/v1/entity-email-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Entity Email Types
PATCH/research-sys/api/v1/entity-email-types/(key)

Example URI

PATCH /research-sys/api/v1/entity-email-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Entity Email Types
POST/research-sys/api/v1/entity-email-types/

Example URI

POST /research-sys/api/v1/entity-email-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Entity Email Types
POST/research-sys/api/v1/entity-email-types/

Example URI

POST /research-sys/api/v1/entity-email-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Entity Email Types by Key
DELETE/research-sys/api/v1/entity-email-types/(key)

Example URI

DELETE /research-sys/api/v1/entity-email-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Entity Email Types
DELETE/research-sys/api/v1/entity-email-types/

Example URI

DELETE /research-sys/api/v1/entity-email-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Entity Email Types with Matching
DELETE/research-sys/api/v1/entity-email-types/

Example URI

DELETE /research-sys/api/v1/entity-email-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

name
string (optional) 

Descriptive text. Maximum length is 10.

active
string (optional) 

This attribute is used to describe whether the associated object is active or inactive. Maximum length is 1.

code
string (optional) 

The email type code. Maximum length is 2.

sortCode
string (optional) 

Descriptive text. Maximum length is 10.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Entity Emails

Get Entity Emails by Key
GET/research-sys/api/v1/entity-emails/(key)

Example URI

GET /research-sys/api/v1/entity-emails/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "emailAddress": "(val)",
  "defaultValue": "(val)",
  "entityTypeCode": "(val)",
  "active": "(val)",
  "entityId": "(val)",
  "emailTypeCode": "(val)",
  "_primaryKey": "(val)"
}

Get All Entity Emails
GET/research-sys/api/v1/entity-emails/

Example URI

GET /research-sys/api/v1/entity-emails/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "emailAddress": "(val)",
    "defaultValue": "(val)",
    "entityTypeCode": "(val)",
    "active": "(val)",
    "entityId": "(val)",
    "emailTypeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "emailAddress": "(val)",
    "defaultValue": "(val)",
    "entityTypeCode": "(val)",
    "active": "(val)",
    "entityId": "(val)",
    "emailTypeCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Entity Emails with Filtering
GET/research-sys/api/v1/entity-emails/

Example URI

GET /research-sys/api/v1/entity-emails/
URI Parameters
HideShow
id
string (optional) 
emailAddress
string (optional) 
defaultValue
string (optional) 
entityTypeCode
string (optional) 
active
string (optional) 
entityId
string (optional) 
emailTypeCode
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "emailAddress": "(val)",
    "defaultValue": "(val)",
    "entityTypeCode": "(val)",
    "active": "(val)",
    "entityId": "(val)",
    "emailTypeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "emailAddress": "(val)",
    "defaultValue": "(val)",
    "entityTypeCode": "(val)",
    "active": "(val)",
    "entityId": "(val)",
    "emailTypeCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Entity Emails
GET/research-sys/api/v1/entity-emails/

Example URI

GET /research-sys/api/v1/entity-emails/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "emailAddress",
    "defaultValue",
    "entityTypeCode",
    "active",
    "entityId",
    "emailTypeCode"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Entity Emails
GET/research-sys/api/v1/entity-emails/

Example URI

GET /research-sys/api/v1/entity-emails/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Entity Emails.md"
transfer-encoding: chunked

Update Entity Emails
PUT/research-sys/api/v1/entity-emails/(key)

Example URI

PUT /research-sys/api/v1/entity-emails/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "emailAddress": "(val)",
  "defaultValue": "(val)",
  "entityTypeCode": "(val)",
  "active": "(val)",
  "entityId": "(val)",
  "emailTypeCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Entity Emails
PUT/research-sys/api/v1/entity-emails/

Example URI

PUT /research-sys/api/v1/entity-emails/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "emailAddress": "(val)",
    "defaultValue": "(val)",
    "entityTypeCode": "(val)",
    "active": "(val)",
    "entityId": "(val)",
    "emailTypeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "emailAddress": "(val)",
    "defaultValue": "(val)",
    "entityTypeCode": "(val)",
    "active": "(val)",
    "entityId": "(val)",
    "emailTypeCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Entity Emails
PATCH/research-sys/api/v1/entity-emails/(key)

Example URI

PATCH /research-sys/api/v1/entity-emails/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "emailAddress": "(val)",
  "defaultValue": "(val)",
  "entityTypeCode": "(val)",
  "active": "(val)",
  "entityId": "(val)",
  "emailTypeCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "emailAddress": "(val)",
  "defaultValue": "(val)",
  "entityTypeCode": "(val)",
  "active": "(val)",
  "entityId": "(val)",
  "emailTypeCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Entity Emails
POST/research-sys/api/v1/entity-emails/

Example URI

POST /research-sys/api/v1/entity-emails/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "emailAddress": "(val)",
  "defaultValue": "(val)",
  "entityTypeCode": "(val)",
  "active": "(val)",
  "entityId": "(val)",
  "emailTypeCode": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "emailAddress": "(val)",
  "defaultValue": "(val)",
  "entityTypeCode": "(val)",
  "active": "(val)",
  "entityId": "(val)",
  "emailTypeCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Entity Emails
POST/research-sys/api/v1/entity-emails/

Example URI

POST /research-sys/api/v1/entity-emails/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "emailAddress": "(val)",
    "defaultValue": "(val)",
    "entityTypeCode": "(val)",
    "active": "(val)",
    "entityId": "(val)",
    "emailTypeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "emailAddress": "(val)",
    "defaultValue": "(val)",
    "entityTypeCode": "(val)",
    "active": "(val)",
    "entityId": "(val)",
    "emailTypeCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "emailAddress": "(val)",
    "defaultValue": "(val)",
    "entityTypeCode": "(val)",
    "active": "(val)",
    "entityId": "(val)",
    "emailTypeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "emailAddress": "(val)",
    "defaultValue": "(val)",
    "entityTypeCode": "(val)",
    "active": "(val)",
    "entityId": "(val)",
    "emailTypeCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Entity Emails by Key
DELETE/research-sys/api/v1/entity-emails/(key)

Example URI

DELETE /research-sys/api/v1/entity-emails/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Entity Emails
DELETE/research-sys/api/v1/entity-emails/

Example URI

DELETE /research-sys/api/v1/entity-emails/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Entity Emails with Matching
DELETE/research-sys/api/v1/entity-emails/

Example URI

DELETE /research-sys/api/v1/entity-emails/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 
emailAddress
string (optional) 
defaultValue
string (optional) 
entityTypeCode
string (optional) 
active
string (optional) 
entityId
string (optional) 
emailTypeCode
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Entity Employment Statuses

Get Entity Employment Statuses by Key
GET/research-sys/api/v1/entity-employment-statuses/(key)

Example URI

GET /research-sys/api/v1/entity-employment-statuses/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}

Get All Entity Employment Statuses
GET/research-sys/api/v1/entity-employment-statuses/

Example URI

GET /research-sys/api/v1/entity-employment-statuses/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Entity Employment Statuses with Filtering
GET/research-sys/api/v1/entity-employment-statuses/

Example URI

GET /research-sys/api/v1/entity-employment-statuses/
URI Parameters
HideShow
name
string (optional) 

Employee Status Name. Maximum length is 10.

active
string (optional) 

This attribute is used to describe whether the associated object is active or inactive. Maximum length is 1.

code
string (optional) 

Employee Status Code. Maximum length is 2.

sortCode
string (optional) 

Display Sort Code. Maximum length is 10.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Entity Employment Statuses
GET/research-sys/api/v1/entity-employment-statuses/

Example URI

GET /research-sys/api/v1/entity-employment-statuses/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "name",
    "active",
    "code",
    "sortCode"
  ],
  "primaryKey": "code"
}

Get Blueprint API specification for Entity Employment Statuses
GET/research-sys/api/v1/entity-employment-statuses/

Example URI

GET /research-sys/api/v1/entity-employment-statuses/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Entity Employment Statuses.md"
transfer-encoding: chunked

Update Entity Employment Statuses
PUT/research-sys/api/v1/entity-employment-statuses/(key)

Example URI

PUT /research-sys/api/v1/entity-employment-statuses/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Entity Employment Statuses
PUT/research-sys/api/v1/entity-employment-statuses/

Example URI

PUT /research-sys/api/v1/entity-employment-statuses/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Entity Employment Statuses
PATCH/research-sys/api/v1/entity-employment-statuses/(key)

Example URI

PATCH /research-sys/api/v1/entity-employment-statuses/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Entity Employment Statuses
POST/research-sys/api/v1/entity-employment-statuses/

Example URI

POST /research-sys/api/v1/entity-employment-statuses/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Entity Employment Statuses
POST/research-sys/api/v1/entity-employment-statuses/

Example URI

POST /research-sys/api/v1/entity-employment-statuses/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Entity Employment Statuses by Key
DELETE/research-sys/api/v1/entity-employment-statuses/(key)

Example URI

DELETE /research-sys/api/v1/entity-employment-statuses/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Entity Employment Statuses
DELETE/research-sys/api/v1/entity-employment-statuses/

Example URI

DELETE /research-sys/api/v1/entity-employment-statuses/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Entity Employment Statuses with Matching
DELETE/research-sys/api/v1/entity-employment-statuses/

Example URI

DELETE /research-sys/api/v1/entity-employment-statuses/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

name
string (optional) 

Employee Status Name. Maximum length is 10.

active
string (optional) 

This attribute is used to describe whether the associated object is active or inactive. Maximum length is 1.

code
string (optional) 

Employee Status Code. Maximum length is 2.

sortCode
string (optional) 

Display Sort Code. Maximum length is 10.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Entity Employment Types

Get Entity Employment Types by Key
GET/research-sys/api/v1/entity-employment-types/(key)

Example URI

GET /research-sys/api/v1/entity-employment-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}

Get All Entity Employment Types
GET/research-sys/api/v1/entity-employment-types/

Example URI

GET /research-sys/api/v1/entity-employment-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Entity Employment Types with Filtering
GET/research-sys/api/v1/entity-employment-types/

Example URI

GET /research-sys/api/v1/entity-employment-types/
URI Parameters
HideShow
name
string (optional) 

Employee Type Name. Maximum length is 10.

active
string (optional) 

This attribute is used to describe whether the associated object is active or inactive. Maximum length is 1.

code
string (optional) 

Employee Type Code. Maximum length is 2.

sortCode
string (optional) 

Display Sort Code. Maximum length is 10.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Entity Employment Types
GET/research-sys/api/v1/entity-employment-types/

Example URI

GET /research-sys/api/v1/entity-employment-types/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "name",
    "active",
    "code",
    "sortCode"
  ],
  "primaryKey": "code"
}

Get Blueprint API specification for Entity Employment Types
GET/research-sys/api/v1/entity-employment-types/

Example URI

GET /research-sys/api/v1/entity-employment-types/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Entity Employment Types.md"
transfer-encoding: chunked

Update Entity Employment Types
PUT/research-sys/api/v1/entity-employment-types/(key)

Example URI

PUT /research-sys/api/v1/entity-employment-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Entity Employment Types
PUT/research-sys/api/v1/entity-employment-types/

Example URI

PUT /research-sys/api/v1/entity-employment-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Entity Employment Types
PATCH/research-sys/api/v1/entity-employment-types/(key)

Example URI

PATCH /research-sys/api/v1/entity-employment-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Entity Employment Types
POST/research-sys/api/v1/entity-employment-types/

Example URI

POST /research-sys/api/v1/entity-employment-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Entity Employment Types
POST/research-sys/api/v1/entity-employment-types/

Example URI

POST /research-sys/api/v1/entity-employment-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Entity Employment Types by Key
DELETE/research-sys/api/v1/entity-employment-types/(key)

Example URI

DELETE /research-sys/api/v1/entity-employment-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Entity Employment Types
DELETE/research-sys/api/v1/entity-employment-types/

Example URI

DELETE /research-sys/api/v1/entity-employment-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Entity Employment Types with Matching
DELETE/research-sys/api/v1/entity-employment-types/

Example URI

DELETE /research-sys/api/v1/entity-employment-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

name
string (optional) 

Employee Type Name. Maximum length is 10.

active
string (optional) 

This attribute is used to describe whether the associated object is active or inactive. Maximum length is 1.

code
string (optional) 

Employee Type Code. Maximum length is 2.

sortCode
string (optional) 

Display Sort Code. Maximum length is 10.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Entity Employments

Get Entity Employments by Key
GET/research-sys/api/v1/entity-employments/(key)

Example URI

GET /research-sys/api/v1/entity-employments/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "primaryDepartmentCode": "(val)",
  "active": "(val)",
  "employeeId": "(val)",
  "entityId": "(val)",
  "entityAffiliationId": "(val)",
  "employeeStatusCode": "(val)",
  "employeeTypeCode": "(val)",
  "employmentRecordId": "(val)",
  "baseSalaryAmount": "(val)",
  "primary": "(val)",
  "_primaryKey": "(val)"
}

Get All Entity Employments
GET/research-sys/api/v1/entity-employments/

Example URI

GET /research-sys/api/v1/entity-employments/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "primaryDepartmentCode": "(val)",
    "active": "(val)",
    "employeeId": "(val)",
    "entityId": "(val)",
    "entityAffiliationId": "(val)",
    "employeeStatusCode": "(val)",
    "employeeTypeCode": "(val)",
    "employmentRecordId": "(val)",
    "baseSalaryAmount": "(val)",
    "primary": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "primaryDepartmentCode": "(val)",
    "active": "(val)",
    "employeeId": "(val)",
    "entityId": "(val)",
    "entityAffiliationId": "(val)",
    "employeeStatusCode": "(val)",
    "employeeTypeCode": "(val)",
    "employmentRecordId": "(val)",
    "baseSalaryAmount": "(val)",
    "primary": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Entity Employments with Filtering
GET/research-sys/api/v1/entity-employments/

Example URI

GET /research-sys/api/v1/entity-employments/
URI Parameters
HideShow
id
string (optional) 
primaryDepartmentCode
string (optional) 
active
string (optional) 
employeeId
string (optional) 
entityId
string (optional) 
entityAffiliationId
string (optional) 
employeeStatusCode
string (optional) 
employeeTypeCode
string (optional) 
employmentRecordId
string (optional) 
baseSalaryAmount
string (optional) 
primary
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "primaryDepartmentCode": "(val)",
    "active": "(val)",
    "employeeId": "(val)",
    "entityId": "(val)",
    "entityAffiliationId": "(val)",
    "employeeStatusCode": "(val)",
    "employeeTypeCode": "(val)",
    "employmentRecordId": "(val)",
    "baseSalaryAmount": "(val)",
    "primary": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "primaryDepartmentCode": "(val)",
    "active": "(val)",
    "employeeId": "(val)",
    "entityId": "(val)",
    "entityAffiliationId": "(val)",
    "employeeStatusCode": "(val)",
    "employeeTypeCode": "(val)",
    "employmentRecordId": "(val)",
    "baseSalaryAmount": "(val)",
    "primary": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Entity Employments
GET/research-sys/api/v1/entity-employments/

Example URI

GET /research-sys/api/v1/entity-employments/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "primaryDepartmentCode",
    "active",
    "employeeId",
    "entityId",
    "entityAffiliationId",
    "employeeStatusCode",
    "employeeTypeCode",
    "employmentRecordId",
    "baseSalaryAmount",
    "primary"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Entity Employments
GET/research-sys/api/v1/entity-employments/

Example URI

GET /research-sys/api/v1/entity-employments/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Entity Employments.md"
transfer-encoding: chunked

Update Entity Employments
PUT/research-sys/api/v1/entity-employments/(key)

Example URI

PUT /research-sys/api/v1/entity-employments/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "primaryDepartmentCode": "(val)",
  "active": "(val)",
  "employeeId": "(val)",
  "entityId": "(val)",
  "entityAffiliationId": "(val)",
  "employeeStatusCode": "(val)",
  "employeeTypeCode": "(val)",
  "employmentRecordId": "(val)",
  "baseSalaryAmount": "(val)",
  "primary": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Entity Employments
PUT/research-sys/api/v1/entity-employments/

Example URI

PUT /research-sys/api/v1/entity-employments/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "primaryDepartmentCode": "(val)",
    "active": "(val)",
    "employeeId": "(val)",
    "entityId": "(val)",
    "entityAffiliationId": "(val)",
    "employeeStatusCode": "(val)",
    "employeeTypeCode": "(val)",
    "employmentRecordId": "(val)",
    "baseSalaryAmount": "(val)",
    "primary": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "primaryDepartmentCode": "(val)",
    "active": "(val)",
    "employeeId": "(val)",
    "entityId": "(val)",
    "entityAffiliationId": "(val)",
    "employeeStatusCode": "(val)",
    "employeeTypeCode": "(val)",
    "employmentRecordId": "(val)",
    "baseSalaryAmount": "(val)",
    "primary": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Entity Employments
PATCH/research-sys/api/v1/entity-employments/(key)

Example URI

PATCH /research-sys/api/v1/entity-employments/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "primaryDepartmentCode": "(val)",
  "active": "(val)",
  "employeeId": "(val)",
  "entityId": "(val)",
  "entityAffiliationId": "(val)",
  "employeeStatusCode": "(val)",
  "employeeTypeCode": "(val)",
  "employmentRecordId": "(val)",
  "baseSalaryAmount": "(val)",
  "primary": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "primaryDepartmentCode": "(val)",
  "active": "(val)",
  "employeeId": "(val)",
  "entityId": "(val)",
  "entityAffiliationId": "(val)",
  "employeeStatusCode": "(val)",
  "employeeTypeCode": "(val)",
  "employmentRecordId": "(val)",
  "baseSalaryAmount": "(val)",
  "primary": "(val)",
  "_primaryKey": "(val)"
}

Insert Entity Employments
POST/research-sys/api/v1/entity-employments/

Example URI

POST /research-sys/api/v1/entity-employments/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "primaryDepartmentCode": "(val)",
  "active": "(val)",
  "employeeId": "(val)",
  "entityId": "(val)",
  "entityAffiliationId": "(val)",
  "employeeStatusCode": "(val)",
  "employeeTypeCode": "(val)",
  "employmentRecordId": "(val)",
  "baseSalaryAmount": "(val)",
  "primary": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "primaryDepartmentCode": "(val)",
  "active": "(val)",
  "employeeId": "(val)",
  "entityId": "(val)",
  "entityAffiliationId": "(val)",
  "employeeStatusCode": "(val)",
  "employeeTypeCode": "(val)",
  "employmentRecordId": "(val)",
  "baseSalaryAmount": "(val)",
  "primary": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Entity Employments
POST/research-sys/api/v1/entity-employments/

Example URI

POST /research-sys/api/v1/entity-employments/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "primaryDepartmentCode": "(val)",
    "active": "(val)",
    "employeeId": "(val)",
    "entityId": "(val)",
    "entityAffiliationId": "(val)",
    "employeeStatusCode": "(val)",
    "employeeTypeCode": "(val)",
    "employmentRecordId": "(val)",
    "baseSalaryAmount": "(val)",
    "primary": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "primaryDepartmentCode": "(val)",
    "active": "(val)",
    "employeeId": "(val)",
    "entityId": "(val)",
    "entityAffiliationId": "(val)",
    "employeeStatusCode": "(val)",
    "employeeTypeCode": "(val)",
    "employmentRecordId": "(val)",
    "baseSalaryAmount": "(val)",
    "primary": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "primaryDepartmentCode": "(val)",
    "active": "(val)",
    "employeeId": "(val)",
    "entityId": "(val)",
    "entityAffiliationId": "(val)",
    "employeeStatusCode": "(val)",
    "employeeTypeCode": "(val)",
    "employmentRecordId": "(val)",
    "baseSalaryAmount": "(val)",
    "primary": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "primaryDepartmentCode": "(val)",
    "active": "(val)",
    "employeeId": "(val)",
    "entityId": "(val)",
    "entityAffiliationId": "(val)",
    "employeeStatusCode": "(val)",
    "employeeTypeCode": "(val)",
    "employmentRecordId": "(val)",
    "baseSalaryAmount": "(val)",
    "primary": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Entity Employments by Key
DELETE/research-sys/api/v1/entity-employments/(key)

Example URI

DELETE /research-sys/api/v1/entity-employments/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Entity Employments
DELETE/research-sys/api/v1/entity-employments/

Example URI

DELETE /research-sys/api/v1/entity-employments/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Entity Employments with Matching
DELETE/research-sys/api/v1/entity-employments/

Example URI

DELETE /research-sys/api/v1/entity-employments/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 
primaryDepartmentCode
string (optional) 
active
string (optional) 
employeeId
string (optional) 
entityId
string (optional) 
entityAffiliationId
string (optional) 
employeeStatusCode
string (optional) 
employeeTypeCode
string (optional) 
employmentRecordId
string (optional) 
baseSalaryAmount
string (optional) 
primary
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Entity Ethnicities

Get Entity Ethnicities by Key
GET/research-sys/api/v1/entity-ethnicities/(key)

Example URI

GET /research-sys/api/v1/entity-ethnicities/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "entityId": "(val)",
  "ethnicityCode": "(val)",
  "subEthnicityCode": "(val)",
  "_primaryKey": "(val)"
}

Get All Entity Ethnicities
GET/research-sys/api/v1/entity-ethnicities/

Example URI

GET /research-sys/api/v1/entity-ethnicities/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "entityId": "(val)",
    "ethnicityCode": "(val)",
    "subEthnicityCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "entityId": "(val)",
    "ethnicityCode": "(val)",
    "subEthnicityCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Entity Ethnicities with Filtering
GET/research-sys/api/v1/entity-ethnicities/

Example URI

GET /research-sys/api/v1/entity-ethnicities/
URI Parameters
HideShow
id
string (optional) 
entityId
string (optional) 
ethnicityCode
string (optional) 
subEthnicityCode
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "entityId": "(val)",
    "ethnicityCode": "(val)",
    "subEthnicityCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "entityId": "(val)",
    "ethnicityCode": "(val)",
    "subEthnicityCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Entity Ethnicities
GET/research-sys/api/v1/entity-ethnicities/

Example URI

GET /research-sys/api/v1/entity-ethnicities/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "entityId",
    "ethnicityCode",
    "subEthnicityCode"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Entity Ethnicities
GET/research-sys/api/v1/entity-ethnicities/

Example URI

GET /research-sys/api/v1/entity-ethnicities/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Entity Ethnicities.md"
transfer-encoding: chunked

Update Entity Ethnicities
PUT/research-sys/api/v1/entity-ethnicities/(key)

Example URI

PUT /research-sys/api/v1/entity-ethnicities/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "entityId": "(val)",
  "ethnicityCode": "(val)",
  "subEthnicityCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Entity Ethnicities
PUT/research-sys/api/v1/entity-ethnicities/

Example URI

PUT /research-sys/api/v1/entity-ethnicities/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "entityId": "(val)",
    "ethnicityCode": "(val)",
    "subEthnicityCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "entityId": "(val)",
    "ethnicityCode": "(val)",
    "subEthnicityCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Entity Ethnicities
PATCH/research-sys/api/v1/entity-ethnicities/(key)

Example URI

PATCH /research-sys/api/v1/entity-ethnicities/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "entityId": "(val)",
  "ethnicityCode": "(val)",
  "subEthnicityCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "entityId": "(val)",
  "ethnicityCode": "(val)",
  "subEthnicityCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Entity Ethnicities
POST/research-sys/api/v1/entity-ethnicities/

Example URI

POST /research-sys/api/v1/entity-ethnicities/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "entityId": "(val)",
  "ethnicityCode": "(val)",
  "subEthnicityCode": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "entityId": "(val)",
  "ethnicityCode": "(val)",
  "subEthnicityCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Entity Ethnicities
POST/research-sys/api/v1/entity-ethnicities/

Example URI

POST /research-sys/api/v1/entity-ethnicities/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "entityId": "(val)",
    "ethnicityCode": "(val)",
    "subEthnicityCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "entityId": "(val)",
    "ethnicityCode": "(val)",
    "subEthnicityCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "entityId": "(val)",
    "ethnicityCode": "(val)",
    "subEthnicityCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "entityId": "(val)",
    "ethnicityCode": "(val)",
    "subEthnicityCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Entity Ethnicities by Key
DELETE/research-sys/api/v1/entity-ethnicities/(key)

Example URI

DELETE /research-sys/api/v1/entity-ethnicities/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Entity Ethnicities
DELETE/research-sys/api/v1/entity-ethnicities/

Example URI

DELETE /research-sys/api/v1/entity-ethnicities/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Entity Ethnicities with Matching
DELETE/research-sys/api/v1/entity-ethnicities/

Example URI

DELETE /research-sys/api/v1/entity-ethnicities/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 
entityId
string (optional) 
ethnicityCode
string (optional) 
subEthnicityCode
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Entity Ethnicity Race Types

Get Entity Ethnicity Race Types by Key
GET/research-sys/api/v1/entity-ethnicity-race-types/(key)

Example URI

GET /research-sys/api/v1/entity-ethnicity-race-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}

Get All Entity Ethnicity Race Types
GET/research-sys/api/v1/entity-ethnicity-race-types/

Example URI

GET /research-sys/api/v1/entity-ethnicity-race-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Entity Ethnicity Race Types with Filtering
GET/research-sys/api/v1/entity-ethnicity-race-types/

Example URI

GET /research-sys/api/v1/entity-ethnicity-race-types/
URI Parameters
HideShow
name
string (optional) 
active
string (optional) 
code
string (optional) 
sortCode
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Entity Ethnicity Race Types
GET/research-sys/api/v1/entity-ethnicity-race-types/

Example URI

GET /research-sys/api/v1/entity-ethnicity-race-types/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "name",
    "active",
    "code",
    "sortCode"
  ],
  "primaryKey": "code"
}

Get Blueprint API specification for Entity Ethnicity Race Types
GET/research-sys/api/v1/entity-ethnicity-race-types/

Example URI

GET /research-sys/api/v1/entity-ethnicity-race-types/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Entity Ethnicity Race Types.md"
transfer-encoding: chunked

Update Entity Ethnicity Race Types
PUT/research-sys/api/v1/entity-ethnicity-race-types/(key)

Example URI

PUT /research-sys/api/v1/entity-ethnicity-race-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Entity Ethnicity Race Types
PUT/research-sys/api/v1/entity-ethnicity-race-types/

Example URI

PUT /research-sys/api/v1/entity-ethnicity-race-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Entity Ethnicity Race Types
PATCH/research-sys/api/v1/entity-ethnicity-race-types/(key)

Example URI

PATCH /research-sys/api/v1/entity-ethnicity-race-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Entity Ethnicity Race Types
POST/research-sys/api/v1/entity-ethnicity-race-types/

Example URI

POST /research-sys/api/v1/entity-ethnicity-race-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Entity Ethnicity Race Types
POST/research-sys/api/v1/entity-ethnicity-race-types/

Example URI

POST /research-sys/api/v1/entity-ethnicity-race-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Entity Ethnicity Race Types by Key
DELETE/research-sys/api/v1/entity-ethnicity-race-types/(key)

Example URI

DELETE /research-sys/api/v1/entity-ethnicity-race-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Entity Ethnicity Race Types
DELETE/research-sys/api/v1/entity-ethnicity-race-types/

Example URI

DELETE /research-sys/api/v1/entity-ethnicity-race-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Entity Ethnicity Race Types with Matching
DELETE/research-sys/api/v1/entity-ethnicity-race-types/

Example URI

DELETE /research-sys/api/v1/entity-ethnicity-race-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

name
string (optional) 
active
string (optional) 
code
string (optional) 
sortCode
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Entity External Identifier Types

Get Entity External Identifier Types by Key
GET/research-sys/api/v1/entity-external-identifier-types/(key)

Example URI

GET /research-sys/api/v1/entity-external-identifier-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "encryptionRequired": "(val)",
  "code": "(val)",
  "name": "(val)",
  "active": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}

Get All Entity External Identifier Types
GET/research-sys/api/v1/entity-external-identifier-types/

Example URI

GET /research-sys/api/v1/entity-external-identifier-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "encryptionRequired": "(val)",
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "encryptionRequired": "(val)",
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Entity External Identifier Types with Filtering
GET/research-sys/api/v1/entity-external-identifier-types/

Example URI

GET /research-sys/api/v1/entity-external-identifier-types/
URI Parameters
HideShow
encryptionRequired
string (optional) 

Encryption Required.

code
string (optional) 

The external identifier type code. Maximum length is 7.

name
string (optional) 

Descriptive text. Maximum length is 50.

active
string (optional) 

This attribute is used to describe whether the associated object is active or inactive. Maximum length is 1.

sortCode
string (optional) 

Descriptive text. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "encryptionRequired": "(val)",
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "encryptionRequired": "(val)",
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Entity External Identifier Types
GET/research-sys/api/v1/entity-external-identifier-types/

Example URI

GET /research-sys/api/v1/entity-external-identifier-types/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "encryptionRequired",
    "code",
    "name",
    "active",
    "sortCode"
  ],
  "primaryKey": "code"
}

Get Blueprint API specification for Entity External Identifier Types
GET/research-sys/api/v1/entity-external-identifier-types/

Example URI

GET /research-sys/api/v1/entity-external-identifier-types/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Entity External Identifier Types.md"
transfer-encoding: chunked

Update Entity External Identifier Types
PUT/research-sys/api/v1/entity-external-identifier-types/(key)

Example URI

PUT /research-sys/api/v1/entity-external-identifier-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "encryptionRequired": "(val)",
  "code": "(val)",
  "name": "(val)",
  "active": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Entity External Identifier Types
PUT/research-sys/api/v1/entity-external-identifier-types/

Example URI

PUT /research-sys/api/v1/entity-external-identifier-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "encryptionRequired": "(val)",
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "encryptionRequired": "(val)",
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Entity External Identifier Types
PATCH/research-sys/api/v1/entity-external-identifier-types/(key)

Example URI

PATCH /research-sys/api/v1/entity-external-identifier-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "encryptionRequired": "(val)",
  "code": "(val)",
  "name": "(val)",
  "active": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "encryptionRequired": "(val)",
  "code": "(val)",
  "name": "(val)",
  "active": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Entity External Identifier Types
POST/research-sys/api/v1/entity-external-identifier-types/

Example URI

POST /research-sys/api/v1/entity-external-identifier-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "encryptionRequired": "(val)",
  "code": "(val)",
  "name": "(val)",
  "active": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "encryptionRequired": "(val)",
  "code": "(val)",
  "name": "(val)",
  "active": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Entity External Identifier Types
POST/research-sys/api/v1/entity-external-identifier-types/

Example URI

POST /research-sys/api/v1/entity-external-identifier-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "encryptionRequired": "(val)",
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "encryptionRequired": "(val)",
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "encryptionRequired": "(val)",
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "encryptionRequired": "(val)",
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Entity External Identifier Types by Key
DELETE/research-sys/api/v1/entity-external-identifier-types/(key)

Example URI

DELETE /research-sys/api/v1/entity-external-identifier-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Entity External Identifier Types
DELETE/research-sys/api/v1/entity-external-identifier-types/

Example URI

DELETE /research-sys/api/v1/entity-external-identifier-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Entity External Identifier Types with Matching
DELETE/research-sys/api/v1/entity-external-identifier-types/

Example URI

DELETE /research-sys/api/v1/entity-external-identifier-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

encryptionRequired
string (optional) 

Encryption Required.

code
string (optional) 

The external identifier type code. Maximum length is 7.

name
string (optional) 

Descriptive text. Maximum length is 50.

active
string (optional) 

This attribute is used to describe whether the associated object is active or inactive. Maximum length is 1.

sortCode
string (optional) 

Descriptive text. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Entity External Identifiers

Get Entity External Identifiers by Key
GET/research-sys/api/v1/entity-external-identifiers/(key)

Example URI

GET /research-sys/api/v1/entity-external-identifiers/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "entityId": "(val)",
  "externalIdentifierTypeCode": "(val)",
  "externalId": "(val)",
  "_primaryKey": "(val)"
}

Get All Entity External Identifiers
GET/research-sys/api/v1/entity-external-identifiers/

Example URI

GET /research-sys/api/v1/entity-external-identifiers/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "entityId": "(val)",
    "externalIdentifierTypeCode": "(val)",
    "externalId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "entityId": "(val)",
    "externalIdentifierTypeCode": "(val)",
    "externalId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Entity External Identifiers with Filtering
GET/research-sys/api/v1/entity-external-identifiers/

Example URI

GET /research-sys/api/v1/entity-external-identifiers/
URI Parameters
HideShow
id
string (optional) 
entityId
string (optional) 
externalIdentifierTypeCode
string (optional) 
externalId
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "entityId": "(val)",
    "externalIdentifierTypeCode": "(val)",
    "externalId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "entityId": "(val)",
    "externalIdentifierTypeCode": "(val)",
    "externalId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Entity External Identifiers
GET/research-sys/api/v1/entity-external-identifiers/

Example URI

GET /research-sys/api/v1/entity-external-identifiers/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "entityId",
    "externalIdentifierTypeCode",
    "externalId"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Entity External Identifiers
GET/research-sys/api/v1/entity-external-identifiers/

Example URI

GET /research-sys/api/v1/entity-external-identifiers/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Entity External Identifiers.md"
transfer-encoding: chunked

Update Entity External Identifiers
PUT/research-sys/api/v1/entity-external-identifiers/(key)

Example URI

PUT /research-sys/api/v1/entity-external-identifiers/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "entityId": "(val)",
  "externalIdentifierTypeCode": "(val)",
  "externalId": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Entity External Identifiers
PUT/research-sys/api/v1/entity-external-identifiers/

Example URI

PUT /research-sys/api/v1/entity-external-identifiers/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "entityId": "(val)",
    "externalIdentifierTypeCode": "(val)",
    "externalId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "entityId": "(val)",
    "externalIdentifierTypeCode": "(val)",
    "externalId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Entity External Identifiers
PATCH/research-sys/api/v1/entity-external-identifiers/(key)

Example URI

PATCH /research-sys/api/v1/entity-external-identifiers/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "entityId": "(val)",
  "externalIdentifierTypeCode": "(val)",
  "externalId": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "entityId": "(val)",
  "externalIdentifierTypeCode": "(val)",
  "externalId": "(val)",
  "_primaryKey": "(val)"
}

Insert Entity External Identifiers
POST/research-sys/api/v1/entity-external-identifiers/

Example URI

POST /research-sys/api/v1/entity-external-identifiers/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "entityId": "(val)",
  "externalIdentifierTypeCode": "(val)",
  "externalId": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "entityId": "(val)",
  "externalIdentifierTypeCode": "(val)",
  "externalId": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Entity External Identifiers
POST/research-sys/api/v1/entity-external-identifiers/

Example URI

POST /research-sys/api/v1/entity-external-identifiers/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "entityId": "(val)",
    "externalIdentifierTypeCode": "(val)",
    "externalId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "entityId": "(val)",
    "externalIdentifierTypeCode": "(val)",
    "externalId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "entityId": "(val)",
    "externalIdentifierTypeCode": "(val)",
    "externalId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "entityId": "(val)",
    "externalIdentifierTypeCode": "(val)",
    "externalId": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Entity External Identifiers by Key
DELETE/research-sys/api/v1/entity-external-identifiers/(key)

Example URI

DELETE /research-sys/api/v1/entity-external-identifiers/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Entity External Identifiers
DELETE/research-sys/api/v1/entity-external-identifiers/

Example URI

DELETE /research-sys/api/v1/entity-external-identifiers/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Entity External Identifiers with Matching
DELETE/research-sys/api/v1/entity-external-identifiers/

Example URI

DELETE /research-sys/api/v1/entity-external-identifiers/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 
entityId
string (optional) 
externalIdentifierTypeCode
string (optional) 
externalId
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Entity Name Types

Get Entity Name Types by Key
GET/research-sys/api/v1/entity-name-types/(key)

Example URI

GET /research-sys/api/v1/entity-name-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}

Get All Entity Name Types
GET/research-sys/api/v1/entity-name-types/

Example URI

GET /research-sys/api/v1/entity-name-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Entity Name Types with Filtering
GET/research-sys/api/v1/entity-name-types/

Example URI

GET /research-sys/api/v1/entity-name-types/
URI Parameters
HideShow
name
string (optional) 

Descriptive text. Maximum length is 50.

active
string (optional) 

This attribute is used to describe whether the associated object is active or inactive. Maximum length is 1.

code
string (optional) 

The entity name type code. Maximum length is 7.

sortCode
string (optional) 

Descriptive text. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Entity Name Types
GET/research-sys/api/v1/entity-name-types/

Example URI

GET /research-sys/api/v1/entity-name-types/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "name",
    "active",
    "code",
    "sortCode"
  ],
  "primaryKey": "code"
}

Get Blueprint API specification for Entity Name Types
GET/research-sys/api/v1/entity-name-types/

Example URI

GET /research-sys/api/v1/entity-name-types/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Entity Name Types.md"
transfer-encoding: chunked

Update Entity Name Types
PUT/research-sys/api/v1/entity-name-types/(key)

Example URI

PUT /research-sys/api/v1/entity-name-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Entity Name Types
PUT/research-sys/api/v1/entity-name-types/

Example URI

PUT /research-sys/api/v1/entity-name-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Entity Name Types
PATCH/research-sys/api/v1/entity-name-types/(key)

Example URI

PATCH /research-sys/api/v1/entity-name-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Entity Name Types
POST/research-sys/api/v1/entity-name-types/

Example URI

POST /research-sys/api/v1/entity-name-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Entity Name Types
POST/research-sys/api/v1/entity-name-types/

Example URI

POST /research-sys/api/v1/entity-name-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Entity Name Types by Key
DELETE/research-sys/api/v1/entity-name-types/(key)

Example URI

DELETE /research-sys/api/v1/entity-name-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Entity Name Types
DELETE/research-sys/api/v1/entity-name-types/

Example URI

DELETE /research-sys/api/v1/entity-name-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Entity Name Types with Matching
DELETE/research-sys/api/v1/entity-name-types/

Example URI

DELETE /research-sys/api/v1/entity-name-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

name
string (optional) 

Descriptive text. Maximum length is 50.

active
string (optional) 

This attribute is used to describe whether the associated object is active or inactive. Maximum length is 1.

code
string (optional) 

The entity name type code. Maximum length is 7.

sortCode
string (optional) 

Descriptive text. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Entity Names

Get Entity Names by Key
GET/research-sys/api/v1/entity-names/(key)

Example URI

GET /research-sys/api/v1/entity-names/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "lastName": "(val)",
  "defaultValue": "(val)",
  "nameTitle": "(val)",
  "active": "(val)",
  "nameSuffix": "(val)",
  "entityId": "(val)",
  "noteMessage": "(val)",
  "firstName": "(val)",
  "nameCode": "(val)",
  "namePrefix": "(val)",
  "nameChangedDate": "(val)",
  "middleName": "(val)",
  "_primaryKey": "(val)"
}

Get All Entity Names
GET/research-sys/api/v1/entity-names/

Example URI

GET /research-sys/api/v1/entity-names/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "lastName": "(val)",
    "defaultValue": "(val)",
    "nameTitle": "(val)",
    "active": "(val)",
    "nameSuffix": "(val)",
    "entityId": "(val)",
    "noteMessage": "(val)",
    "firstName": "(val)",
    "nameCode": "(val)",
    "namePrefix": "(val)",
    "nameChangedDate": "(val)",
    "middleName": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "lastName": "(val)",
    "defaultValue": "(val)",
    "nameTitle": "(val)",
    "active": "(val)",
    "nameSuffix": "(val)",
    "entityId": "(val)",
    "noteMessage": "(val)",
    "firstName": "(val)",
    "nameCode": "(val)",
    "namePrefix": "(val)",
    "nameChangedDate": "(val)",
    "middleName": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Entity Names with Filtering
GET/research-sys/api/v1/entity-names/

Example URI

GET /research-sys/api/v1/entity-names/
URI Parameters
HideShow
id
string (optional) 
lastName
string (optional) 
defaultValue
string (optional) 
nameTitle
string (optional) 
active
string (optional) 
nameSuffix
string (optional) 
entityId
string (optional) 
noteMessage
string (optional) 
firstName
string (optional) 
nameCode
string (optional) 
namePrefix
string (optional) 
nameChangedDate
string (optional) 
middleName
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "lastName": "(val)",
    "defaultValue": "(val)",
    "nameTitle": "(val)",
    "active": "(val)",
    "nameSuffix": "(val)",
    "entityId": "(val)",
    "noteMessage": "(val)",
    "firstName": "(val)",
    "nameCode": "(val)",
    "namePrefix": "(val)",
    "nameChangedDate": "(val)",
    "middleName": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "lastName": "(val)",
    "defaultValue": "(val)",
    "nameTitle": "(val)",
    "active": "(val)",
    "nameSuffix": "(val)",
    "entityId": "(val)",
    "noteMessage": "(val)",
    "firstName": "(val)",
    "nameCode": "(val)",
    "namePrefix": "(val)",
    "nameChangedDate": "(val)",
    "middleName": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Entity Names
GET/research-sys/api/v1/entity-names/

Example URI

GET /research-sys/api/v1/entity-names/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "lastName",
    "defaultValue",
    "nameTitle",
    "active",
    "nameSuffix",
    "entityId",
    "noteMessage",
    "firstName",
    "nameCode",
    "namePrefix",
    "nameChangedDate",
    "middleName"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Entity Names
GET/research-sys/api/v1/entity-names/

Example URI

GET /research-sys/api/v1/entity-names/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Entity Names.md"
transfer-encoding: chunked

Update Entity Names
PUT/research-sys/api/v1/entity-names/(key)

Example URI

PUT /research-sys/api/v1/entity-names/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "lastName": "(val)",
  "defaultValue": "(val)",
  "nameTitle": "(val)",
  "active": "(val)",
  "nameSuffix": "(val)",
  "entityId": "(val)",
  "noteMessage": "(val)",
  "firstName": "(val)",
  "nameCode": "(val)",
  "namePrefix": "(val)",
  "nameChangedDate": "(val)",
  "middleName": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Entity Names
PUT/research-sys/api/v1/entity-names/

Example URI

PUT /research-sys/api/v1/entity-names/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "lastName": "(val)",
    "defaultValue": "(val)",
    "nameTitle": "(val)",
    "active": "(val)",
    "nameSuffix": "(val)",
    "entityId": "(val)",
    "noteMessage": "(val)",
    "firstName": "(val)",
    "nameCode": "(val)",
    "namePrefix": "(val)",
    "nameChangedDate": "(val)",
    "middleName": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "lastName": "(val)",
    "defaultValue": "(val)",
    "nameTitle": "(val)",
    "active": "(val)",
    "nameSuffix": "(val)",
    "entityId": "(val)",
    "noteMessage": "(val)",
    "firstName": "(val)",
    "nameCode": "(val)",
    "namePrefix": "(val)",
    "nameChangedDate": "(val)",
    "middleName": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Entity Names
PATCH/research-sys/api/v1/entity-names/(key)

Example URI

PATCH /research-sys/api/v1/entity-names/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "lastName": "(val)",
  "defaultValue": "(val)",
  "nameTitle": "(val)",
  "active": "(val)",
  "nameSuffix": "(val)",
  "entityId": "(val)",
  "noteMessage": "(val)",
  "firstName": "(val)",
  "nameCode": "(val)",
  "namePrefix": "(val)",
  "nameChangedDate": "(val)",
  "middleName": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "lastName": "(val)",
  "defaultValue": "(val)",
  "nameTitle": "(val)",
  "active": "(val)",
  "nameSuffix": "(val)",
  "entityId": "(val)",
  "noteMessage": "(val)",
  "firstName": "(val)",
  "nameCode": "(val)",
  "namePrefix": "(val)",
  "nameChangedDate": "(val)",
  "middleName": "(val)",
  "_primaryKey": "(val)"
}

Insert Entity Names
POST/research-sys/api/v1/entity-names/

Example URI

POST /research-sys/api/v1/entity-names/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "lastName": "(val)",
  "defaultValue": "(val)",
  "nameTitle": "(val)",
  "active": "(val)",
  "nameSuffix": "(val)",
  "entityId": "(val)",
  "noteMessage": "(val)",
  "firstName": "(val)",
  "nameCode": "(val)",
  "namePrefix": "(val)",
  "nameChangedDate": "(val)",
  "middleName": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "lastName": "(val)",
  "defaultValue": "(val)",
  "nameTitle": "(val)",
  "active": "(val)",
  "nameSuffix": "(val)",
  "entityId": "(val)",
  "noteMessage": "(val)",
  "firstName": "(val)",
  "nameCode": "(val)",
  "namePrefix": "(val)",
  "nameChangedDate": "(val)",
  "middleName": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Entity Names
POST/research-sys/api/v1/entity-names/

Example URI

POST /research-sys/api/v1/entity-names/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "lastName": "(val)",
    "defaultValue": "(val)",
    "nameTitle": "(val)",
    "active": "(val)",
    "nameSuffix": "(val)",
    "entityId": "(val)",
    "noteMessage": "(val)",
    "firstName": "(val)",
    "nameCode": "(val)",
    "namePrefix": "(val)",
    "nameChangedDate": "(val)",
    "middleName": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "lastName": "(val)",
    "defaultValue": "(val)",
    "nameTitle": "(val)",
    "active": "(val)",
    "nameSuffix": "(val)",
    "entityId": "(val)",
    "noteMessage": "(val)",
    "firstName": "(val)",
    "nameCode": "(val)",
    "namePrefix": "(val)",
    "nameChangedDate": "(val)",
    "middleName": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "lastName": "(val)",
    "defaultValue": "(val)",
    "nameTitle": "(val)",
    "active": "(val)",
    "nameSuffix": "(val)",
    "entityId": "(val)",
    "noteMessage": "(val)",
    "firstName": "(val)",
    "nameCode": "(val)",
    "namePrefix": "(val)",
    "nameChangedDate": "(val)",
    "middleName": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "lastName": "(val)",
    "defaultValue": "(val)",
    "nameTitle": "(val)",
    "active": "(val)",
    "nameSuffix": "(val)",
    "entityId": "(val)",
    "noteMessage": "(val)",
    "firstName": "(val)",
    "nameCode": "(val)",
    "namePrefix": "(val)",
    "nameChangedDate": "(val)",
    "middleName": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Entity Names by Key
DELETE/research-sys/api/v1/entity-names/(key)

Example URI

DELETE /research-sys/api/v1/entity-names/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Entity Names
DELETE/research-sys/api/v1/entity-names/

Example URI

DELETE /research-sys/api/v1/entity-names/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Entity Names with Matching
DELETE/research-sys/api/v1/entity-names/

Example URI

DELETE /research-sys/api/v1/entity-names/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 
lastName
string (optional) 
defaultValue
string (optional) 
nameTitle
string (optional) 
active
string (optional) 
nameSuffix
string (optional) 
entityId
string (optional) 
noteMessage
string (optional) 
firstName
string (optional) 
nameCode
string (optional) 
namePrefix
string (optional) 
nameChangedDate
string (optional) 
middleName
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Entity Phone Types

Get Entity Phone Types by Key
GET/research-sys/api/v1/entity-phone-types/(key)

Example URI

GET /research-sys/api/v1/entity-phone-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}

Get All Entity Phone Types
GET/research-sys/api/v1/entity-phone-types/

Example URI

GET /research-sys/api/v1/entity-phone-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Entity Phone Types with Filtering
GET/research-sys/api/v1/entity-phone-types/

Example URI

GET /research-sys/api/v1/entity-phone-types/
URI Parameters
HideShow
name
string (optional) 

Descriptive text. Maximum length is 50.

active
string (optional) 

This attribute is used to describe whether the associated object is active or inactive. Maximum length is 1.

code
string (optional) 

The phone type code. Maximum length is 7.

sortCode
string (optional) 

Descriptive text. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Entity Phone Types
GET/research-sys/api/v1/entity-phone-types/

Example URI

GET /research-sys/api/v1/entity-phone-types/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "name",
    "active",
    "code",
    "sortCode"
  ],
  "primaryKey": "code"
}

Get Blueprint API specification for Entity Phone Types
GET/research-sys/api/v1/entity-phone-types/

Example URI

GET /research-sys/api/v1/entity-phone-types/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Entity Phone Types.md"
transfer-encoding: chunked

Update Entity Phone Types
PUT/research-sys/api/v1/entity-phone-types/(key)

Example URI

PUT /research-sys/api/v1/entity-phone-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Entity Phone Types
PUT/research-sys/api/v1/entity-phone-types/

Example URI

PUT /research-sys/api/v1/entity-phone-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Entity Phone Types
PATCH/research-sys/api/v1/entity-phone-types/(key)

Example URI

PATCH /research-sys/api/v1/entity-phone-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Entity Phone Types
POST/research-sys/api/v1/entity-phone-types/

Example URI

POST /research-sys/api/v1/entity-phone-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Entity Phone Types
POST/research-sys/api/v1/entity-phone-types/

Example URI

POST /research-sys/api/v1/entity-phone-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Entity Phone Types by Key
DELETE/research-sys/api/v1/entity-phone-types/(key)

Example URI

DELETE /research-sys/api/v1/entity-phone-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Entity Phone Types
DELETE/research-sys/api/v1/entity-phone-types/

Example URI

DELETE /research-sys/api/v1/entity-phone-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Entity Phone Types with Matching
DELETE/research-sys/api/v1/entity-phone-types/

Example URI

DELETE /research-sys/api/v1/entity-phone-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

name
string (optional) 

Descriptive text. Maximum length is 50.

active
string (optional) 

This attribute is used to describe whether the associated object is active or inactive. Maximum length is 1.

code
string (optional) 

The phone type code. Maximum length is 7.

sortCode
string (optional) 

Descriptive text. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Entity Phones

Get Entity Phones by Key
GET/research-sys/api/v1/entity-phones/(key)

Example URI

GET /research-sys/api/v1/entity-phones/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "phoneNumber": "(val)",
  "countryCode": "(val)",
  "defaultValue": "(val)",
  "entityTypeCode": "(val)",
  "extensionNumber": "(val)",
  "active": "(val)",
  "entityId": "(val)",
  "phoneTypeCode": "(val)",
  "_primaryKey": "(val)"
}

Get All Entity Phones
GET/research-sys/api/v1/entity-phones/

Example URI

GET /research-sys/api/v1/entity-phones/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "phoneNumber": "(val)",
    "countryCode": "(val)",
    "defaultValue": "(val)",
    "entityTypeCode": "(val)",
    "extensionNumber": "(val)",
    "active": "(val)",
    "entityId": "(val)",
    "phoneTypeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "phoneNumber": "(val)",
    "countryCode": "(val)",
    "defaultValue": "(val)",
    "entityTypeCode": "(val)",
    "extensionNumber": "(val)",
    "active": "(val)",
    "entityId": "(val)",
    "phoneTypeCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Entity Phones with Filtering
GET/research-sys/api/v1/entity-phones/

Example URI

GET /research-sys/api/v1/entity-phones/
URI Parameters
HideShow
id
string (optional) 
phoneNumber
string (optional) 
countryCode
string (optional) 
defaultValue
string (optional) 
entityTypeCode
string (optional) 
extensionNumber
string (optional) 
active
string (optional) 
entityId
string (optional) 
phoneTypeCode
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "phoneNumber": "(val)",
    "countryCode": "(val)",
    "defaultValue": "(val)",
    "entityTypeCode": "(val)",
    "extensionNumber": "(val)",
    "active": "(val)",
    "entityId": "(val)",
    "phoneTypeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "phoneNumber": "(val)",
    "countryCode": "(val)",
    "defaultValue": "(val)",
    "entityTypeCode": "(val)",
    "extensionNumber": "(val)",
    "active": "(val)",
    "entityId": "(val)",
    "phoneTypeCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Entity Phones
GET/research-sys/api/v1/entity-phones/

Example URI

GET /research-sys/api/v1/entity-phones/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "phoneNumber",
    "countryCode",
    "defaultValue",
    "entityTypeCode",
    "extensionNumber",
    "active",
    "entityId",
    "phoneTypeCode"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Entity Phones
GET/research-sys/api/v1/entity-phones/

Example URI

GET /research-sys/api/v1/entity-phones/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Entity Phones.md"
transfer-encoding: chunked

Update Entity Phones
PUT/research-sys/api/v1/entity-phones/(key)

Example URI

PUT /research-sys/api/v1/entity-phones/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "phoneNumber": "(val)",
  "countryCode": "(val)",
  "defaultValue": "(val)",
  "entityTypeCode": "(val)",
  "extensionNumber": "(val)",
  "active": "(val)",
  "entityId": "(val)",
  "phoneTypeCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Entity Phones
PUT/research-sys/api/v1/entity-phones/

Example URI

PUT /research-sys/api/v1/entity-phones/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "phoneNumber": "(val)",
    "countryCode": "(val)",
    "defaultValue": "(val)",
    "entityTypeCode": "(val)",
    "extensionNumber": "(val)",
    "active": "(val)",
    "entityId": "(val)",
    "phoneTypeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "phoneNumber": "(val)",
    "countryCode": "(val)",
    "defaultValue": "(val)",
    "entityTypeCode": "(val)",
    "extensionNumber": "(val)",
    "active": "(val)",
    "entityId": "(val)",
    "phoneTypeCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Entity Phones
PATCH/research-sys/api/v1/entity-phones/(key)

Example URI

PATCH /research-sys/api/v1/entity-phones/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "phoneNumber": "(val)",
  "countryCode": "(val)",
  "defaultValue": "(val)",
  "entityTypeCode": "(val)",
  "extensionNumber": "(val)",
  "active": "(val)",
  "entityId": "(val)",
  "phoneTypeCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "phoneNumber": "(val)",
  "countryCode": "(val)",
  "defaultValue": "(val)",
  "entityTypeCode": "(val)",
  "extensionNumber": "(val)",
  "active": "(val)",
  "entityId": "(val)",
  "phoneTypeCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Entity Phones
POST/research-sys/api/v1/entity-phones/

Example URI

POST /research-sys/api/v1/entity-phones/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "phoneNumber": "(val)",
  "countryCode": "(val)",
  "defaultValue": "(val)",
  "entityTypeCode": "(val)",
  "extensionNumber": "(val)",
  "active": "(val)",
  "entityId": "(val)",
  "phoneTypeCode": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "phoneNumber": "(val)",
  "countryCode": "(val)",
  "defaultValue": "(val)",
  "entityTypeCode": "(val)",
  "extensionNumber": "(val)",
  "active": "(val)",
  "entityId": "(val)",
  "phoneTypeCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Entity Phones
POST/research-sys/api/v1/entity-phones/

Example URI

POST /research-sys/api/v1/entity-phones/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "phoneNumber": "(val)",
    "countryCode": "(val)",
    "defaultValue": "(val)",
    "entityTypeCode": "(val)",
    "extensionNumber": "(val)",
    "active": "(val)",
    "entityId": "(val)",
    "phoneTypeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "phoneNumber": "(val)",
    "countryCode": "(val)",
    "defaultValue": "(val)",
    "entityTypeCode": "(val)",
    "extensionNumber": "(val)",
    "active": "(val)",
    "entityId": "(val)",
    "phoneTypeCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "phoneNumber": "(val)",
    "countryCode": "(val)",
    "defaultValue": "(val)",
    "entityTypeCode": "(val)",
    "extensionNumber": "(val)",
    "active": "(val)",
    "entityId": "(val)",
    "phoneTypeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "phoneNumber": "(val)",
    "countryCode": "(val)",
    "defaultValue": "(val)",
    "entityTypeCode": "(val)",
    "extensionNumber": "(val)",
    "active": "(val)",
    "entityId": "(val)",
    "phoneTypeCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Entity Phones by Key
DELETE/research-sys/api/v1/entity-phones/(key)

Example URI

DELETE /research-sys/api/v1/entity-phones/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Entity Phones
DELETE/research-sys/api/v1/entity-phones/

Example URI

DELETE /research-sys/api/v1/entity-phones/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Entity Phones with Matching
DELETE/research-sys/api/v1/entity-phones/

Example URI

DELETE /research-sys/api/v1/entity-phones/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 
phoneNumber
string (optional) 
countryCode
string (optional) 
defaultValue
string (optional) 
entityTypeCode
string (optional) 
extensionNumber
string (optional) 
active
string (optional) 
entityId
string (optional) 
phoneTypeCode
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Entity Privacy Preferences

Get Entity Privacy Preferences by Key
GET/research-sys/api/v1/entity-privacy-preferences/(key)

Example URI

GET /research-sys/api/v1/entity-privacy-preferences/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "entityId": "(val)",
  "suppressName": "(val)",
  "suppressEmail": "(val)",
  "suppressAddress": "(val)",
  "suppressPhone": "(val)",
  "suppressPersonal": "(val)",
  "_primaryKey": "(val)"
}

Get All Entity Privacy Preferences
GET/research-sys/api/v1/entity-privacy-preferences/

Example URI

GET /research-sys/api/v1/entity-privacy-preferences/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "entityId": "(val)",
    "suppressName": "(val)",
    "suppressEmail": "(val)",
    "suppressAddress": "(val)",
    "suppressPhone": "(val)",
    "suppressPersonal": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "entityId": "(val)",
    "suppressName": "(val)",
    "suppressEmail": "(val)",
    "suppressAddress": "(val)",
    "suppressPhone": "(val)",
    "suppressPersonal": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Entity Privacy Preferences with Filtering
GET/research-sys/api/v1/entity-privacy-preferences/

Example URI

GET /research-sys/api/v1/entity-privacy-preferences/
URI Parameters
HideShow
entityId
string (optional) 
suppressName
string (optional) 
suppressEmail
string (optional) 
suppressAddress
string (optional) 
suppressPhone
string (optional) 
suppressPersonal
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "entityId": "(val)",
    "suppressName": "(val)",
    "suppressEmail": "(val)",
    "suppressAddress": "(val)",
    "suppressPhone": "(val)",
    "suppressPersonal": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "entityId": "(val)",
    "suppressName": "(val)",
    "suppressEmail": "(val)",
    "suppressAddress": "(val)",
    "suppressPhone": "(val)",
    "suppressPersonal": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Entity Privacy Preferences
GET/research-sys/api/v1/entity-privacy-preferences/

Example URI

GET /research-sys/api/v1/entity-privacy-preferences/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "entityId",
    "suppressName",
    "suppressEmail",
    "suppressAddress",
    "suppressPhone",
    "suppressPersonal"
  ],
  "primaryKey": "entityId"
}

Get Blueprint API specification for Entity Privacy Preferences
GET/research-sys/api/v1/entity-privacy-preferences/

Example URI

GET /research-sys/api/v1/entity-privacy-preferences/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Entity Privacy Preferences.md"
transfer-encoding: chunked

Update Entity Privacy Preferences
PUT/research-sys/api/v1/entity-privacy-preferences/(key)

Example URI

PUT /research-sys/api/v1/entity-privacy-preferences/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "entityId": "(val)",
  "suppressName": "(val)",
  "suppressEmail": "(val)",
  "suppressAddress": "(val)",
  "suppressPhone": "(val)",
  "suppressPersonal": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Entity Privacy Preferences
PUT/research-sys/api/v1/entity-privacy-preferences/

Example URI

PUT /research-sys/api/v1/entity-privacy-preferences/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "entityId": "(val)",
    "suppressName": "(val)",
    "suppressEmail": "(val)",
    "suppressAddress": "(val)",
    "suppressPhone": "(val)",
    "suppressPersonal": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "entityId": "(val)",
    "suppressName": "(val)",
    "suppressEmail": "(val)",
    "suppressAddress": "(val)",
    "suppressPhone": "(val)",
    "suppressPersonal": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Entity Privacy Preferences
PATCH/research-sys/api/v1/entity-privacy-preferences/(key)

Example URI

PATCH /research-sys/api/v1/entity-privacy-preferences/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "entityId": "(val)",
  "suppressName": "(val)",
  "suppressEmail": "(val)",
  "suppressAddress": "(val)",
  "suppressPhone": "(val)",
  "suppressPersonal": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "entityId": "(val)",
  "suppressName": "(val)",
  "suppressEmail": "(val)",
  "suppressAddress": "(val)",
  "suppressPhone": "(val)",
  "suppressPersonal": "(val)",
  "_primaryKey": "(val)"
}

Insert Entity Privacy Preferences
POST/research-sys/api/v1/entity-privacy-preferences/

Example URI

POST /research-sys/api/v1/entity-privacy-preferences/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "entityId": "(val)",
  "suppressName": "(val)",
  "suppressEmail": "(val)",
  "suppressAddress": "(val)",
  "suppressPhone": "(val)",
  "suppressPersonal": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "entityId": "(val)",
  "suppressName": "(val)",
  "suppressEmail": "(val)",
  "suppressAddress": "(val)",
  "suppressPhone": "(val)",
  "suppressPersonal": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Entity Privacy Preferences
POST/research-sys/api/v1/entity-privacy-preferences/

Example URI

POST /research-sys/api/v1/entity-privacy-preferences/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "entityId": "(val)",
    "suppressName": "(val)",
    "suppressEmail": "(val)",
    "suppressAddress": "(val)",
    "suppressPhone": "(val)",
    "suppressPersonal": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "entityId": "(val)",
    "suppressName": "(val)",
    "suppressEmail": "(val)",
    "suppressAddress": "(val)",
    "suppressPhone": "(val)",
    "suppressPersonal": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "entityId": "(val)",
    "suppressName": "(val)",
    "suppressEmail": "(val)",
    "suppressAddress": "(val)",
    "suppressPhone": "(val)",
    "suppressPersonal": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "entityId": "(val)",
    "suppressName": "(val)",
    "suppressEmail": "(val)",
    "suppressAddress": "(val)",
    "suppressPhone": "(val)",
    "suppressPersonal": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Entity Privacy Preferences by Key
DELETE/research-sys/api/v1/entity-privacy-preferences/(key)

Example URI

DELETE /research-sys/api/v1/entity-privacy-preferences/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Entity Privacy Preferences
DELETE/research-sys/api/v1/entity-privacy-preferences/

Example URI

DELETE /research-sys/api/v1/entity-privacy-preferences/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Entity Privacy Preferences with Matching
DELETE/research-sys/api/v1/entity-privacy-preferences/

Example URI

DELETE /research-sys/api/v1/entity-privacy-preferences/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

entityId
string (optional) 
suppressName
string (optional) 
suppressEmail
string (optional) 
suppressAddress
string (optional) 
suppressPhone
string (optional) 
suppressPersonal
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Entity Residencies

Get Entity Residencies by Key
GET/research-sys/api/v1/entity-residencies/(key)

Example URI

GET /research-sys/api/v1/entity-residencies/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "entityId": "(val)",
  "determinationMethod": "(val)",
  "inState": "(val)",
  "_primaryKey": "(val)"
}

Get All Entity Residencies
GET/research-sys/api/v1/entity-residencies/

Example URI

GET /research-sys/api/v1/entity-residencies/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "entityId": "(val)",
    "determinationMethod": "(val)",
    "inState": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "entityId": "(val)",
    "determinationMethod": "(val)",
    "inState": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Entity Residencies with Filtering
GET/research-sys/api/v1/entity-residencies/

Example URI

GET /research-sys/api/v1/entity-residencies/
URI Parameters
HideShow
id
string (optional) 
entityId
string (optional) 
determinationMethod
string (optional) 
inState
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "entityId": "(val)",
    "determinationMethod": "(val)",
    "inState": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "entityId": "(val)",
    "determinationMethod": "(val)",
    "inState": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Entity Residencies
GET/research-sys/api/v1/entity-residencies/

Example URI

GET /research-sys/api/v1/entity-residencies/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "entityId",
    "determinationMethod",
    "inState"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Entity Residencies
GET/research-sys/api/v1/entity-residencies/

Example URI

GET /research-sys/api/v1/entity-residencies/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Entity Residencies.md"
transfer-encoding: chunked

Update Entity Residencies
PUT/research-sys/api/v1/entity-residencies/(key)

Example URI

PUT /research-sys/api/v1/entity-residencies/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "entityId": "(val)",
  "determinationMethod": "(val)",
  "inState": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Entity Residencies
PUT/research-sys/api/v1/entity-residencies/

Example URI

PUT /research-sys/api/v1/entity-residencies/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "entityId": "(val)",
    "determinationMethod": "(val)",
    "inState": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "entityId": "(val)",
    "determinationMethod": "(val)",
    "inState": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Entity Residencies
PATCH/research-sys/api/v1/entity-residencies/(key)

Example URI

PATCH /research-sys/api/v1/entity-residencies/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "entityId": "(val)",
  "determinationMethod": "(val)",
  "inState": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "entityId": "(val)",
  "determinationMethod": "(val)",
  "inState": "(val)",
  "_primaryKey": "(val)"
}

Insert Entity Residencies
POST/research-sys/api/v1/entity-residencies/

Example URI

POST /research-sys/api/v1/entity-residencies/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "entityId": "(val)",
  "determinationMethod": "(val)",
  "inState": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "entityId": "(val)",
  "determinationMethod": "(val)",
  "inState": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Entity Residencies
POST/research-sys/api/v1/entity-residencies/

Example URI

POST /research-sys/api/v1/entity-residencies/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "entityId": "(val)",
    "determinationMethod": "(val)",
    "inState": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "entityId": "(val)",
    "determinationMethod": "(val)",
    "inState": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "entityId": "(val)",
    "determinationMethod": "(val)",
    "inState": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "entityId": "(val)",
    "determinationMethod": "(val)",
    "inState": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Entity Residencies by Key
DELETE/research-sys/api/v1/entity-residencies/(key)

Example URI

DELETE /research-sys/api/v1/entity-residencies/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Entity Residencies
DELETE/research-sys/api/v1/entity-residencies/

Example URI

DELETE /research-sys/api/v1/entity-residencies/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Entity Residencies with Matching
DELETE/research-sys/api/v1/entity-residencies/

Example URI

DELETE /research-sys/api/v1/entity-residencies/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 
entityId
string (optional) 
determinationMethod
string (optional) 
inState
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Entity Residency Statuses

Get Entity Residency Statuses by Key
GET/research-sys/api/v1/entity-residency-statuses/(key)

Example URI

GET /research-sys/api/v1/entity-residency-statuses/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}

Get All Entity Residency Statuses
GET/research-sys/api/v1/entity-residency-statuses/

Example URI

GET /research-sys/api/v1/entity-residency-statuses/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Entity Residency Statuses with Filtering
GET/research-sys/api/v1/entity-residency-statuses/

Example URI

GET /research-sys/api/v1/entity-residency-statuses/
URI Parameters
HideShow
name
string (optional) 
active
string (optional) 
code
string (optional) 
sortCode
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Entity Residency Statuses
GET/research-sys/api/v1/entity-residency-statuses/

Example URI

GET /research-sys/api/v1/entity-residency-statuses/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "name",
    "active",
    "code",
    "sortCode"
  ],
  "primaryKey": "code"
}

Get Blueprint API specification for Entity Residency Statuses
GET/research-sys/api/v1/entity-residency-statuses/

Example URI

GET /research-sys/api/v1/entity-residency-statuses/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Entity Residency Statuses.md"
transfer-encoding: chunked

Update Entity Residency Statuses
PUT/research-sys/api/v1/entity-residency-statuses/(key)

Example URI

PUT /research-sys/api/v1/entity-residency-statuses/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Entity Residency Statuses
PUT/research-sys/api/v1/entity-residency-statuses/

Example URI

PUT /research-sys/api/v1/entity-residency-statuses/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Entity Residency Statuses
PATCH/research-sys/api/v1/entity-residency-statuses/(key)

Example URI

PATCH /research-sys/api/v1/entity-residency-statuses/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Entity Residency Statuses
POST/research-sys/api/v1/entity-residency-statuses/

Example URI

POST /research-sys/api/v1/entity-residency-statuses/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Entity Residency Statuses
POST/research-sys/api/v1/entity-residency-statuses/

Example URI

POST /research-sys/api/v1/entity-residency-statuses/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Entity Residency Statuses by Key
DELETE/research-sys/api/v1/entity-residency-statuses/(key)

Example URI

DELETE /research-sys/api/v1/entity-residency-statuses/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Entity Residency Statuses
DELETE/research-sys/api/v1/entity-residency-statuses/

Example URI

DELETE /research-sys/api/v1/entity-residency-statuses/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Entity Residency Statuses with Matching
DELETE/research-sys/api/v1/entity-residency-statuses/

Example URI

DELETE /research-sys/api/v1/entity-residency-statuses/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

name
string (optional) 
active
string (optional) 
code
string (optional) 
sortCode
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Entity Residency Types

Get Entity Residency Types by Key
GET/research-sys/api/v1/entity-residency-types/(key)

Example URI

GET /research-sys/api/v1/entity-residency-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}

Get All Entity Residency Types
GET/research-sys/api/v1/entity-residency-types/

Example URI

GET /research-sys/api/v1/entity-residency-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Entity Residency Types with Filtering
GET/research-sys/api/v1/entity-residency-types/

Example URI

GET /research-sys/api/v1/entity-residency-types/
URI Parameters
HideShow
name
string (optional) 
active
string (optional) 
code
string (optional) 
sortCode
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Entity Residency Types
GET/research-sys/api/v1/entity-residency-types/

Example URI

GET /research-sys/api/v1/entity-residency-types/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "name",
    "active",
    "code",
    "sortCode"
  ],
  "primaryKey": "code"
}

Get Blueprint API specification for Entity Residency Types
GET/research-sys/api/v1/entity-residency-types/

Example URI

GET /research-sys/api/v1/entity-residency-types/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Entity Residency Types.md"
transfer-encoding: chunked

Update Entity Residency Types
PUT/research-sys/api/v1/entity-residency-types/(key)

Example URI

PUT /research-sys/api/v1/entity-residency-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Entity Residency Types
PUT/research-sys/api/v1/entity-residency-types/

Example URI

PUT /research-sys/api/v1/entity-residency-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Entity Residency Types
PATCH/research-sys/api/v1/entity-residency-types/(key)

Example URI

PATCH /research-sys/api/v1/entity-residency-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Entity Residency Types
POST/research-sys/api/v1/entity-residency-types/

Example URI

POST /research-sys/api/v1/entity-residency-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "name": "(val)",
  "active": "(val)",
  "code": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Entity Residency Types
POST/research-sys/api/v1/entity-residency-types/

Example URI

POST /research-sys/api/v1/entity-residency-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "name": "(val)",
    "active": "(val)",
    "code": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Entity Residency Types by Key
DELETE/research-sys/api/v1/entity-residency-types/(key)

Example URI

DELETE /research-sys/api/v1/entity-residency-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Entity Residency Types
DELETE/research-sys/api/v1/entity-residency-types/

Example URI

DELETE /research-sys/api/v1/entity-residency-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Entity Residency Types with Matching
DELETE/research-sys/api/v1/entity-residency-types/

Example URI

DELETE /research-sys/api/v1/entity-residency-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

name
string (optional) 
active
string (optional) 
code
string (optional) 
sortCode
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Entity Type Contact Infos

Get Entity Type Contact Infos by Key
GET/research-sys/api/v1/entity-type-contact-infos/(key)

Example URI

GET /research-sys/api/v1/entity-type-contact-infos/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "entityId": "(val)",
  "entityTypeCode": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Get All Entity Type Contact Infos
GET/research-sys/api/v1/entity-type-contact-infos/

Example URI

GET /research-sys/api/v1/entity-type-contact-infos/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "entityId": "(val)",
    "entityTypeCode": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "entityId": "(val)",
    "entityTypeCode": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Entity Type Contact Infos with Filtering
GET/research-sys/api/v1/entity-type-contact-infos/

Example URI

GET /research-sys/api/v1/entity-type-contact-infos/
URI Parameters
HideShow
entityId
string (optional) 
entityTypeCode
string (optional) 
active
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "entityId": "(val)",
    "entityTypeCode": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "entityId": "(val)",
    "entityTypeCode": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Entity Type Contact Infos
GET/research-sys/api/v1/entity-type-contact-infos/

Example URI

GET /research-sys/api/v1/entity-type-contact-infos/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "entityId",
    "entityTypeCode",
    "active"
  ],
  "primaryKey": "entityId:entityTypeCode"
}

Get Blueprint API specification for Entity Type Contact Infos
GET/research-sys/api/v1/entity-type-contact-infos/

Example URI

GET /research-sys/api/v1/entity-type-contact-infos/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Entity Type Contact Infos.md"
transfer-encoding: chunked

Update Entity Type Contact Infos
PUT/research-sys/api/v1/entity-type-contact-infos/(key)

Example URI

PUT /research-sys/api/v1/entity-type-contact-infos/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "entityId": "(val)",
  "entityTypeCode": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Entity Type Contact Infos
PUT/research-sys/api/v1/entity-type-contact-infos/

Example URI

PUT /research-sys/api/v1/entity-type-contact-infos/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "entityId": "(val)",
    "entityTypeCode": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "entityId": "(val)",
    "entityTypeCode": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Entity Type Contact Infos
PATCH/research-sys/api/v1/entity-type-contact-infos/(key)

Example URI

PATCH /research-sys/api/v1/entity-type-contact-infos/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "entityId": "(val)",
  "entityTypeCode": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "entityId": "(val)",
  "entityTypeCode": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Entity Type Contact Infos
POST/research-sys/api/v1/entity-type-contact-infos/

Example URI

POST /research-sys/api/v1/entity-type-contact-infos/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "entityId": "(val)",
  "entityTypeCode": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "entityId": "(val)",
  "entityTypeCode": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Entity Type Contact Infos
POST/research-sys/api/v1/entity-type-contact-infos/

Example URI

POST /research-sys/api/v1/entity-type-contact-infos/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "entityId": "(val)",
    "entityTypeCode": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "entityId": "(val)",
    "entityTypeCode": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "entityId": "(val)",
    "entityTypeCode": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "entityId": "(val)",
    "entityTypeCode": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Entity Type Contact Infos by Key
DELETE/research-sys/api/v1/entity-type-contact-infos/(key)

Example URI

DELETE /research-sys/api/v1/entity-type-contact-infos/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Entity Type Contact Infos
DELETE/research-sys/api/v1/entity-type-contact-infos/

Example URI

DELETE /research-sys/api/v1/entity-type-contact-infos/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Entity Type Contact Infos with Matching
DELETE/research-sys/api/v1/entity-type-contact-infos/

Example URI

DELETE /research-sys/api/v1/entity-type-contact-infos/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

entityId
string (optional) 
entityTypeCode
string (optional) 
active
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Entity Types

Get Entity Types by Key
GET/research-sys/api/v1/entity-types/(key)

Example URI

GET /research-sys/api/v1/entity-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "code": "(val)",
  "name": "(val)",
  "active": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}

Get All Entity Types
GET/research-sys/api/v1/entity-types/

Example URI

GET /research-sys/api/v1/entity-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Entity Types with Filtering
GET/research-sys/api/v1/entity-types/

Example URI

GET /research-sys/api/v1/entity-types/
URI Parameters
HideShow
code
string (optional) 

The entity type code. Maximum length is 2.

name
string (optional) 

Descriptive text. Maximum length is 10.

active
string (optional) 

This attribute is used to describe whether the associated object is active or inactive. Maximum length is 1.

sortCode
string (optional) 

Descriptive text. Maximum length is 10.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Entity Types
GET/research-sys/api/v1/entity-types/

Example URI

GET /research-sys/api/v1/entity-types/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "code",
    "name",
    "active",
    "sortCode"
  ],
  "primaryKey": "code"
}

Get Blueprint API specification for Entity Types
GET/research-sys/api/v1/entity-types/

Example URI

GET /research-sys/api/v1/entity-types/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Entity Types.md"
transfer-encoding: chunked

Update Entity Types
PUT/research-sys/api/v1/entity-types/(key)

Example URI

PUT /research-sys/api/v1/entity-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "code": "(val)",
  "name": "(val)",
  "active": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Entity Types
PUT/research-sys/api/v1/entity-types/

Example URI

PUT /research-sys/api/v1/entity-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Entity Types
PATCH/research-sys/api/v1/entity-types/(key)

Example URI

PATCH /research-sys/api/v1/entity-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "code": "(val)",
  "name": "(val)",
  "active": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "code": "(val)",
  "name": "(val)",
  "active": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Entity Types
POST/research-sys/api/v1/entity-types/

Example URI

POST /research-sys/api/v1/entity-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "code": "(val)",
  "name": "(val)",
  "active": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "code": "(val)",
  "name": "(val)",
  "active": "(val)",
  "sortCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Entity Types
POST/research-sys/api/v1/entity-types/

Example URI

POST /research-sys/api/v1/entity-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "sortCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Entity Types by Key
DELETE/research-sys/api/v1/entity-types/(key)

Example URI

DELETE /research-sys/api/v1/entity-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Entity Types
DELETE/research-sys/api/v1/entity-types/

Example URI

DELETE /research-sys/api/v1/entity-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Entity Types with Matching
DELETE/research-sys/api/v1/entity-types/

Example URI

DELETE /research-sys/api/v1/entity-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

code
string (optional) 

The entity type code. Maximum length is 2.

name
string (optional) 

Descriptive text. Maximum length is 10.

active
string (optional) 

This attribute is used to describe whether the associated object is active or inactive. Maximum length is 1.

sortCode
string (optional) 

Descriptive text. Maximum length is 10.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Entity Visas

Get Entity Visas by Key
GET/research-sys/api/v1/entity-visas/(key)

Example URI

GET /research-sys/api/v1/entity-visas/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "entityId": "(val)",
  "visaTypeKey": "(val)",
  "visaEntry": "(val)",
  "visaId": "(val)",
  "_primaryKey": "(val)"
}

Get All Entity Visas
GET/research-sys/api/v1/entity-visas/

Example URI

GET /research-sys/api/v1/entity-visas/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "entityId": "(val)",
    "visaTypeKey": "(val)",
    "visaEntry": "(val)",
    "visaId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "entityId": "(val)",
    "visaTypeKey": "(val)",
    "visaEntry": "(val)",
    "visaId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Entity Visas with Filtering
GET/research-sys/api/v1/entity-visas/

Example URI

GET /research-sys/api/v1/entity-visas/
URI Parameters
HideShow
id
string (optional) 
entityId
string (optional) 
visaTypeKey
string (optional) 
visaEntry
string (optional) 
visaId
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "entityId": "(val)",
    "visaTypeKey": "(val)",
    "visaEntry": "(val)",
    "visaId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "entityId": "(val)",
    "visaTypeKey": "(val)",
    "visaEntry": "(val)",
    "visaId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Entity Visas
GET/research-sys/api/v1/entity-visas/

Example URI

GET /research-sys/api/v1/entity-visas/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "entityId",
    "visaTypeKey",
    "visaEntry",
    "visaId"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Entity Visas
GET/research-sys/api/v1/entity-visas/

Example URI

GET /research-sys/api/v1/entity-visas/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Entity Visas.md"
transfer-encoding: chunked

Update Entity Visas
PUT/research-sys/api/v1/entity-visas/(key)

Example URI

PUT /research-sys/api/v1/entity-visas/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "entityId": "(val)",
  "visaTypeKey": "(val)",
  "visaEntry": "(val)",
  "visaId": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Entity Visas
PUT/research-sys/api/v1/entity-visas/

Example URI

PUT /research-sys/api/v1/entity-visas/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "entityId": "(val)",
    "visaTypeKey": "(val)",
    "visaEntry": "(val)",
    "visaId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "entityId": "(val)",
    "visaTypeKey": "(val)",
    "visaEntry": "(val)",
    "visaId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Entity Visas
PATCH/research-sys/api/v1/entity-visas/(key)

Example URI

PATCH /research-sys/api/v1/entity-visas/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "entityId": "(val)",
  "visaTypeKey": "(val)",
  "visaEntry": "(val)",
  "visaId": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "entityId": "(val)",
  "visaTypeKey": "(val)",
  "visaEntry": "(val)",
  "visaId": "(val)",
  "_primaryKey": "(val)"
}

Insert Entity Visas
POST/research-sys/api/v1/entity-visas/

Example URI

POST /research-sys/api/v1/entity-visas/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "entityId": "(val)",
  "visaTypeKey": "(val)",
  "visaEntry": "(val)",
  "visaId": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "entityId": "(val)",
  "visaTypeKey": "(val)",
  "visaEntry": "(val)",
  "visaId": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Entity Visas
POST/research-sys/api/v1/entity-visas/

Example URI

POST /research-sys/api/v1/entity-visas/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "entityId": "(val)",
    "visaTypeKey": "(val)",
    "visaEntry": "(val)",
    "visaId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "entityId": "(val)",
    "visaTypeKey": "(val)",
    "visaEntry": "(val)",
    "visaId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "entityId": "(val)",
    "visaTypeKey": "(val)",
    "visaEntry": "(val)",
    "visaId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "entityId": "(val)",
    "visaTypeKey": "(val)",
    "visaEntry": "(val)",
    "visaId": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Entity Visas by Key
DELETE/research-sys/api/v1/entity-visas/(key)

Example URI

DELETE /research-sys/api/v1/entity-visas/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Entity Visas
DELETE/research-sys/api/v1/entity-visas/

Example URI

DELETE /research-sys/api/v1/entity-visas/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Entity Visas with Matching
DELETE/research-sys/api/v1/entity-visas/

Example URI

DELETE /research-sys/api/v1/entity-visas/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 
entityId
string (optional) 
visaTypeKey
string (optional) 
visaEntry
string (optional) 
visaId
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Function Parameters

Get Function Parameters by Key
GET/research-sys/api/v1/function-parameters/(key)

Example URI

GET /research-sys/api/v1/function-parameters/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "name": "(val)",
  "description": "(val)",
  "parameterType": "(val)",
  "sequenceNumber": "(val)",
  "_primaryKey": "(val)"
}

Get All Function Parameters
GET/research-sys/api/v1/function-parameters/

Example URI

GET /research-sys/api/v1/function-parameters/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "parameterType": "(val)",
    "sequenceNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "parameterType": "(val)",
    "sequenceNumber": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Function Parameters with Filtering
GET/research-sys/api/v1/function-parameters/

Example URI

GET /research-sys/api/v1/function-parameters/
URI Parameters
HideShow
id
string (optional) 
name
string (optional) 
description
string (optional) 
parameterType
string (optional) 
sequenceNumber
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "parameterType": "(val)",
    "sequenceNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "parameterType": "(val)",
    "sequenceNumber": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Function Parameters
GET/research-sys/api/v1/function-parameters/

Example URI

GET /research-sys/api/v1/function-parameters/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "name",
    "description",
    "parameterType",
    "sequenceNumber"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Function Parameters
GET/research-sys/api/v1/function-parameters/

Example URI

GET /research-sys/api/v1/function-parameters/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Function Parameters.md"
transfer-encoding: chunked

Update Function Parameters
PUT/research-sys/api/v1/function-parameters/(key)

Example URI

PUT /research-sys/api/v1/function-parameters/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "name": "(val)",
  "description": "(val)",
  "parameterType": "(val)",
  "sequenceNumber": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Function Parameters
PUT/research-sys/api/v1/function-parameters/

Example URI

PUT /research-sys/api/v1/function-parameters/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "parameterType": "(val)",
    "sequenceNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "parameterType": "(val)",
    "sequenceNumber": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Function Parameters
PATCH/research-sys/api/v1/function-parameters/(key)

Example URI

PATCH /research-sys/api/v1/function-parameters/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "name": "(val)",
  "description": "(val)",
  "parameterType": "(val)",
  "sequenceNumber": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "name": "(val)",
  "description": "(val)",
  "parameterType": "(val)",
  "sequenceNumber": "(val)",
  "_primaryKey": "(val)"
}

Insert Function Parameters
POST/research-sys/api/v1/function-parameters/

Example URI

POST /research-sys/api/v1/function-parameters/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "name": "(val)",
  "description": "(val)",
  "parameterType": "(val)",
  "sequenceNumber": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "name": "(val)",
  "description": "(val)",
  "parameterType": "(val)",
  "sequenceNumber": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Function Parameters
POST/research-sys/api/v1/function-parameters/

Example URI

POST /research-sys/api/v1/function-parameters/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "parameterType": "(val)",
    "sequenceNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "parameterType": "(val)",
    "sequenceNumber": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "parameterType": "(val)",
    "sequenceNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "parameterType": "(val)",
    "sequenceNumber": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Function Parameters by Key
DELETE/research-sys/api/v1/function-parameters/(key)

Example URI

DELETE /research-sys/api/v1/function-parameters/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Function Parameters
DELETE/research-sys/api/v1/function-parameters/

Example URI

DELETE /research-sys/api/v1/function-parameters/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Function Parameters with Matching
DELETE/research-sys/api/v1/function-parameters/

Example URI

DELETE /research-sys/api/v1/function-parameters/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 
name
string (optional) 
description
string (optional) 
parameterType
string (optional) 
sequenceNumber
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Functions

Get Functions by Key
GET/research-sys/api/v1/functions/(key)

Example URI

GET /research-sys/api/v1/functions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "namespace": "(val)",
  "name": "(val)",
  "description": "(val)",
  "returnType": "(val)",
  "typeId": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Get All Functions
GET/research-sys/api/v1/functions/

Example URI

GET /research-sys/api/v1/functions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "namespace": "(val)",
    "name": "(val)",
    "description": "(val)",
    "returnType": "(val)",
    "typeId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "namespace": "(val)",
    "name": "(val)",
    "description": "(val)",
    "returnType": "(val)",
    "typeId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Functions with Filtering
GET/research-sys/api/v1/functions/

Example URI

GET /research-sys/api/v1/functions/
URI Parameters
HideShow
id
string (optional) 
namespace
string (optional) 
name
string (optional) 
description
string (optional) 
returnType
string (optional) 
typeId
string (optional) 
active
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "namespace": "(val)",
    "name": "(val)",
    "description": "(val)",
    "returnType": "(val)",
    "typeId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "namespace": "(val)",
    "name": "(val)",
    "description": "(val)",
    "returnType": "(val)",
    "typeId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Functions
GET/research-sys/api/v1/functions/

Example URI

GET /research-sys/api/v1/functions/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "namespace",
    "name",
    "description",
    "returnType",
    "typeId",
    "active"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Functions
GET/research-sys/api/v1/functions/

Example URI

GET /research-sys/api/v1/functions/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Functions.md"
transfer-encoding: chunked

Update Functions
PUT/research-sys/api/v1/functions/(key)

Example URI

PUT /research-sys/api/v1/functions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "namespace": "(val)",
  "name": "(val)",
  "description": "(val)",
  "returnType": "(val)",
  "typeId": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Functions
PUT/research-sys/api/v1/functions/

Example URI

PUT /research-sys/api/v1/functions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "namespace": "(val)",
    "name": "(val)",
    "description": "(val)",
    "returnType": "(val)",
    "typeId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "namespace": "(val)",
    "name": "(val)",
    "description": "(val)",
    "returnType": "(val)",
    "typeId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Functions
PATCH/research-sys/api/v1/functions/(key)

Example URI

PATCH /research-sys/api/v1/functions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "namespace": "(val)",
  "name": "(val)",
  "description": "(val)",
  "returnType": "(val)",
  "typeId": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "namespace": "(val)",
  "name": "(val)",
  "description": "(val)",
  "returnType": "(val)",
  "typeId": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Functions
POST/research-sys/api/v1/functions/

Example URI

POST /research-sys/api/v1/functions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "namespace": "(val)",
  "name": "(val)",
  "description": "(val)",
  "returnType": "(val)",
  "typeId": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "namespace": "(val)",
  "name": "(val)",
  "description": "(val)",
  "returnType": "(val)",
  "typeId": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Functions
POST/research-sys/api/v1/functions/

Example URI

POST /research-sys/api/v1/functions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "namespace": "(val)",
    "name": "(val)",
    "description": "(val)",
    "returnType": "(val)",
    "typeId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "namespace": "(val)",
    "name": "(val)",
    "description": "(val)",
    "returnType": "(val)",
    "typeId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "namespace": "(val)",
    "name": "(val)",
    "description": "(val)",
    "returnType": "(val)",
    "typeId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "namespace": "(val)",
    "name": "(val)",
    "description": "(val)",
    "returnType": "(val)",
    "typeId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Functions by Key
DELETE/research-sys/api/v1/functions/(key)

Example URI

DELETE /research-sys/api/v1/functions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Functions
DELETE/research-sys/api/v1/functions/

Example URI

DELETE /research-sys/api/v1/functions/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Functions with Matching
DELETE/research-sys/api/v1/functions/

Example URI

DELETE /research-sys/api/v1/functions/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 
namespace
string (optional) 
name
string (optional) 
description
string (optional) 
returnType
string (optional) 
typeId
string (optional) 
active
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Generic Permissions

Get Generic Permissions by Key
GET/research-sys/api/v1/generic-permissions/(key)

Example URI

GET /research-sys/api/v1/generic-permissions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "namespaceCode": "(val)",
  "name": "(val)",
  "description": "(val)",
  "active": "(val)",
  "templateId": "(val)",
  "detailValues": "(val)",
  "details": "(val)",
  "_primaryKey": "(val)"
}

Get All Generic Permissions
GET/research-sys/api/v1/generic-permissions/

Example URI

GET /research-sys/api/v1/generic-permissions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "namespaceCode": "(val)",
    "name": "(val)",
    "description": "(val)",
    "active": "(val)",
    "templateId": "(val)",
    "detailValues": "(val)",
    "details": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "namespaceCode": "(val)",
    "name": "(val)",
    "description": "(val)",
    "active": "(val)",
    "templateId": "(val)",
    "detailValues": "(val)",
    "details": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Generic Permissions with Filtering
GET/research-sys/api/v1/generic-permissions/

Example URI

GET /research-sys/api/v1/generic-permissions/
URI Parameters
HideShow
id
string (optional) 

Permission Identifier. Maximum length is 40.

namespaceCode
string (optional) 

This value is used to categorize parameters by namespace. Maximum length is 20.

name
string (optional) 

Nm. Maximum length is 100.

description
string (optional) 

Permission Description. Maximum length is 400.

active
string (optional) 

This attribute is used to describe whether the associated object is active or inactive. Maximum length is 1.

templateId
string (optional) 

Template.

detailValues
string (optional) 

This attribute should always be overriden on the descriptive elements. Maximum length is 400.

details
string (optional) 

Details.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "namespaceCode": "(val)",
    "name": "(val)",
    "description": "(val)",
    "active": "(val)",
    "templateId": "(val)",
    "detailValues": "(val)",
    "details": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "namespaceCode": "(val)",
    "name": "(val)",
    "description": "(val)",
    "active": "(val)",
    "templateId": "(val)",
    "detailValues": "(val)",
    "details": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Generic Permissions
GET/research-sys/api/v1/generic-permissions/

Example URI

GET /research-sys/api/v1/generic-permissions/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "namespaceCode",
    "name",
    "description",
    "active",
    "templateId",
    "detailValues",
    "details"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Generic Permissions
GET/research-sys/api/v1/generic-permissions/

Example URI

GET /research-sys/api/v1/generic-permissions/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Generic Permissions.md"
transfer-encoding: chunked

Update Generic Permissions
PUT/research-sys/api/v1/generic-permissions/(key)

Example URI

PUT /research-sys/api/v1/generic-permissions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "namespaceCode": "(val)",
  "name": "(val)",
  "description": "(val)",
  "active": "(val)",
  "templateId": "(val)",
  "detailValues": "(val)",
  "details": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Generic Permissions
PUT/research-sys/api/v1/generic-permissions/

Example URI

PUT /research-sys/api/v1/generic-permissions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "namespaceCode": "(val)",
    "name": "(val)",
    "description": "(val)",
    "active": "(val)",
    "templateId": "(val)",
    "detailValues": "(val)",
    "details": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "namespaceCode": "(val)",
    "name": "(val)",
    "description": "(val)",
    "active": "(val)",
    "templateId": "(val)",
    "detailValues": "(val)",
    "details": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Generic Permissions
PATCH/research-sys/api/v1/generic-permissions/(key)

Example URI

PATCH /research-sys/api/v1/generic-permissions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "namespaceCode": "(val)",
  "name": "(val)",
  "description": "(val)",
  "active": "(val)",
  "templateId": "(val)",
  "detailValues": "(val)",
  "details": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "namespaceCode": "(val)",
  "name": "(val)",
  "description": "(val)",
  "active": "(val)",
  "templateId": "(val)",
  "detailValues": "(val)",
  "details": "(val)",
  "_primaryKey": "(val)"
}

Insert Generic Permissions
POST/research-sys/api/v1/generic-permissions/

Example URI

POST /research-sys/api/v1/generic-permissions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "namespaceCode": "(val)",
  "name": "(val)",
  "description": "(val)",
  "active": "(val)",
  "templateId": "(val)",
  "detailValues": "(val)",
  "details": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "namespaceCode": "(val)",
  "name": "(val)",
  "description": "(val)",
  "active": "(val)",
  "templateId": "(val)",
  "detailValues": "(val)",
  "details": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Generic Permissions
POST/research-sys/api/v1/generic-permissions/

Example URI

POST /research-sys/api/v1/generic-permissions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "namespaceCode": "(val)",
    "name": "(val)",
    "description": "(val)",
    "active": "(val)",
    "templateId": "(val)",
    "detailValues": "(val)",
    "details": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "namespaceCode": "(val)",
    "name": "(val)",
    "description": "(val)",
    "active": "(val)",
    "templateId": "(val)",
    "detailValues": "(val)",
    "details": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "namespaceCode": "(val)",
    "name": "(val)",
    "description": "(val)",
    "active": "(val)",
    "templateId": "(val)",
    "detailValues": "(val)",
    "details": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "namespaceCode": "(val)",
    "name": "(val)",
    "description": "(val)",
    "active": "(val)",
    "templateId": "(val)",
    "detailValues": "(val)",
    "details": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Generic Permissions by Key
DELETE/research-sys/api/v1/generic-permissions/(key)

Example URI

DELETE /research-sys/api/v1/generic-permissions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Generic Permissions
DELETE/research-sys/api/v1/generic-permissions/

Example URI

DELETE /research-sys/api/v1/generic-permissions/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Generic Permissions with Matching
DELETE/research-sys/api/v1/generic-permissions/

Example URI

DELETE /research-sys/api/v1/generic-permissions/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 

Permission Identifier. Maximum length is 40.

namespaceCode
string (optional) 

This value is used to categorize parameters by namespace. Maximum length is 20.

name
string (optional) 

Nm. Maximum length is 100.

description
string (optional) 

Permission Description. Maximum length is 400.

active
string (optional) 

This attribute is used to describe whether the associated object is active or inactive. Maximum length is 1.

templateId
string (optional) 

Template.

detailValues
string (optional) 

This attribute should always be overriden on the descriptive elements. Maximum length is 400.

details
string (optional) 

Details.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Group Attributes

Get Group Attributes by Key
GET/research-sys/api/v1/group-attributes/(key)

Example URI

GET /research-sys/api/v1/group-attributes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "assignedToId": "(val)",
  "attributeValue": "(val)",
  "kimTypeId": "(val)",
  "kimAttributeId": "(val)",
  "_primaryKey": "(val)"
}

Get All Group Attributes
GET/research-sys/api/v1/group-attributes/

Example URI

GET /research-sys/api/v1/group-attributes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "assignedToId": "(val)",
    "attributeValue": "(val)",
    "kimTypeId": "(val)",
    "kimAttributeId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "assignedToId": "(val)",
    "attributeValue": "(val)",
    "kimTypeId": "(val)",
    "kimAttributeId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Group Attributes with Filtering
GET/research-sys/api/v1/group-attributes/

Example URI

GET /research-sys/api/v1/group-attributes/
URI Parameters
HideShow
id
string (optional) 
assignedToId
string (optional) 
attributeValue
string (optional) 
kimTypeId
string (optional) 
kimAttributeId
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "assignedToId": "(val)",
    "attributeValue": "(val)",
    "kimTypeId": "(val)",
    "kimAttributeId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "assignedToId": "(val)",
    "attributeValue": "(val)",
    "kimTypeId": "(val)",
    "kimAttributeId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Group Attributes
GET/research-sys/api/v1/group-attributes/

Example URI

GET /research-sys/api/v1/group-attributes/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "assignedToId",
    "attributeValue",
    "kimTypeId",
    "kimAttributeId"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Group Attributes
GET/research-sys/api/v1/group-attributes/

Example URI

GET /research-sys/api/v1/group-attributes/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Group Attributes.md"
transfer-encoding: chunked

Update Group Attributes
PUT/research-sys/api/v1/group-attributes/(key)

Example URI

PUT /research-sys/api/v1/group-attributes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "assignedToId": "(val)",
  "attributeValue": "(val)",
  "kimTypeId": "(val)",
  "kimAttributeId": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Group Attributes
PUT/research-sys/api/v1/group-attributes/

Example URI

PUT /research-sys/api/v1/group-attributes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "assignedToId": "(val)",
    "attributeValue": "(val)",
    "kimTypeId": "(val)",
    "kimAttributeId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "assignedToId": "(val)",
    "attributeValue": "(val)",
    "kimTypeId": "(val)",
    "kimAttributeId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Group Attributes
PATCH/research-sys/api/v1/group-attributes/(key)

Example URI

PATCH /research-sys/api/v1/group-attributes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "assignedToId": "(val)",
  "attributeValue": "(val)",
  "kimTypeId": "(val)",
  "kimAttributeId": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "assignedToId": "(val)",
  "attributeValue": "(val)",
  "kimTypeId": "(val)",
  "kimAttributeId": "(val)",
  "_primaryKey": "(val)"
}

Insert Group Attributes
POST/research-sys/api/v1/group-attributes/

Example URI

POST /research-sys/api/v1/group-attributes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "assignedToId": "(val)",
  "attributeValue": "(val)",
  "kimTypeId": "(val)",
  "kimAttributeId": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "assignedToId": "(val)",
  "attributeValue": "(val)",
  "kimTypeId": "(val)",
  "kimAttributeId": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Group Attributes
POST/research-sys/api/v1/group-attributes/

Example URI

POST /research-sys/api/v1/group-attributes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "assignedToId": "(val)",
    "attributeValue": "(val)",
    "kimTypeId": "(val)",
    "kimAttributeId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "assignedToId": "(val)",
    "attributeValue": "(val)",
    "kimTypeId": "(val)",
    "kimAttributeId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "assignedToId": "(val)",
    "attributeValue": "(val)",
    "kimTypeId": "(val)",
    "kimAttributeId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "assignedToId": "(val)",
    "attributeValue": "(val)",
    "kimTypeId": "(val)",
    "kimAttributeId": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Group Attributes by Key
DELETE/research-sys/api/v1/group-attributes/(key)

Example URI

DELETE /research-sys/api/v1/group-attributes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Group Attributes
DELETE/research-sys/api/v1/group-attributes/

Example URI

DELETE /research-sys/api/v1/group-attributes/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Group Attributes with Matching
DELETE/research-sys/api/v1/group-attributes/

Example URI

DELETE /research-sys/api/v1/group-attributes/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 
assignedToId
string (optional) 
attributeValue
string (optional) 
kimTypeId
string (optional) 
kimAttributeId
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Group Document Members

Get Group Document Members by Key
GET/research-sys/api/v1/group-document-members/(key)

Example URI

GET /research-sys/api/v1/group-document-members/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "groupMemberId": "(val)",
  "groupId": "(val)",
  "memberId": "(val)",
  "memberName": "(val)",
  "memberTypeCode": "(val)",
  "activeFromDate": "(val)",
  "activeToDate": "(val)",
  "documentNumber": "(val)",
  "_primaryKey": "(val)"
}

Get All Group Document Members
GET/research-sys/api/v1/group-document-members/

Example URI

GET /research-sys/api/v1/group-document-members/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "groupMemberId": "(val)",
    "groupId": "(val)",
    "memberId": "(val)",
    "memberName": "(val)",
    "memberTypeCode": "(val)",
    "activeFromDate": "(val)",
    "activeToDate": "(val)",
    "documentNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "groupMemberId": "(val)",
    "groupId": "(val)",
    "memberId": "(val)",
    "memberName": "(val)",
    "memberTypeCode": "(val)",
    "activeFromDate": "(val)",
    "activeToDate": "(val)",
    "documentNumber": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Group Document Members with Filtering
GET/research-sys/api/v1/group-document-members/

Example URI

GET /research-sys/api/v1/group-document-members/
URI Parameters
HideShow
groupMemberId
string (optional) 

Group Member Identifier. Maximum length is 40.

groupId
string (optional) 

Group Id.

memberId
string (optional) 

Member Identifier. Maximum length is 40.

memberName
string (optional) 

Member Name. Maximum length is 80.

memberTypeCode
string (optional) 

Member Type Code. Maximum length is 40.

activeFromDate
string (optional) 

Start Date. Maximum length is 21.

activeToDate
string (optional) 

End Date. Maximum length is 21.

documentNumber
string (optional) 

Document Number.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "groupMemberId": "(val)",
    "groupId": "(val)",
    "memberId": "(val)",
    "memberName": "(val)",
    "memberTypeCode": "(val)",
    "activeFromDate": "(val)",
    "activeToDate": "(val)",
    "documentNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "groupMemberId": "(val)",
    "groupId": "(val)",
    "memberId": "(val)",
    "memberName": "(val)",
    "memberTypeCode": "(val)",
    "activeFromDate": "(val)",
    "activeToDate": "(val)",
    "documentNumber": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Group Document Members
GET/research-sys/api/v1/group-document-members/

Example URI

GET /research-sys/api/v1/group-document-members/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "groupMemberId",
    "groupId",
    "memberId",
    "memberName",
    "memberTypeCode",
    "activeFromDate",
    "activeToDate",
    "documentNumber"
  ],
  "primaryKey": "groupMemberId"
}

Get Blueprint API specification for Group Document Members
GET/research-sys/api/v1/group-document-members/

Example URI

GET /research-sys/api/v1/group-document-members/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Group Document Members.md"
transfer-encoding: chunked

Update Group Document Members
PUT/research-sys/api/v1/group-document-members/(key)

Example URI

PUT /research-sys/api/v1/group-document-members/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "groupMemberId": "(val)",
  "groupId": "(val)",
  "memberId": "(val)",
  "memberName": "(val)",
  "memberTypeCode": "(val)",
  "activeFromDate": "(val)",
  "activeToDate": "(val)",
  "documentNumber": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Group Document Members
PUT/research-sys/api/v1/group-document-members/

Example URI

PUT /research-sys/api/v1/group-document-members/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "groupMemberId": "(val)",
    "groupId": "(val)",
    "memberId": "(val)",
    "memberName": "(val)",
    "memberTypeCode": "(val)",
    "activeFromDate": "(val)",
    "activeToDate": "(val)",
    "documentNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "groupMemberId": "(val)",
    "groupId": "(val)",
    "memberId": "(val)",
    "memberName": "(val)",
    "memberTypeCode": "(val)",
    "activeFromDate": "(val)",
    "activeToDate": "(val)",
    "documentNumber": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Group Document Members
PATCH/research-sys/api/v1/group-document-members/(key)

Example URI

PATCH /research-sys/api/v1/group-document-members/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "groupMemberId": "(val)",
  "groupId": "(val)",
  "memberId": "(val)",
  "memberName": "(val)",
  "memberTypeCode": "(val)",
  "activeFromDate": "(val)",
  "activeToDate": "(val)",
  "documentNumber": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "groupMemberId": "(val)",
  "groupId": "(val)",
  "memberId": "(val)",
  "memberName": "(val)",
  "memberTypeCode": "(val)",
  "activeFromDate": "(val)",
  "activeToDate": "(val)",
  "documentNumber": "(val)",
  "_primaryKey": "(val)"
}

Insert Group Document Members
POST/research-sys/api/v1/group-document-members/

Example URI

POST /research-sys/api/v1/group-document-members/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "groupMemberId": "(val)",
  "groupId": "(val)",
  "memberId": "(val)",
  "memberName": "(val)",
  "memberTypeCode": "(val)",
  "activeFromDate": "(val)",
  "activeToDate": "(val)",
  "documentNumber": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "groupMemberId": "(val)",
  "groupId": "(val)",
  "memberId": "(val)",
  "memberName": "(val)",
  "memberTypeCode": "(val)",
  "activeFromDate": "(val)",
  "activeToDate": "(val)",
  "documentNumber": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Group Document Members
POST/research-sys/api/v1/group-document-members/

Example URI

POST /research-sys/api/v1/group-document-members/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "groupMemberId": "(val)",
    "groupId": "(val)",
    "memberId": "(val)",
    "memberName": "(val)",
    "memberTypeCode": "(val)",
    "activeFromDate": "(val)",
    "activeToDate": "(val)",
    "documentNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "groupMemberId": "(val)",
    "groupId": "(val)",
    "memberId": "(val)",
    "memberName": "(val)",
    "memberTypeCode": "(val)",
    "activeFromDate": "(val)",
    "activeToDate": "(val)",
    "documentNumber": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "groupMemberId": "(val)",
    "groupId": "(val)",
    "memberId": "(val)",
    "memberName": "(val)",
    "memberTypeCode": "(val)",
    "activeFromDate": "(val)",
    "activeToDate": "(val)",
    "documentNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "groupMemberId": "(val)",
    "groupId": "(val)",
    "memberId": "(val)",
    "memberName": "(val)",
    "memberTypeCode": "(val)",
    "activeFromDate": "(val)",
    "activeToDate": "(val)",
    "documentNumber": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Group Document Members by Key
DELETE/research-sys/api/v1/group-document-members/(key)

Example URI

DELETE /research-sys/api/v1/group-document-members/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Group Document Members
DELETE/research-sys/api/v1/group-document-members/

Example URI

DELETE /research-sys/api/v1/group-document-members/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Group Document Members with Matching
DELETE/research-sys/api/v1/group-document-members/

Example URI

DELETE /research-sys/api/v1/group-document-members/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

groupMemberId
string (optional) 

Group Member Identifier. Maximum length is 40.

groupId
string (optional) 

Group Id.

memberId
string (optional) 

Member Identifier. Maximum length is 40.

memberName
string (optional) 

Member Name. Maximum length is 80.

memberTypeCode
string (optional) 

Member Type Code. Maximum length is 40.

activeFromDate
string (optional) 

Start Date. Maximum length is 21.

activeToDate
string (optional) 

End Date. Maximum length is 21.

documentNumber
string (optional) 

Document Number.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Group Document Qualifiers

Get Group Document Qualifiers by Key
GET/research-sys/api/v1/group-document-qualifiers/(key)

Example URI

GET /research-sys/api/v1/group-document-qualifiers/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "groupId": "(val)",
  "kimTypId": "(val)",
  "kimAttrDefnId": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "attrVal": "(val)",
  "active": "(val)",
  "attrDataId": "(val)",
  "_primaryKey": "(val)"
}

Get All Group Document Qualifiers
GET/research-sys/api/v1/group-document-qualifiers/

Example URI

GET /research-sys/api/v1/group-document-qualifiers/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "groupId": "(val)",
    "kimTypId": "(val)",
    "kimAttrDefnId": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "attrVal": "(val)",
    "active": "(val)",
    "attrDataId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "groupId": "(val)",
    "kimTypId": "(val)",
    "kimAttrDefnId": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "attrVal": "(val)",
    "active": "(val)",
    "attrDataId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Group Document Qualifiers with Filtering
GET/research-sys/api/v1/group-document-qualifiers/

Example URI

GET /research-sys/api/v1/group-document-qualifiers/
URI Parameters
HideShow
groupId
string (optional) 

Group Id. Maximum length is 40.

kimTypId
string (optional) 

Kim Typ Id. Maximum length is 40.

kimAttrDefnId
string (optional) 

Kim Attr Defn Id. Maximum length is 40.

edit
string (optional) 

Edit.

documentNumber
string (optional) 

Document Number.

attrVal
string (optional) 

Attr Val. Maximum length is 400.

active
string (optional) 

Active.

attrDataId
string (optional) 

Attr Data Id. Maximum length is 40.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "groupId": "(val)",
    "kimTypId": "(val)",
    "kimAttrDefnId": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "attrVal": "(val)",
    "active": "(val)",
    "attrDataId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "groupId": "(val)",
    "kimTypId": "(val)",
    "kimAttrDefnId": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "attrVal": "(val)",
    "active": "(val)",
    "attrDataId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Group Document Qualifiers
GET/research-sys/api/v1/group-document-qualifiers/

Example URI

GET /research-sys/api/v1/group-document-qualifiers/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "groupId",
    "kimTypId",
    "kimAttrDefnId",
    "edit",
    "documentNumber",
    "attrVal",
    "active",
    "attrDataId"
  ],
  "primaryKey": "attrDataId"
}

Get Blueprint API specification for Group Document Qualifiers
GET/research-sys/api/v1/group-document-qualifiers/

Example URI

GET /research-sys/api/v1/group-document-qualifiers/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Group Document Qualifiers.md"
transfer-encoding: chunked

Update Group Document Qualifiers
PUT/research-sys/api/v1/group-document-qualifiers/(key)

Example URI

PUT /research-sys/api/v1/group-document-qualifiers/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "groupId": "(val)",
  "kimTypId": "(val)",
  "kimAttrDefnId": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "attrVal": "(val)",
  "active": "(val)",
  "attrDataId": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Group Document Qualifiers
PUT/research-sys/api/v1/group-document-qualifiers/

Example URI

PUT /research-sys/api/v1/group-document-qualifiers/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "groupId": "(val)",
    "kimTypId": "(val)",
    "kimAttrDefnId": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "attrVal": "(val)",
    "active": "(val)",
    "attrDataId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "groupId": "(val)",
    "kimTypId": "(val)",
    "kimAttrDefnId": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "attrVal": "(val)",
    "active": "(val)",
    "attrDataId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Group Document Qualifiers
PATCH/research-sys/api/v1/group-document-qualifiers/(key)

Example URI

PATCH /research-sys/api/v1/group-document-qualifiers/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "groupId": "(val)",
  "kimTypId": "(val)",
  "kimAttrDefnId": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "attrVal": "(val)",
  "active": "(val)",
  "attrDataId": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "groupId": "(val)",
  "kimTypId": "(val)",
  "kimAttrDefnId": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "attrVal": "(val)",
  "active": "(val)",
  "attrDataId": "(val)",
  "_primaryKey": "(val)"
}

Insert Group Document Qualifiers
POST/research-sys/api/v1/group-document-qualifiers/

Example URI

POST /research-sys/api/v1/group-document-qualifiers/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "groupId": "(val)",
  "kimTypId": "(val)",
  "kimAttrDefnId": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "attrVal": "(val)",
  "active": "(val)",
  "attrDataId": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "groupId": "(val)",
  "kimTypId": "(val)",
  "kimAttrDefnId": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "attrVal": "(val)",
  "active": "(val)",
  "attrDataId": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Group Document Qualifiers
POST/research-sys/api/v1/group-document-qualifiers/

Example URI

POST /research-sys/api/v1/group-document-qualifiers/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "groupId": "(val)",
    "kimTypId": "(val)",
    "kimAttrDefnId": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "attrVal": "(val)",
    "active": "(val)",
    "attrDataId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "groupId": "(val)",
    "kimTypId": "(val)",
    "kimAttrDefnId": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "attrVal": "(val)",
    "active": "(val)",
    "attrDataId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "groupId": "(val)",
    "kimTypId": "(val)",
    "kimAttrDefnId": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "attrVal": "(val)",
    "active": "(val)",
    "attrDataId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "groupId": "(val)",
    "kimTypId": "(val)",
    "kimAttrDefnId": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "attrVal": "(val)",
    "active": "(val)",
    "attrDataId": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Group Document Qualifiers by Key
DELETE/research-sys/api/v1/group-document-qualifiers/(key)

Example URI

DELETE /research-sys/api/v1/group-document-qualifiers/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Group Document Qualifiers
DELETE/research-sys/api/v1/group-document-qualifiers/

Example URI

DELETE /research-sys/api/v1/group-document-qualifiers/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Group Document Qualifiers with Matching
DELETE/research-sys/api/v1/group-document-qualifiers/

Example URI

DELETE /research-sys/api/v1/group-document-qualifiers/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

groupId
string (optional) 

Group Id. Maximum length is 40.

kimTypId
string (optional) 

Kim Typ Id. Maximum length is 40.

kimAttrDefnId
string (optional) 

Kim Attr Defn Id. Maximum length is 40.

edit
string (optional) 

Edit.

documentNumber
string (optional) 

Document Number.

attrVal
string (optional) 

Attr Val. Maximum length is 400.

active
string (optional) 

Active.

attrDataId
string (optional) 

Attr Data Id. Maximum length is 40.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Group Members

Get Group Members by Key
GET/research-sys/api/v1/group-members/(key)

Example URI

GET /research-sys/api/v1/group-members/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "groupId": "(val)",
  "activeFromDateValue": "(val)",
  "activeToDateValue": "(val)",
  "memberId": "(val)",
  "typeCode": "(val)",
  "_primaryKey": "(val)"
}

Get All Group Members
GET/research-sys/api/v1/group-members/

Example URI

GET /research-sys/api/v1/group-members/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "groupId": "(val)",
    "activeFromDateValue": "(val)",
    "activeToDateValue": "(val)",
    "memberId": "(val)",
    "typeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "groupId": "(val)",
    "activeFromDateValue": "(val)",
    "activeToDateValue": "(val)",
    "memberId": "(val)",
    "typeCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Group Members with Filtering
GET/research-sys/api/v1/group-members/

Example URI

GET /research-sys/api/v1/group-members/
URI Parameters
HideShow
id
string (optional) 
groupId
string (optional) 
activeFromDateValue
string (optional) 
activeToDateValue
string (optional) 
memberId
string (optional) 
typeCode
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "groupId": "(val)",
    "activeFromDateValue": "(val)",
    "activeToDateValue": "(val)",
    "memberId": "(val)",
    "typeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "groupId": "(val)",
    "activeFromDateValue": "(val)",
    "activeToDateValue": "(val)",
    "memberId": "(val)",
    "typeCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Group Members
GET/research-sys/api/v1/group-members/

Example URI

GET /research-sys/api/v1/group-members/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "groupId",
    "activeFromDateValue",
    "activeToDateValue",
    "memberId",
    "typeCode"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Group Members
GET/research-sys/api/v1/group-members/

Example URI

GET /research-sys/api/v1/group-members/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Group Members.md"
transfer-encoding: chunked

Update Group Members
PUT/research-sys/api/v1/group-members/(key)

Example URI

PUT /research-sys/api/v1/group-members/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "groupId": "(val)",
  "activeFromDateValue": "(val)",
  "activeToDateValue": "(val)",
  "memberId": "(val)",
  "typeCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Group Members
PUT/research-sys/api/v1/group-members/

Example URI

PUT /research-sys/api/v1/group-members/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "groupId": "(val)",
    "activeFromDateValue": "(val)",
    "activeToDateValue": "(val)",
    "memberId": "(val)",
    "typeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "groupId": "(val)",
    "activeFromDateValue": "(val)",
    "activeToDateValue": "(val)",
    "memberId": "(val)",
    "typeCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Group Members
PATCH/research-sys/api/v1/group-members/(key)

Example URI

PATCH /research-sys/api/v1/group-members/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "groupId": "(val)",
  "activeFromDateValue": "(val)",
  "activeToDateValue": "(val)",
  "memberId": "(val)",
  "typeCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "groupId": "(val)",
  "activeFromDateValue": "(val)",
  "activeToDateValue": "(val)",
  "memberId": "(val)",
  "typeCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Group Members
POST/research-sys/api/v1/group-members/

Example URI

POST /research-sys/api/v1/group-members/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "groupId": "(val)",
  "activeFromDateValue": "(val)",
  "activeToDateValue": "(val)",
  "memberId": "(val)",
  "typeCode": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "groupId": "(val)",
  "activeFromDateValue": "(val)",
  "activeToDateValue": "(val)",
  "memberId": "(val)",
  "typeCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Group Members
POST/research-sys/api/v1/group-members/

Example URI

POST /research-sys/api/v1/group-members/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "groupId": "(val)",
    "activeFromDateValue": "(val)",
    "activeToDateValue": "(val)",
    "memberId": "(val)",
    "typeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "groupId": "(val)",
    "activeFromDateValue": "(val)",
    "activeToDateValue": "(val)",
    "memberId": "(val)",
    "typeCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "groupId": "(val)",
    "activeFromDateValue": "(val)",
    "activeToDateValue": "(val)",
    "memberId": "(val)",
    "typeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "groupId": "(val)",
    "activeFromDateValue": "(val)",
    "activeToDateValue": "(val)",
    "memberId": "(val)",
    "typeCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Group Members by Key
DELETE/research-sys/api/v1/group-members/(key)

Example URI

DELETE /research-sys/api/v1/group-members/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Group Members
DELETE/research-sys/api/v1/group-members/

Example URI

DELETE /research-sys/api/v1/group-members/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Group Members with Matching
DELETE/research-sys/api/v1/group-members/

Example URI

DELETE /research-sys/api/v1/group-members/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 
groupId
string (optional) 
activeFromDateValue
string (optional) 
activeToDateValue
string (optional) 
memberId
string (optional) 
typeCode
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Group Rule Responsibilities

Get Group Rule Responsibilities by Key
GET/research-sys/api/v1/group-rule-responsibilities/(key)

Example URI

GET /research-sys/api/v1/group-rule-responsibilities/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "responsibilityId": "(val)",
  "ruleBaseValuesId": "(val)",
  "priority": "(val)",
  "actionRequestedCd": "(val)",
  "ruleResponsibilityName": "(val)",
  "ruleResponsibilityType": "(val)",
  "approvePolicy": "(val)",
  "_primaryKey": "(val)"
}

Get All Group Rule Responsibilities
GET/research-sys/api/v1/group-rule-responsibilities/

Example URI

GET /research-sys/api/v1/group-rule-responsibilities/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "responsibilityId": "(val)",
    "ruleBaseValuesId": "(val)",
    "priority": "(val)",
    "actionRequestedCd": "(val)",
    "ruleResponsibilityName": "(val)",
    "ruleResponsibilityType": "(val)",
    "approvePolicy": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "responsibilityId": "(val)",
    "ruleBaseValuesId": "(val)",
    "priority": "(val)",
    "actionRequestedCd": "(val)",
    "ruleResponsibilityName": "(val)",
    "ruleResponsibilityType": "(val)",
    "approvePolicy": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Group Rule Responsibilities with Filtering
GET/research-sys/api/v1/group-rule-responsibilities/

Example URI

GET /research-sys/api/v1/group-rule-responsibilities/
URI Parameters
HideShow
id
string (optional) 
responsibilityId
string (optional) 
ruleBaseValuesId
string (optional) 
priority
string (optional) 

Priority. Maximum length is 30.

actionRequestedCd
string (optional) 

Action Request. Maximum length is 30.

ruleResponsibilityName
string (optional) 
ruleResponsibilityType
string (optional) 
approvePolicy
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "responsibilityId": "(val)",
    "ruleBaseValuesId": "(val)",
    "priority": "(val)",
    "actionRequestedCd": "(val)",
    "ruleResponsibilityName": "(val)",
    "ruleResponsibilityType": "(val)",
    "approvePolicy": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "responsibilityId": "(val)",
    "ruleBaseValuesId": "(val)",
    "priority": "(val)",
    "actionRequestedCd": "(val)",
    "ruleResponsibilityName": "(val)",
    "ruleResponsibilityType": "(val)",
    "approvePolicy": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Group Rule Responsibilities
GET/research-sys/api/v1/group-rule-responsibilities/

Example URI

GET /research-sys/api/v1/group-rule-responsibilities/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "responsibilityId",
    "ruleBaseValuesId",
    "priority",
    "actionRequestedCd",
    "ruleResponsibilityName",
    "ruleResponsibilityType",
    "approvePolicy"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Group Rule Responsibilities
GET/research-sys/api/v1/group-rule-responsibilities/

Example URI

GET /research-sys/api/v1/group-rule-responsibilities/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Group Rule Responsibilities.md"
transfer-encoding: chunked

Update Group Rule Responsibilities
PUT/research-sys/api/v1/group-rule-responsibilities/(key)

Example URI

PUT /research-sys/api/v1/group-rule-responsibilities/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "responsibilityId": "(val)",
  "ruleBaseValuesId": "(val)",
  "priority": "(val)",
  "actionRequestedCd": "(val)",
  "ruleResponsibilityName": "(val)",
  "ruleResponsibilityType": "(val)",
  "approvePolicy": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Group Rule Responsibilities
PUT/research-sys/api/v1/group-rule-responsibilities/

Example URI

PUT /research-sys/api/v1/group-rule-responsibilities/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "responsibilityId": "(val)",
    "ruleBaseValuesId": "(val)",
    "priority": "(val)",
    "actionRequestedCd": "(val)",
    "ruleResponsibilityName": "(val)",
    "ruleResponsibilityType": "(val)",
    "approvePolicy": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "responsibilityId": "(val)",
    "ruleBaseValuesId": "(val)",
    "priority": "(val)",
    "actionRequestedCd": "(val)",
    "ruleResponsibilityName": "(val)",
    "ruleResponsibilityType": "(val)",
    "approvePolicy": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Group Rule Responsibilities
PATCH/research-sys/api/v1/group-rule-responsibilities/(key)

Example URI

PATCH /research-sys/api/v1/group-rule-responsibilities/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "responsibilityId": "(val)",
  "ruleBaseValuesId": "(val)",
  "priority": "(val)",
  "actionRequestedCd": "(val)",
  "ruleResponsibilityName": "(val)",
  "ruleResponsibilityType": "(val)",
  "approvePolicy": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "responsibilityId": "(val)",
  "ruleBaseValuesId": "(val)",
  "priority": "(val)",
  "actionRequestedCd": "(val)",
  "ruleResponsibilityName": "(val)",
  "ruleResponsibilityType": "(val)",
  "approvePolicy": "(val)",
  "_primaryKey": "(val)"
}

Insert Group Rule Responsibilities
POST/research-sys/api/v1/group-rule-responsibilities/

Example URI

POST /research-sys/api/v1/group-rule-responsibilities/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "responsibilityId": "(val)",
  "ruleBaseValuesId": "(val)",
  "priority": "(val)",
  "actionRequestedCd": "(val)",
  "ruleResponsibilityName": "(val)",
  "ruleResponsibilityType": "(val)",
  "approvePolicy": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "responsibilityId": "(val)",
  "ruleBaseValuesId": "(val)",
  "priority": "(val)",
  "actionRequestedCd": "(val)",
  "ruleResponsibilityName": "(val)",
  "ruleResponsibilityType": "(val)",
  "approvePolicy": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Group Rule Responsibilities
POST/research-sys/api/v1/group-rule-responsibilities/

Example URI

POST /research-sys/api/v1/group-rule-responsibilities/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "responsibilityId": "(val)",
    "ruleBaseValuesId": "(val)",
    "priority": "(val)",
    "actionRequestedCd": "(val)",
    "ruleResponsibilityName": "(val)",
    "ruleResponsibilityType": "(val)",
    "approvePolicy": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "responsibilityId": "(val)",
    "ruleBaseValuesId": "(val)",
    "priority": "(val)",
    "actionRequestedCd": "(val)",
    "ruleResponsibilityName": "(val)",
    "ruleResponsibilityType": "(val)",
    "approvePolicy": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "responsibilityId": "(val)",
    "ruleBaseValuesId": "(val)",
    "priority": "(val)",
    "actionRequestedCd": "(val)",
    "ruleResponsibilityName": "(val)",
    "ruleResponsibilityType": "(val)",
    "approvePolicy": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "responsibilityId": "(val)",
    "ruleBaseValuesId": "(val)",
    "priority": "(val)",
    "actionRequestedCd": "(val)",
    "ruleResponsibilityName": "(val)",
    "ruleResponsibilityType": "(val)",
    "approvePolicy": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Group Rule Responsibilities by Key
DELETE/research-sys/api/v1/group-rule-responsibilities/(key)

Example URI

DELETE /research-sys/api/v1/group-rule-responsibilities/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Group Rule Responsibilities
DELETE/research-sys/api/v1/group-rule-responsibilities/

Example URI

DELETE /research-sys/api/v1/group-rule-responsibilities/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Group Rule Responsibilities with Matching
DELETE/research-sys/api/v1/group-rule-responsibilities/

Example URI

DELETE /research-sys/api/v1/group-rule-responsibilities/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 
responsibilityId
string (optional) 
ruleBaseValuesId
string (optional) 
priority
string (optional) 

Priority. Maximum length is 30.

actionRequestedCd
string (optional) 

Action Request. Maximum length is 30.

ruleResponsibilityName
string (optional) 
ruleResponsibilityType
string (optional) 
approvePolicy
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Groups

Get Groups by Key
GET/research-sys/api/v1/groups/(key)

Example URI

GET /research-sys/api/v1/groups/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "kimTypeId": "(val)",
  "name": "(val)",
  "active": "(val)",
  "description": "(val)",
  "namespaceCode": "(val)",
  "_primaryKey": "(val)"
}

Get All Groups
GET/research-sys/api/v1/groups/

Example URI

GET /research-sys/api/v1/groups/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "kimTypeId": "(val)",
    "name": "(val)",
    "active": "(val)",
    "description": "(val)",
    "namespaceCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "kimTypeId": "(val)",
    "name": "(val)",
    "active": "(val)",
    "description": "(val)",
    "namespaceCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Groups with Filtering
GET/research-sys/api/v1/groups/

Example URI

GET /research-sys/api/v1/groups/
URI Parameters
HideShow
id
string (optional) 

Group Id. Maximum length is 70.

kimTypeId
string (optional) 

Group Type. Maximum length is 40.

name
string (optional) 

Group Name. Maximum length is 80.

active
string (optional) 

This attribute is used to describe whether the associated object is active or inactive. Maximum length is 1.

description
string (optional) 

Group Description. Maximum length is 4000.

namespaceCode
string (optional) 

Nmspc Cd. Maximum length is 40.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "kimTypeId": "(val)",
    "name": "(val)",
    "active": "(val)",
    "description": "(val)",
    "namespaceCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "kimTypeId": "(val)",
    "name": "(val)",
    "active": "(val)",
    "description": "(val)",
    "namespaceCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Groups
GET/research-sys/api/v1/groups/

Example URI

GET /research-sys/api/v1/groups/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "kimTypeId",
    "name",
    "active",
    "description",
    "namespaceCode"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Groups
GET/research-sys/api/v1/groups/

Example URI

GET /research-sys/api/v1/groups/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Groups.md"
transfer-encoding: chunked

Update Groups
PUT/research-sys/api/v1/groups/(key)

Example URI

PUT /research-sys/api/v1/groups/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "kimTypeId": "(val)",
  "name": "(val)",
  "active": "(val)",
  "description": "(val)",
  "namespaceCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Groups
PUT/research-sys/api/v1/groups/

Example URI

PUT /research-sys/api/v1/groups/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "kimTypeId": "(val)",
    "name": "(val)",
    "active": "(val)",
    "description": "(val)",
    "namespaceCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "kimTypeId": "(val)",
    "name": "(val)",
    "active": "(val)",
    "description": "(val)",
    "namespaceCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Groups
PATCH/research-sys/api/v1/groups/(key)

Example URI

PATCH /research-sys/api/v1/groups/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "kimTypeId": "(val)",
  "name": "(val)",
  "active": "(val)",
  "description": "(val)",
  "namespaceCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "kimTypeId": "(val)",
  "name": "(val)",
  "active": "(val)",
  "description": "(val)",
  "namespaceCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Groups
POST/research-sys/api/v1/groups/

Example URI

POST /research-sys/api/v1/groups/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "kimTypeId": "(val)",
  "name": "(val)",
  "active": "(val)",
  "description": "(val)",
  "namespaceCode": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "kimTypeId": "(val)",
  "name": "(val)",
  "active": "(val)",
  "description": "(val)",
  "namespaceCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Groups
POST/research-sys/api/v1/groups/

Example URI

POST /research-sys/api/v1/groups/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "kimTypeId": "(val)",
    "name": "(val)",
    "active": "(val)",
    "description": "(val)",
    "namespaceCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "kimTypeId": "(val)",
    "name": "(val)",
    "active": "(val)",
    "description": "(val)",
    "namespaceCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "kimTypeId": "(val)",
    "name": "(val)",
    "active": "(val)",
    "description": "(val)",
    "namespaceCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "kimTypeId": "(val)",
    "name": "(val)",
    "active": "(val)",
    "description": "(val)",
    "namespaceCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Groups by Key
DELETE/research-sys/api/v1/groups/(key)

Example URI

DELETE /research-sys/api/v1/groups/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Groups
DELETE/research-sys/api/v1/groups/

Example URI

DELETE /research-sys/api/v1/groups/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Groups with Matching
DELETE/research-sys/api/v1/groups/

Example URI

DELETE /research-sys/api/v1/groups/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 

Group Id. Maximum length is 70.

kimTypeId
string (optional) 

Group Type. Maximum length is 40.

name
string (optional) 

Group Name. Maximum length is 80.

active
string (optional) 

This attribute is used to describe whether the associated object is active or inactive. Maximum length is 1.

description
string (optional) 

Group Description. Maximum length is 4000.

namespaceCode
string (optional) 

Nmspc Cd. Maximum length is 40.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Kew Attribute Definitions

Get Kew Attribute Definitions by Key
GET/research-sys/api/v1/kew-attribute-definitions/(key)

Example URI

GET /research-sys/api/v1/kew-attribute-definitions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "name": "(val)",
  "namespace": "(val)",
  "label": "(val)",
  "active": "(val)",
  "componentName": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Get All Kew Attribute Definitions
GET/research-sys/api/v1/kew-attribute-definitions/

Example URI

GET /research-sys/api/v1/kew-attribute-definitions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "label": "(val)",
    "active": "(val)",
    "componentName": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "label": "(val)",
    "active": "(val)",
    "componentName": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Kew Attribute Definitions with Filtering
GET/research-sys/api/v1/kew-attribute-definitions/

Example URI

GET /research-sys/api/v1/kew-attribute-definitions/
URI Parameters
HideShow
id
string (optional) 
name
string (optional) 
namespace
string (optional) 
label
string (optional) 
active
string (optional) 
componentName
string (optional) 
description
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "label": "(val)",
    "active": "(val)",
    "componentName": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "label": "(val)",
    "active": "(val)",
    "componentName": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Kew Attribute Definitions
GET/research-sys/api/v1/kew-attribute-definitions/

Example URI

GET /research-sys/api/v1/kew-attribute-definitions/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "name",
    "namespace",
    "label",
    "active",
    "componentName",
    "description"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Kew Attribute Definitions
GET/research-sys/api/v1/kew-attribute-definitions/

Example URI

GET /research-sys/api/v1/kew-attribute-definitions/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Kew Attribute Definitions.md"
transfer-encoding: chunked

Update Kew Attribute Definitions
PUT/research-sys/api/v1/kew-attribute-definitions/(key)

Example URI

PUT /research-sys/api/v1/kew-attribute-definitions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "name": "(val)",
  "namespace": "(val)",
  "label": "(val)",
  "active": "(val)",
  "componentName": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Kew Attribute Definitions
PUT/research-sys/api/v1/kew-attribute-definitions/

Example URI

PUT /research-sys/api/v1/kew-attribute-definitions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "label": "(val)",
    "active": "(val)",
    "componentName": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "label": "(val)",
    "active": "(val)",
    "componentName": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Kew Attribute Definitions
PATCH/research-sys/api/v1/kew-attribute-definitions/(key)

Example URI

PATCH /research-sys/api/v1/kew-attribute-definitions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "name": "(val)",
  "namespace": "(val)",
  "label": "(val)",
  "active": "(val)",
  "componentName": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "name": "(val)",
  "namespace": "(val)",
  "label": "(val)",
  "active": "(val)",
  "componentName": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Kew Attribute Definitions
POST/research-sys/api/v1/kew-attribute-definitions/

Example URI

POST /research-sys/api/v1/kew-attribute-definitions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "name": "(val)",
  "namespace": "(val)",
  "label": "(val)",
  "active": "(val)",
  "componentName": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "name": "(val)",
  "namespace": "(val)",
  "label": "(val)",
  "active": "(val)",
  "componentName": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Kew Attribute Definitions
POST/research-sys/api/v1/kew-attribute-definitions/

Example URI

POST /research-sys/api/v1/kew-attribute-definitions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "label": "(val)",
    "active": "(val)",
    "componentName": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "label": "(val)",
    "active": "(val)",
    "componentName": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "label": "(val)",
    "active": "(val)",
    "componentName": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "label": "(val)",
    "active": "(val)",
    "componentName": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Kew Attribute Definitions by Key
DELETE/research-sys/api/v1/kew-attribute-definitions/(key)

Example URI

DELETE /research-sys/api/v1/kew-attribute-definitions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Kew Attribute Definitions
DELETE/research-sys/api/v1/kew-attribute-definitions/

Example URI

DELETE /research-sys/api/v1/kew-attribute-definitions/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Kew Attribute Definitions with Matching
DELETE/research-sys/api/v1/kew-attribute-definitions/

Example URI

DELETE /research-sys/api/v1/kew-attribute-definitions/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 
name
string (optional) 
namespace
string (optional) 
label
string (optional) 
active
string (optional) 
componentName
string (optional) 
description
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Kew Rule Attributes

Get Kew Rule Attributes by Key
GET/research-sys/api/v1/kew-rule-attributes/(key)

Example URI

GET /research-sys/api/v1/kew-rule-attributes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "name": "(val)",
  "label": "(val)",
  "type": "(val)",
  "resourceDescriptor": "(val)",
  "description": "(val)",
  "xmlConfigData": "(val)",
  "applicationId": "(val)",
  "_primaryKey": "(val)"
}

Get All Kew Rule Attributes
GET/research-sys/api/v1/kew-rule-attributes/

Example URI

GET /research-sys/api/v1/kew-rule-attributes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "label": "(val)",
    "type": "(val)",
    "resourceDescriptor": "(val)",
    "description": "(val)",
    "xmlConfigData": "(val)",
    "applicationId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "label": "(val)",
    "type": "(val)",
    "resourceDescriptor": "(val)",
    "description": "(val)",
    "xmlConfigData": "(val)",
    "applicationId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Kew Rule Attributes with Filtering
GET/research-sys/api/v1/kew-rule-attributes/

Example URI

GET /research-sys/api/v1/kew-rule-attributes/
URI Parameters
HideShow
id
string (optional) 

Id. Maximum length is 30.

name
string (optional) 

Name. Maximum length is 30.

label
string (optional) 

Label. Maximum length is 30.

type
string (optional) 

Type.

resourceDescriptor
string (optional) 

Class Name.

description
string (optional) 

Description. Maximum length is 30.

xmlConfigData
string (optional) 

XML Configuration.

applicationId
string (optional) 

Application ID.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "label": "(val)",
    "type": "(val)",
    "resourceDescriptor": "(val)",
    "description": "(val)",
    "xmlConfigData": "(val)",
    "applicationId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "label": "(val)",
    "type": "(val)",
    "resourceDescriptor": "(val)",
    "description": "(val)",
    "xmlConfigData": "(val)",
    "applicationId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Kew Rule Attributes
GET/research-sys/api/v1/kew-rule-attributes/

Example URI

GET /research-sys/api/v1/kew-rule-attributes/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "name",
    "label",
    "type",
    "resourceDescriptor",
    "description",
    "xmlConfigData",
    "applicationId"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Kew Rule Attributes
GET/research-sys/api/v1/kew-rule-attributes/

Example URI

GET /research-sys/api/v1/kew-rule-attributes/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Kew Rule Attributes.md"
transfer-encoding: chunked

Update Kew Rule Attributes
PUT/research-sys/api/v1/kew-rule-attributes/(key)

Example URI

PUT /research-sys/api/v1/kew-rule-attributes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "name": "(val)",
  "label": "(val)",
  "type": "(val)",
  "resourceDescriptor": "(val)",
  "description": "(val)",
  "xmlConfigData": "(val)",
  "applicationId": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Kew Rule Attributes
PUT/research-sys/api/v1/kew-rule-attributes/

Example URI

PUT /research-sys/api/v1/kew-rule-attributes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "label": "(val)",
    "type": "(val)",
    "resourceDescriptor": "(val)",
    "description": "(val)",
    "xmlConfigData": "(val)",
    "applicationId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "label": "(val)",
    "type": "(val)",
    "resourceDescriptor": "(val)",
    "description": "(val)",
    "xmlConfigData": "(val)",
    "applicationId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Kew Rule Attributes
PATCH/research-sys/api/v1/kew-rule-attributes/(key)

Example URI

PATCH /research-sys/api/v1/kew-rule-attributes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "name": "(val)",
  "label": "(val)",
  "type": "(val)",
  "resourceDescriptor": "(val)",
  "description": "(val)",
  "xmlConfigData": "(val)",
  "applicationId": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "name": "(val)",
  "label": "(val)",
  "type": "(val)",
  "resourceDescriptor": "(val)",
  "description": "(val)",
  "xmlConfigData": "(val)",
  "applicationId": "(val)",
  "_primaryKey": "(val)"
}

Insert Kew Rule Attributes
POST/research-sys/api/v1/kew-rule-attributes/

Example URI

POST /research-sys/api/v1/kew-rule-attributes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "name": "(val)",
  "label": "(val)",
  "type": "(val)",
  "resourceDescriptor": "(val)",
  "description": "(val)",
  "xmlConfigData": "(val)",
  "applicationId": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "name": "(val)",
  "label": "(val)",
  "type": "(val)",
  "resourceDescriptor": "(val)",
  "description": "(val)",
  "xmlConfigData": "(val)",
  "applicationId": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Kew Rule Attributes
POST/research-sys/api/v1/kew-rule-attributes/

Example URI

POST /research-sys/api/v1/kew-rule-attributes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "label": "(val)",
    "type": "(val)",
    "resourceDescriptor": "(val)",
    "description": "(val)",
    "xmlConfigData": "(val)",
    "applicationId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "label": "(val)",
    "type": "(val)",
    "resourceDescriptor": "(val)",
    "description": "(val)",
    "xmlConfigData": "(val)",
    "applicationId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "label": "(val)",
    "type": "(val)",
    "resourceDescriptor": "(val)",
    "description": "(val)",
    "xmlConfigData": "(val)",
    "applicationId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "label": "(val)",
    "type": "(val)",
    "resourceDescriptor": "(val)",
    "description": "(val)",
    "xmlConfigData": "(val)",
    "applicationId": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Kew Rule Attributes by Key
DELETE/research-sys/api/v1/kew-rule-attributes/(key)

Example URI

DELETE /research-sys/api/v1/kew-rule-attributes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Kew Rule Attributes
DELETE/research-sys/api/v1/kew-rule-attributes/

Example URI

DELETE /research-sys/api/v1/kew-rule-attributes/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Kew Rule Attributes with Matching
DELETE/research-sys/api/v1/kew-rule-attributes/

Example URI

DELETE /research-sys/api/v1/kew-rule-attributes/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 

Id. Maximum length is 30.

name
string (optional) 

Name. Maximum length is 30.

label
string (optional) 

Label. Maximum length is 30.

type
string (optional) 

Type.

resourceDescriptor
string (optional) 

Class Name.

description
string (optional) 

Description. Maximum length is 30.

xmlConfigData
string (optional) 

XML Configuration.

applicationId
string (optional) 

Application ID.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Kew Type Attributes

Get Kew Type Attributes by Key
GET/research-sys/api/v1/kew-type-attributes/(key)

Example URI

GET /research-sys/api/v1/kew-type-attributes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "sequenceNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Get All Kew Type Attributes
GET/research-sys/api/v1/kew-type-attributes/

Example URI

GET /research-sys/api/v1/kew-type-attributes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "sequenceNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "sequenceNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Kew Type Attributes with Filtering
GET/research-sys/api/v1/kew-type-attributes/

Example URI

GET /research-sys/api/v1/kew-type-attributes/
URI Parameters
HideShow
id
string (optional) 
sequenceNumber
string (optional) 
active
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "sequenceNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "sequenceNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Kew Type Attributes
GET/research-sys/api/v1/kew-type-attributes/

Example URI

GET /research-sys/api/v1/kew-type-attributes/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "sequenceNumber",
    "active"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Kew Type Attributes
GET/research-sys/api/v1/kew-type-attributes/

Example URI

GET /research-sys/api/v1/kew-type-attributes/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Kew Type Attributes.md"
transfer-encoding: chunked

Update Kew Type Attributes
PUT/research-sys/api/v1/kew-type-attributes/(key)

Example URI

PUT /research-sys/api/v1/kew-type-attributes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "sequenceNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Kew Type Attributes
PUT/research-sys/api/v1/kew-type-attributes/

Example URI

PUT /research-sys/api/v1/kew-type-attributes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "sequenceNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "sequenceNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Kew Type Attributes
PATCH/research-sys/api/v1/kew-type-attributes/(key)

Example URI

PATCH /research-sys/api/v1/kew-type-attributes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "sequenceNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "sequenceNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Kew Type Attributes
POST/research-sys/api/v1/kew-type-attributes/

Example URI

POST /research-sys/api/v1/kew-type-attributes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "sequenceNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "sequenceNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Kew Type Attributes
POST/research-sys/api/v1/kew-type-attributes/

Example URI

POST /research-sys/api/v1/kew-type-attributes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "sequenceNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "sequenceNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "sequenceNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "sequenceNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Kew Type Attributes by Key
DELETE/research-sys/api/v1/kew-type-attributes/(key)

Example URI

DELETE /research-sys/api/v1/kew-type-attributes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Kew Type Attributes
DELETE/research-sys/api/v1/kew-type-attributes/

Example URI

DELETE /research-sys/api/v1/kew-type-attributes/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Kew Type Attributes with Matching
DELETE/research-sys/api/v1/kew-type-attributes/

Example URI

DELETE /research-sys/api/v1/kew-type-attributes/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 
sequenceNumber
string (optional) 
active
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Kew Types

Get Kew Types by Key
GET/research-sys/api/v1/kew-types/(key)

Example URI

GET /research-sys/api/v1/kew-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "name": "(val)",
  "namespace": "(val)",
  "serviceName": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Get All Kew Types
GET/research-sys/api/v1/kew-types/

Example URI

GET /research-sys/api/v1/kew-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "serviceName": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "serviceName": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Kew Types with Filtering
GET/research-sys/api/v1/kew-types/

Example URI

GET /research-sys/api/v1/kew-types/
URI Parameters
HideShow
id
string (optional) 
name
string (optional) 
namespace
string (optional) 
serviceName
string (optional) 
active
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "serviceName": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "serviceName": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Kew Types
GET/research-sys/api/v1/kew-types/

Example URI

GET /research-sys/api/v1/kew-types/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "name",
    "namespace",
    "serviceName",
    "active"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Kew Types
GET/research-sys/api/v1/kew-types/

Example URI

GET /research-sys/api/v1/kew-types/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Kew Types.md"
transfer-encoding: chunked

Update Kew Types
PUT/research-sys/api/v1/kew-types/(key)

Example URI

PUT /research-sys/api/v1/kew-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "name": "(val)",
  "namespace": "(val)",
  "serviceName": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Kew Types
PUT/research-sys/api/v1/kew-types/

Example URI

PUT /research-sys/api/v1/kew-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "serviceName": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "serviceName": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Kew Types
PATCH/research-sys/api/v1/kew-types/(key)

Example URI

PATCH /research-sys/api/v1/kew-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "name": "(val)",
  "namespace": "(val)",
  "serviceName": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "name": "(val)",
  "namespace": "(val)",
  "serviceName": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Kew Types
POST/research-sys/api/v1/kew-types/

Example URI

POST /research-sys/api/v1/kew-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "name": "(val)",
  "namespace": "(val)",
  "serviceName": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "name": "(val)",
  "namespace": "(val)",
  "serviceName": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Kew Types
POST/research-sys/api/v1/kew-types/

Example URI

POST /research-sys/api/v1/kew-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "serviceName": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "serviceName": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "serviceName": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "serviceName": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Kew Types by Key
DELETE/research-sys/api/v1/kew-types/(key)

Example URI

DELETE /research-sys/api/v1/kew-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Kew Types
DELETE/research-sys/api/v1/kew-types/

Example URI

DELETE /research-sys/api/v1/kew-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Kew Types with Matching
DELETE/research-sys/api/v1/kew-types/

Example URI

DELETE /research-sys/api/v1/kew-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 
name
string (optional) 
namespace
string (optional) 
serviceName
string (optional) 
active
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Kim Attributes

Get Kim Attributes by Key
GET/research-sys/api/v1/kim-attributes/(key)

Example URI

GET /research-sys/api/v1/kim-attributes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "componentName": "(val)",
  "attributeName": "(val)",
  "namespaceCode": "(val)",
  "attributeLabel": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Get All Kim Attributes
GET/research-sys/api/v1/kim-attributes/

Example URI

GET /research-sys/api/v1/kim-attributes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "componentName": "(val)",
    "attributeName": "(val)",
    "namespaceCode": "(val)",
    "attributeLabel": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "componentName": "(val)",
    "attributeName": "(val)",
    "namespaceCode": "(val)",
    "attributeLabel": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Kim Attributes with Filtering
GET/research-sys/api/v1/kim-attributes/

Example URI

GET /research-sys/api/v1/kim-attributes/
URI Parameters
HideShow
id
string (optional) 

Attribute Id. Maximum length is 40.

componentName
string (optional) 

Component Name. Maximum length is 40.

attributeName
string (optional) 

Attribute Name. Maximum length is 40.

namespaceCode
string (optional) 

Nmspc Cd. Maximum length is 40.

attributeLabel
string (optional) 

Attribute Label. Maximum length is 40.

active
string (optional) 

This attribute is used to describe whether the associated object is active or inactive. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "componentName": "(val)",
    "attributeName": "(val)",
    "namespaceCode": "(val)",
    "attributeLabel": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "componentName": "(val)",
    "attributeName": "(val)",
    "namespaceCode": "(val)",
    "attributeLabel": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Kim Attributes
GET/research-sys/api/v1/kim-attributes/

Example URI

GET /research-sys/api/v1/kim-attributes/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "componentName",
    "attributeName",
    "namespaceCode",
    "attributeLabel",
    "active"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Kim Attributes
GET/research-sys/api/v1/kim-attributes/

Example URI

GET /research-sys/api/v1/kim-attributes/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Kim Attributes.md"
transfer-encoding: chunked

Update Kim Attributes
PUT/research-sys/api/v1/kim-attributes/(key)

Example URI

PUT /research-sys/api/v1/kim-attributes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "componentName": "(val)",
  "attributeName": "(val)",
  "namespaceCode": "(val)",
  "attributeLabel": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Kim Attributes
PUT/research-sys/api/v1/kim-attributes/

Example URI

PUT /research-sys/api/v1/kim-attributes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "componentName": "(val)",
    "attributeName": "(val)",
    "namespaceCode": "(val)",
    "attributeLabel": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "componentName": "(val)",
    "attributeName": "(val)",
    "namespaceCode": "(val)",
    "attributeLabel": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Kim Attributes
PATCH/research-sys/api/v1/kim-attributes/(key)

Example URI

PATCH /research-sys/api/v1/kim-attributes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "componentName": "(val)",
  "attributeName": "(val)",
  "namespaceCode": "(val)",
  "attributeLabel": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "componentName": "(val)",
  "attributeName": "(val)",
  "namespaceCode": "(val)",
  "attributeLabel": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Kim Attributes
POST/research-sys/api/v1/kim-attributes/

Example URI

POST /research-sys/api/v1/kim-attributes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "componentName": "(val)",
  "attributeName": "(val)",
  "namespaceCode": "(val)",
  "attributeLabel": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "componentName": "(val)",
  "attributeName": "(val)",
  "namespaceCode": "(val)",
  "attributeLabel": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Kim Attributes
POST/research-sys/api/v1/kim-attributes/

Example URI

POST /research-sys/api/v1/kim-attributes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "componentName": "(val)",
    "attributeName": "(val)",
    "namespaceCode": "(val)",
    "attributeLabel": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "componentName": "(val)",
    "attributeName": "(val)",
    "namespaceCode": "(val)",
    "attributeLabel": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "componentName": "(val)",
    "attributeName": "(val)",
    "namespaceCode": "(val)",
    "attributeLabel": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "componentName": "(val)",
    "attributeName": "(val)",
    "namespaceCode": "(val)",
    "attributeLabel": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Kim Attributes by Key
DELETE/research-sys/api/v1/kim-attributes/(key)

Example URI

DELETE /research-sys/api/v1/kim-attributes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Kim Attributes
DELETE/research-sys/api/v1/kim-attributes/

Example URI

DELETE /research-sys/api/v1/kim-attributes/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Kim Attributes with Matching
DELETE/research-sys/api/v1/kim-attributes/

Example URI

DELETE /research-sys/api/v1/kim-attributes/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 

Attribute Id. Maximum length is 40.

componentName
string (optional) 

Component Name. Maximum length is 40.

attributeName
string (optional) 

Attribute Name. Maximum length is 40.

namespaceCode
string (optional) 

Nmspc Cd. Maximum length is 40.

attributeLabel
string (optional) 

Attribute Label. Maximum length is 40.

active
string (optional) 

This attribute is used to describe whether the associated object is active or inactive. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Kim Document Role Members

Get Kim Document Role Members by Key
GET/research-sys/api/v1/kim-document-role-members/(key)

Example URI

GET /research-sys/api/v1/kim-document-role-members/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "roleMemberId": "(val)",
  "roleId": "(val)",
  "memberId": "(val)",
  "memberTypeCode": "(val)",
  "activeFromDate": "(val)",
  "activeToDate": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Get All Kim Document Role Members
GET/research-sys/api/v1/kim-document-role-members/

Example URI

GET /research-sys/api/v1/kim-document-role-members/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "roleMemberId": "(val)",
    "roleId": "(val)",
    "memberId": "(val)",
    "memberTypeCode": "(val)",
    "activeFromDate": "(val)",
    "activeToDate": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "roleMemberId": "(val)",
    "roleId": "(val)",
    "memberId": "(val)",
    "memberTypeCode": "(val)",
    "activeFromDate": "(val)",
    "activeToDate": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Kim Document Role Members with Filtering
GET/research-sys/api/v1/kim-document-role-members/

Example URI

GET /research-sys/api/v1/kim-document-role-members/
URI Parameters
HideShow
roleMemberId
string (optional) 

Role Member Identifier. Maximum length is 40.

roleId
string (optional) 

Role. Maximum length is 40.

memberId
string (optional) 

Member Identifier. Maximum length is 40.

memberTypeCode
string (optional) 

Member Type Code. Maximum length is 40.

activeFromDate
string (optional) 

Start Date. Maximum length is 21.

activeToDate
string (optional) 

End Date. Maximum length is 21.

edit
string (optional) 

Edit.

documentNumber
string (optional) 

Document Number.

active
string (optional) 

Active.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "roleMemberId": "(val)",
    "roleId": "(val)",
    "memberId": "(val)",
    "memberTypeCode": "(val)",
    "activeFromDate": "(val)",
    "activeToDate": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "roleMemberId": "(val)",
    "roleId": "(val)",
    "memberId": "(val)",
    "memberTypeCode": "(val)",
    "activeFromDate": "(val)",
    "activeToDate": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Kim Document Role Members
GET/research-sys/api/v1/kim-document-role-members/

Example URI

GET /research-sys/api/v1/kim-document-role-members/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "roleMemberId",
    "roleId",
    "memberId",
    "memberTypeCode",
    "activeFromDate",
    "activeToDate",
    "edit",
    "documentNumber",
    "active"
  ],
  "primaryKey": "roleMemberId"
}

Get Blueprint API specification for Kim Document Role Members
GET/research-sys/api/v1/kim-document-role-members/

Example URI

GET /research-sys/api/v1/kim-document-role-members/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Kim Document Role Members.md"
transfer-encoding: chunked

Update Kim Document Role Members
PUT/research-sys/api/v1/kim-document-role-members/(key)

Example URI

PUT /research-sys/api/v1/kim-document-role-members/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "roleMemberId": "(val)",
  "roleId": "(val)",
  "memberId": "(val)",
  "memberTypeCode": "(val)",
  "activeFromDate": "(val)",
  "activeToDate": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Kim Document Role Members
PUT/research-sys/api/v1/kim-document-role-members/

Example URI

PUT /research-sys/api/v1/kim-document-role-members/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "roleMemberId": "(val)",
    "roleId": "(val)",
    "memberId": "(val)",
    "memberTypeCode": "(val)",
    "activeFromDate": "(val)",
    "activeToDate": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "roleMemberId": "(val)",
    "roleId": "(val)",
    "memberId": "(val)",
    "memberTypeCode": "(val)",
    "activeFromDate": "(val)",
    "activeToDate": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Kim Document Role Members
PATCH/research-sys/api/v1/kim-document-role-members/(key)

Example URI

PATCH /research-sys/api/v1/kim-document-role-members/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "roleMemberId": "(val)",
  "roleId": "(val)",
  "memberId": "(val)",
  "memberTypeCode": "(val)",
  "activeFromDate": "(val)",
  "activeToDate": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "roleMemberId": "(val)",
  "roleId": "(val)",
  "memberId": "(val)",
  "memberTypeCode": "(val)",
  "activeFromDate": "(val)",
  "activeToDate": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Kim Document Role Members
POST/research-sys/api/v1/kim-document-role-members/

Example URI

POST /research-sys/api/v1/kim-document-role-members/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "roleMemberId": "(val)",
  "roleId": "(val)",
  "memberId": "(val)",
  "memberTypeCode": "(val)",
  "activeFromDate": "(val)",
  "activeToDate": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "roleMemberId": "(val)",
  "roleId": "(val)",
  "memberId": "(val)",
  "memberTypeCode": "(val)",
  "activeFromDate": "(val)",
  "activeToDate": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Kim Document Role Members
POST/research-sys/api/v1/kim-document-role-members/

Example URI

POST /research-sys/api/v1/kim-document-role-members/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "roleMemberId": "(val)",
    "roleId": "(val)",
    "memberId": "(val)",
    "memberTypeCode": "(val)",
    "activeFromDate": "(val)",
    "activeToDate": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "roleMemberId": "(val)",
    "roleId": "(val)",
    "memberId": "(val)",
    "memberTypeCode": "(val)",
    "activeFromDate": "(val)",
    "activeToDate": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "roleMemberId": "(val)",
    "roleId": "(val)",
    "memberId": "(val)",
    "memberTypeCode": "(val)",
    "activeFromDate": "(val)",
    "activeToDate": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "roleMemberId": "(val)",
    "roleId": "(val)",
    "memberId": "(val)",
    "memberTypeCode": "(val)",
    "activeFromDate": "(val)",
    "activeToDate": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Kim Document Role Members by Key
DELETE/research-sys/api/v1/kim-document-role-members/(key)

Example URI

DELETE /research-sys/api/v1/kim-document-role-members/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Kim Document Role Members
DELETE/research-sys/api/v1/kim-document-role-members/

Example URI

DELETE /research-sys/api/v1/kim-document-role-members/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Kim Document Role Members with Matching
DELETE/research-sys/api/v1/kim-document-role-members/

Example URI

DELETE /research-sys/api/v1/kim-document-role-members/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

roleMemberId
string (optional) 

Role Member Identifier. Maximum length is 40.

roleId
string (optional) 

Role. Maximum length is 40.

memberId
string (optional) 

Member Identifier. Maximum length is 40.

memberTypeCode
string (optional) 

Member Type Code. Maximum length is 40.

activeFromDate
string (optional) 

Start Date. Maximum length is 21.

activeToDate
string (optional) 

End Date. Maximum length is 21.

edit
string (optional) 

Edit.

documentNumber
string (optional) 

Document Number.

active
string (optional) 

Active.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Kim Document Role Permissions

Get Kim Document Role Permissions by Key
GET/research-sys/api/v1/kim-document-role-permissions/(key)

Example URI

GET /research-sys/api/v1/kim-document-role-permissions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "rolePermissionId": "(val)",
  "roleId": "(val)",
  "permissionId": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Get All Kim Document Role Permissions
GET/research-sys/api/v1/kim-document-role-permissions/

Example URI

GET /research-sys/api/v1/kim-document-role-permissions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "rolePermissionId": "(val)",
    "roleId": "(val)",
    "permissionId": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "rolePermissionId": "(val)",
    "roleId": "(val)",
    "permissionId": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Kim Document Role Permissions with Filtering
GET/research-sys/api/v1/kim-document-role-permissions/

Example URI

GET /research-sys/api/v1/kim-document-role-permissions/
URI Parameters
HideShow
rolePermissionId
string (optional) 
roleId
string (optional) 
permissionId
string (optional) 
documentNumber
string (optional) 
active
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "rolePermissionId": "(val)",
    "roleId": "(val)",
    "permissionId": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "rolePermissionId": "(val)",
    "roleId": "(val)",
    "permissionId": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Kim Document Role Permissions
GET/research-sys/api/v1/kim-document-role-permissions/

Example URI

GET /research-sys/api/v1/kim-document-role-permissions/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "rolePermissionId",
    "roleId",
    "permissionId",
    "documentNumber",
    "active"
  ],
  "primaryKey": "rolePermissionId"
}

Get Blueprint API specification for Kim Document Role Permissions
GET/research-sys/api/v1/kim-document-role-permissions/

Example URI

GET /research-sys/api/v1/kim-document-role-permissions/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Kim Document Role Permissions.md"
transfer-encoding: chunked

Update Kim Document Role Permissions
PUT/research-sys/api/v1/kim-document-role-permissions/(key)

Example URI

PUT /research-sys/api/v1/kim-document-role-permissions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "rolePermissionId": "(val)",
  "roleId": "(val)",
  "permissionId": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Kim Document Role Permissions
PUT/research-sys/api/v1/kim-document-role-permissions/

Example URI

PUT /research-sys/api/v1/kim-document-role-permissions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "rolePermissionId": "(val)",
    "roleId": "(val)",
    "permissionId": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "rolePermissionId": "(val)",
    "roleId": "(val)",
    "permissionId": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Kim Document Role Permissions
PATCH/research-sys/api/v1/kim-document-role-permissions/(key)

Example URI

PATCH /research-sys/api/v1/kim-document-role-permissions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "rolePermissionId": "(val)",
  "roleId": "(val)",
  "permissionId": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "rolePermissionId": "(val)",
  "roleId": "(val)",
  "permissionId": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Kim Document Role Permissions
POST/research-sys/api/v1/kim-document-role-permissions/

Example URI

POST /research-sys/api/v1/kim-document-role-permissions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "rolePermissionId": "(val)",
  "roleId": "(val)",
  "permissionId": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "rolePermissionId": "(val)",
  "roleId": "(val)",
  "permissionId": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Kim Document Role Permissions
POST/research-sys/api/v1/kim-document-role-permissions/

Example URI

POST /research-sys/api/v1/kim-document-role-permissions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "rolePermissionId": "(val)",
    "roleId": "(val)",
    "permissionId": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "rolePermissionId": "(val)",
    "roleId": "(val)",
    "permissionId": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "rolePermissionId": "(val)",
    "roleId": "(val)",
    "permissionId": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "rolePermissionId": "(val)",
    "roleId": "(val)",
    "permissionId": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Kim Document Role Permissions by Key
DELETE/research-sys/api/v1/kim-document-role-permissions/(key)

Example URI

DELETE /research-sys/api/v1/kim-document-role-permissions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Kim Document Role Permissions
DELETE/research-sys/api/v1/kim-document-role-permissions/

Example URI

DELETE /research-sys/api/v1/kim-document-role-permissions/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Kim Document Role Permissions with Matching
DELETE/research-sys/api/v1/kim-document-role-permissions/

Example URI

DELETE /research-sys/api/v1/kim-document-role-permissions/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

rolePermissionId
string (optional) 
roleId
string (optional) 
permissionId
string (optional) 
documentNumber
string (optional) 
active
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Kim Document Role Qualifiers

Get Kim Document Role Qualifiers by Key
GET/research-sys/api/v1/kim-document-role-qualifiers/(key)

Example URI

GET /research-sys/api/v1/kim-document-role-qualifiers/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "roleMemberId": "(val)",
  "kimTypId": "(val)",
  "kimAttrDefnId": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "attrVal": "(val)",
  "active": "(val)",
  "attrDataId": "(val)",
  "_primaryKey": "(val)"
}

Get All Kim Document Role Qualifiers
GET/research-sys/api/v1/kim-document-role-qualifiers/

Example URI

GET /research-sys/api/v1/kim-document-role-qualifiers/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "roleMemberId": "(val)",
    "kimTypId": "(val)",
    "kimAttrDefnId": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "attrVal": "(val)",
    "active": "(val)",
    "attrDataId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "roleMemberId": "(val)",
    "kimTypId": "(val)",
    "kimAttrDefnId": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "attrVal": "(val)",
    "active": "(val)",
    "attrDataId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Kim Document Role Qualifiers with Filtering
GET/research-sys/api/v1/kim-document-role-qualifiers/

Example URI

GET /research-sys/api/v1/kim-document-role-qualifiers/
URI Parameters
HideShow
roleMemberId
string (optional) 

Role Member Id. Maximum length is 40.

kimTypId
string (optional) 

Kim Typ Id. Maximum length is 40.

kimAttrDefnId
string (optional) 

Kim Attr Defn Id. Maximum length is 40.

edit
string (optional) 

Edit.

documentNumber
string (optional) 

Document Number.

attrVal
string (optional) 

Attr Val. Maximum length is 400.

active
string (optional) 

Active.

attrDataId
string (optional) 

Attr Data Id. Maximum length is 40.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "roleMemberId": "(val)",
    "kimTypId": "(val)",
    "kimAttrDefnId": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "attrVal": "(val)",
    "active": "(val)",
    "attrDataId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "roleMemberId": "(val)",
    "kimTypId": "(val)",
    "kimAttrDefnId": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "attrVal": "(val)",
    "active": "(val)",
    "attrDataId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Kim Document Role Qualifiers
GET/research-sys/api/v1/kim-document-role-qualifiers/

Example URI

GET /research-sys/api/v1/kim-document-role-qualifiers/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "roleMemberId",
    "kimTypId",
    "kimAttrDefnId",
    "edit",
    "documentNumber",
    "attrVal",
    "active",
    "attrDataId"
  ],
  "primaryKey": "attrDataId"
}

Get Blueprint API specification for Kim Document Role Qualifiers
GET/research-sys/api/v1/kim-document-role-qualifiers/

Example URI

GET /research-sys/api/v1/kim-document-role-qualifiers/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Kim Document Role Qualifiers.md"
transfer-encoding: chunked

Update Kim Document Role Qualifiers
PUT/research-sys/api/v1/kim-document-role-qualifiers/(key)

Example URI

PUT /research-sys/api/v1/kim-document-role-qualifiers/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "roleMemberId": "(val)",
  "kimTypId": "(val)",
  "kimAttrDefnId": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "attrVal": "(val)",
  "active": "(val)",
  "attrDataId": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Kim Document Role Qualifiers
PUT/research-sys/api/v1/kim-document-role-qualifiers/

Example URI

PUT /research-sys/api/v1/kim-document-role-qualifiers/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "roleMemberId": "(val)",
    "kimTypId": "(val)",
    "kimAttrDefnId": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "attrVal": "(val)",
    "active": "(val)",
    "attrDataId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "roleMemberId": "(val)",
    "kimTypId": "(val)",
    "kimAttrDefnId": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "attrVal": "(val)",
    "active": "(val)",
    "attrDataId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Kim Document Role Qualifiers
PATCH/research-sys/api/v1/kim-document-role-qualifiers/(key)

Example URI

PATCH /research-sys/api/v1/kim-document-role-qualifiers/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "roleMemberId": "(val)",
  "kimTypId": "(val)",
  "kimAttrDefnId": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "attrVal": "(val)",
  "active": "(val)",
  "attrDataId": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "roleMemberId": "(val)",
  "kimTypId": "(val)",
  "kimAttrDefnId": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "attrVal": "(val)",
  "active": "(val)",
  "attrDataId": "(val)",
  "_primaryKey": "(val)"
}

Insert Kim Document Role Qualifiers
POST/research-sys/api/v1/kim-document-role-qualifiers/

Example URI

POST /research-sys/api/v1/kim-document-role-qualifiers/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "roleMemberId": "(val)",
  "kimTypId": "(val)",
  "kimAttrDefnId": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "attrVal": "(val)",
  "active": "(val)",
  "attrDataId": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "roleMemberId": "(val)",
  "kimTypId": "(val)",
  "kimAttrDefnId": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "attrVal": "(val)",
  "active": "(val)",
  "attrDataId": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Kim Document Role Qualifiers
POST/research-sys/api/v1/kim-document-role-qualifiers/

Example URI

POST /research-sys/api/v1/kim-document-role-qualifiers/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "roleMemberId": "(val)",
    "kimTypId": "(val)",
    "kimAttrDefnId": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "attrVal": "(val)",
    "active": "(val)",
    "attrDataId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "roleMemberId": "(val)",
    "kimTypId": "(val)",
    "kimAttrDefnId": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "attrVal": "(val)",
    "active": "(val)",
    "attrDataId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "roleMemberId": "(val)",
    "kimTypId": "(val)",
    "kimAttrDefnId": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "attrVal": "(val)",
    "active": "(val)",
    "attrDataId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "roleMemberId": "(val)",
    "kimTypId": "(val)",
    "kimAttrDefnId": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "attrVal": "(val)",
    "active": "(val)",
    "attrDataId": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Kim Document Role Qualifiers by Key
DELETE/research-sys/api/v1/kim-document-role-qualifiers/(key)

Example URI

DELETE /research-sys/api/v1/kim-document-role-qualifiers/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Kim Document Role Qualifiers
DELETE/research-sys/api/v1/kim-document-role-qualifiers/

Example URI

DELETE /research-sys/api/v1/kim-document-role-qualifiers/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Kim Document Role Qualifiers with Matching
DELETE/research-sys/api/v1/kim-document-role-qualifiers/

Example URI

DELETE /research-sys/api/v1/kim-document-role-qualifiers/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

roleMemberId
string (optional) 

Role Member Id. Maximum length is 40.

kimTypId
string (optional) 

Kim Typ Id. Maximum length is 40.

kimAttrDefnId
string (optional) 

Kim Attr Defn Id. Maximum length is 40.

edit
string (optional) 

Edit.

documentNumber
string (optional) 

Document Number.

attrVal
string (optional) 

Attr Val. Maximum length is 400.

active
string (optional) 

Active.

attrDataId
string (optional) 

Attr Data Id. Maximum length is 40.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Kim Document Role Responsibilities

Get Kim Document Role Responsibilities by Key
GET/research-sys/api/v1/kim-document-role-responsibilities/(key)

Example URI

GET /research-sys/api/v1/kim-document-role-responsibilities/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "roleResponsibilityId": "(val)",
  "roleId": "(val)",
  "responsibilityId": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Get All Kim Document Role Responsibilities
GET/research-sys/api/v1/kim-document-role-responsibilities/

Example URI

GET /research-sys/api/v1/kim-document-role-responsibilities/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "roleResponsibilityId": "(val)",
    "roleId": "(val)",
    "responsibilityId": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "roleResponsibilityId": "(val)",
    "roleId": "(val)",
    "responsibilityId": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Kim Document Role Responsibilities with Filtering
GET/research-sys/api/v1/kim-document-role-responsibilities/

Example URI

GET /research-sys/api/v1/kim-document-role-responsibilities/
URI Parameters
HideShow
roleResponsibilityId
string (optional) 
roleId
string (optional) 
responsibilityId
string (optional) 
documentNumber
string (optional) 
active
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "roleResponsibilityId": "(val)",
    "roleId": "(val)",
    "responsibilityId": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "roleResponsibilityId": "(val)",
    "roleId": "(val)",
    "responsibilityId": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Kim Document Role Responsibilities
GET/research-sys/api/v1/kim-document-role-responsibilities/

Example URI

GET /research-sys/api/v1/kim-document-role-responsibilities/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "roleResponsibilityId",
    "roleId",
    "responsibilityId",
    "documentNumber",
    "active"
  ],
  "primaryKey": "roleResponsibilityId"
}

Get Blueprint API specification for Kim Document Role Responsibilities
GET/research-sys/api/v1/kim-document-role-responsibilities/

Example URI

GET /research-sys/api/v1/kim-document-role-responsibilities/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Kim Document Role Responsibilities.md"
transfer-encoding: chunked

Update Kim Document Role Responsibilities
PUT/research-sys/api/v1/kim-document-role-responsibilities/(key)

Example URI

PUT /research-sys/api/v1/kim-document-role-responsibilities/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "roleResponsibilityId": "(val)",
  "roleId": "(val)",
  "responsibilityId": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Kim Document Role Responsibilities
PUT/research-sys/api/v1/kim-document-role-responsibilities/

Example URI

PUT /research-sys/api/v1/kim-document-role-responsibilities/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "roleResponsibilityId": "(val)",
    "roleId": "(val)",
    "responsibilityId": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "roleResponsibilityId": "(val)",
    "roleId": "(val)",
    "responsibilityId": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Kim Document Role Responsibilities
PATCH/research-sys/api/v1/kim-document-role-responsibilities/(key)

Example URI

PATCH /research-sys/api/v1/kim-document-role-responsibilities/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "roleResponsibilityId": "(val)",
  "roleId": "(val)",
  "responsibilityId": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "roleResponsibilityId": "(val)",
  "roleId": "(val)",
  "responsibilityId": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Kim Document Role Responsibilities
POST/research-sys/api/v1/kim-document-role-responsibilities/

Example URI

POST /research-sys/api/v1/kim-document-role-responsibilities/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "roleResponsibilityId": "(val)",
  "roleId": "(val)",
  "responsibilityId": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "roleResponsibilityId": "(val)",
  "roleId": "(val)",
  "responsibilityId": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Kim Document Role Responsibilities
POST/research-sys/api/v1/kim-document-role-responsibilities/

Example URI

POST /research-sys/api/v1/kim-document-role-responsibilities/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "roleResponsibilityId": "(val)",
    "roleId": "(val)",
    "responsibilityId": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "roleResponsibilityId": "(val)",
    "roleId": "(val)",
    "responsibilityId": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "roleResponsibilityId": "(val)",
    "roleId": "(val)",
    "responsibilityId": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "roleResponsibilityId": "(val)",
    "roleId": "(val)",
    "responsibilityId": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Kim Document Role Responsibilities by Key
DELETE/research-sys/api/v1/kim-document-role-responsibilities/(key)

Example URI

DELETE /research-sys/api/v1/kim-document-role-responsibilities/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Kim Document Role Responsibilities
DELETE/research-sys/api/v1/kim-document-role-responsibilities/

Example URI

DELETE /research-sys/api/v1/kim-document-role-responsibilities/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Kim Document Role Responsibilities with Matching
DELETE/research-sys/api/v1/kim-document-role-responsibilities/

Example URI

DELETE /research-sys/api/v1/kim-document-role-responsibilities/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

roleResponsibilityId
string (optional) 
roleId
string (optional) 
responsibilityId
string (optional) 
documentNumber
string (optional) 
active
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Kim Document Role Responsibility Actions

Get Kim Document Role Responsibility Actions by Key
GET/research-sys/api/v1/kim-document-role-responsibility-actions/(key)

Example URI

GET /research-sys/api/v1/kim-document-role-responsibility-actions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "roleResponsibilityActionId": "(val)",
  "roleResponsibilityId": "(val)",
  "roleMemberId": "(val)",
  "actionTypeCode": "(val)",
  "actionPolicyCode": "(val)",
  "priorityNumber": "(val)",
  "forceAction": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "_primaryKey": "(val)"
}

Get All Kim Document Role Responsibility Actions
GET/research-sys/api/v1/kim-document-role-responsibility-actions/

Example URI

GET /research-sys/api/v1/kim-document-role-responsibility-actions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "roleResponsibilityActionId": "(val)",
    "roleResponsibilityId": "(val)",
    "roleMemberId": "(val)",
    "actionTypeCode": "(val)",
    "actionPolicyCode": "(val)",
    "priorityNumber": "(val)",
    "forceAction": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "roleResponsibilityActionId": "(val)",
    "roleResponsibilityId": "(val)",
    "roleMemberId": "(val)",
    "actionTypeCode": "(val)",
    "actionPolicyCode": "(val)",
    "priorityNumber": "(val)",
    "forceAction": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Kim Document Role Responsibility Actions with Filtering
GET/research-sys/api/v1/kim-document-role-responsibility-actions/

Example URI

GET /research-sys/api/v1/kim-document-role-responsibility-actions/
URI Parameters
HideShow
roleResponsibilityActionId
string (optional) 

Role Responsibility Action Id. Maximum length is 40.

roleResponsibilityId
string (optional) 

Role Responsibility Id. Maximum length is 40.

roleMemberId
string (optional) 

Role Member Id. Maximum length is 40.

actionTypeCode
string (optional) 

Action Type Code. Maximum length is 40.

actionPolicyCode
string (optional) 

Action Policy Code. Maximum length is 40.

priorityNumber
string (optional) 

Priority Number. Maximum length is 3.

forceAction
string (optional) 

Require Redundant Action. Maximum length is 1.

edit
string (optional) 

Edit.

documentNumber
string (optional) 

Document Number.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "roleResponsibilityActionId": "(val)",
    "roleResponsibilityId": "(val)",
    "roleMemberId": "(val)",
    "actionTypeCode": "(val)",
    "actionPolicyCode": "(val)",
    "priorityNumber": "(val)",
    "forceAction": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "roleResponsibilityActionId": "(val)",
    "roleResponsibilityId": "(val)",
    "roleMemberId": "(val)",
    "actionTypeCode": "(val)",
    "actionPolicyCode": "(val)",
    "priorityNumber": "(val)",
    "forceAction": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Kim Document Role Responsibility Actions
GET/research-sys/api/v1/kim-document-role-responsibility-actions/

Example URI

GET /research-sys/api/v1/kim-document-role-responsibility-actions/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "roleResponsibilityActionId",
    "roleResponsibilityId",
    "roleMemberId",
    "actionTypeCode",
    "actionPolicyCode",
    "priorityNumber",
    "forceAction",
    "edit",
    "documentNumber"
  ],
  "primaryKey": "roleResponsibilityActionId"
}

Get Blueprint API specification for Kim Document Role Responsibility Actions
GET/research-sys/api/v1/kim-document-role-responsibility-actions/

Example URI

GET /research-sys/api/v1/kim-document-role-responsibility-actions/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Kim Document Role Responsibility Actions.md"
transfer-encoding: chunked

Update Kim Document Role Responsibility Actions
PUT/research-sys/api/v1/kim-document-role-responsibility-actions/(key)

Example URI

PUT /research-sys/api/v1/kim-document-role-responsibility-actions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "roleResponsibilityActionId": "(val)",
  "roleResponsibilityId": "(val)",
  "roleMemberId": "(val)",
  "actionTypeCode": "(val)",
  "actionPolicyCode": "(val)",
  "priorityNumber": "(val)",
  "forceAction": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Kim Document Role Responsibility Actions
PUT/research-sys/api/v1/kim-document-role-responsibility-actions/

Example URI

PUT /research-sys/api/v1/kim-document-role-responsibility-actions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "roleResponsibilityActionId": "(val)",
    "roleResponsibilityId": "(val)",
    "roleMemberId": "(val)",
    "actionTypeCode": "(val)",
    "actionPolicyCode": "(val)",
    "priorityNumber": "(val)",
    "forceAction": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "roleResponsibilityActionId": "(val)",
    "roleResponsibilityId": "(val)",
    "roleMemberId": "(val)",
    "actionTypeCode": "(val)",
    "actionPolicyCode": "(val)",
    "priorityNumber": "(val)",
    "forceAction": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Kim Document Role Responsibility Actions
PATCH/research-sys/api/v1/kim-document-role-responsibility-actions/(key)

Example URI

PATCH /research-sys/api/v1/kim-document-role-responsibility-actions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "roleResponsibilityActionId": "(val)",
  "roleResponsibilityId": "(val)",
  "roleMemberId": "(val)",
  "actionTypeCode": "(val)",
  "actionPolicyCode": "(val)",
  "priorityNumber": "(val)",
  "forceAction": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "roleResponsibilityActionId": "(val)",
  "roleResponsibilityId": "(val)",
  "roleMemberId": "(val)",
  "actionTypeCode": "(val)",
  "actionPolicyCode": "(val)",
  "priorityNumber": "(val)",
  "forceAction": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "_primaryKey": "(val)"
}

Insert Kim Document Role Responsibility Actions
POST/research-sys/api/v1/kim-document-role-responsibility-actions/

Example URI

POST /research-sys/api/v1/kim-document-role-responsibility-actions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "roleResponsibilityActionId": "(val)",
  "roleResponsibilityId": "(val)",
  "roleMemberId": "(val)",
  "actionTypeCode": "(val)",
  "actionPolicyCode": "(val)",
  "priorityNumber": "(val)",
  "forceAction": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "roleResponsibilityActionId": "(val)",
  "roleResponsibilityId": "(val)",
  "roleMemberId": "(val)",
  "actionTypeCode": "(val)",
  "actionPolicyCode": "(val)",
  "priorityNumber": "(val)",
  "forceAction": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Kim Document Role Responsibility Actions
POST/research-sys/api/v1/kim-document-role-responsibility-actions/

Example URI

POST /research-sys/api/v1/kim-document-role-responsibility-actions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "roleResponsibilityActionId": "(val)",
    "roleResponsibilityId": "(val)",
    "roleMemberId": "(val)",
    "actionTypeCode": "(val)",
    "actionPolicyCode": "(val)",
    "priorityNumber": "(val)",
    "forceAction": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "roleResponsibilityActionId": "(val)",
    "roleResponsibilityId": "(val)",
    "roleMemberId": "(val)",
    "actionTypeCode": "(val)",
    "actionPolicyCode": "(val)",
    "priorityNumber": "(val)",
    "forceAction": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "roleResponsibilityActionId": "(val)",
    "roleResponsibilityId": "(val)",
    "roleMemberId": "(val)",
    "actionTypeCode": "(val)",
    "actionPolicyCode": "(val)",
    "priorityNumber": "(val)",
    "forceAction": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "roleResponsibilityActionId": "(val)",
    "roleResponsibilityId": "(val)",
    "roleMemberId": "(val)",
    "actionTypeCode": "(val)",
    "actionPolicyCode": "(val)",
    "priorityNumber": "(val)",
    "forceAction": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Kim Document Role Responsibility Actions by Key
DELETE/research-sys/api/v1/kim-document-role-responsibility-actions/(key)

Example URI

DELETE /research-sys/api/v1/kim-document-role-responsibility-actions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Kim Document Role Responsibility Actions
DELETE/research-sys/api/v1/kim-document-role-responsibility-actions/

Example URI

DELETE /research-sys/api/v1/kim-document-role-responsibility-actions/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Kim Document Role Responsibility Actions with Matching
DELETE/research-sys/api/v1/kim-document-role-responsibility-actions/

Example URI

DELETE /research-sys/api/v1/kim-document-role-responsibility-actions/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

roleResponsibilityActionId
string (optional) 

Role Responsibility Action Id. Maximum length is 40.

roleResponsibilityId
string (optional) 

Role Responsibility Id. Maximum length is 40.

roleMemberId
string (optional) 

Role Member Id. Maximum length is 40.

actionTypeCode
string (optional) 

Action Type Code. Maximum length is 40.

actionPolicyCode
string (optional) 

Action Policy Code. Maximum length is 40.

priorityNumber
string (optional) 

Priority Number. Maximum length is 3.

forceAction
string (optional) 

Require Redundant Action. Maximum length is 1.

edit
string (optional) 

Edit.

documentNumber
string (optional) 

Document Number.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Kim Type Attributes

Get Kim Type Attributes by Key
GET/research-sys/api/v1/kim-type-attributes/(key)

Example URI

GET /research-sys/api/v1/kim-type-attributes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "sortCode": "(val)",
  "kimAttributeId": "(val)",
  "kimTypeId": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Get All Kim Type Attributes
GET/research-sys/api/v1/kim-type-attributes/

Example URI

GET /research-sys/api/v1/kim-type-attributes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "sortCode": "(val)",
    "kimAttributeId": "(val)",
    "kimTypeId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "sortCode": "(val)",
    "kimAttributeId": "(val)",
    "kimTypeId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Kim Type Attributes with Filtering
GET/research-sys/api/v1/kim-type-attributes/

Example URI

GET /research-sys/api/v1/kim-type-attributes/
URI Parameters
HideShow
id
string (optional) 
sortCode
string (optional) 
kimAttributeId
string (optional) 
kimTypeId
string (optional) 
active
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "sortCode": "(val)",
    "kimAttributeId": "(val)",
    "kimTypeId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "sortCode": "(val)",
    "kimAttributeId": "(val)",
    "kimTypeId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Kim Type Attributes
GET/research-sys/api/v1/kim-type-attributes/

Example URI

GET /research-sys/api/v1/kim-type-attributes/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "sortCode",
    "kimAttributeId",
    "kimTypeId",
    "active"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Kim Type Attributes
GET/research-sys/api/v1/kim-type-attributes/

Example URI

GET /research-sys/api/v1/kim-type-attributes/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Kim Type Attributes.md"
transfer-encoding: chunked

Update Kim Type Attributes
PUT/research-sys/api/v1/kim-type-attributes/(key)

Example URI

PUT /research-sys/api/v1/kim-type-attributes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "sortCode": "(val)",
  "kimAttributeId": "(val)",
  "kimTypeId": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Kim Type Attributes
PUT/research-sys/api/v1/kim-type-attributes/

Example URI

PUT /research-sys/api/v1/kim-type-attributes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "sortCode": "(val)",
    "kimAttributeId": "(val)",
    "kimTypeId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "sortCode": "(val)",
    "kimAttributeId": "(val)",
    "kimTypeId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Kim Type Attributes
PATCH/research-sys/api/v1/kim-type-attributes/(key)

Example URI

PATCH /research-sys/api/v1/kim-type-attributes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "sortCode": "(val)",
  "kimAttributeId": "(val)",
  "kimTypeId": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "sortCode": "(val)",
  "kimAttributeId": "(val)",
  "kimTypeId": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Kim Type Attributes
POST/research-sys/api/v1/kim-type-attributes/

Example URI

POST /research-sys/api/v1/kim-type-attributes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "sortCode": "(val)",
  "kimAttributeId": "(val)",
  "kimTypeId": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "sortCode": "(val)",
  "kimAttributeId": "(val)",
  "kimTypeId": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Kim Type Attributes
POST/research-sys/api/v1/kim-type-attributes/

Example URI

POST /research-sys/api/v1/kim-type-attributes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "sortCode": "(val)",
    "kimAttributeId": "(val)",
    "kimTypeId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "sortCode": "(val)",
    "kimAttributeId": "(val)",
    "kimTypeId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "sortCode": "(val)",
    "kimAttributeId": "(val)",
    "kimTypeId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "sortCode": "(val)",
    "kimAttributeId": "(val)",
    "kimTypeId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Kim Type Attributes by Key
DELETE/research-sys/api/v1/kim-type-attributes/(key)

Example URI

DELETE /research-sys/api/v1/kim-type-attributes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Kim Type Attributes
DELETE/research-sys/api/v1/kim-type-attributes/

Example URI

DELETE /research-sys/api/v1/kim-type-attributes/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Kim Type Attributes with Matching
DELETE/research-sys/api/v1/kim-type-attributes/

Example URI

DELETE /research-sys/api/v1/kim-type-attributes/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 
sortCode
string (optional) 
kimAttributeId
string (optional) 
kimTypeId
string (optional) 
active
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Kim Types

Get Kim Types by Key
GET/research-sys/api/v1/kim-types/(key)

Example URI

GET /research-sys/api/v1/kim-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "serviceName": "(val)",
  "namespaceCode": "(val)",
  "name": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Get All Kim Types
GET/research-sys/api/v1/kim-types/

Example URI

GET /research-sys/api/v1/kim-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "serviceName": "(val)",
    "namespaceCode": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "serviceName": "(val)",
    "namespaceCode": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Kim Types with Filtering
GET/research-sys/api/v1/kim-types/

Example URI

GET /research-sys/api/v1/kim-types/
URI Parameters
HideShow
id
string (optional) 

Type Identifier. Maximum length is 40.

serviceName
string (optional) 

Srvc Nm. Maximum length is 200.

namespaceCode
string (optional) 

Nmspc Cd. Maximum length is 20.

name
string (optional) 

Nm. Maximum length is 100.

active
string (optional) 

This attribute is used to describe whether the associated object is active or inactive. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "serviceName": "(val)",
    "namespaceCode": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "serviceName": "(val)",
    "namespaceCode": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Kim Types
GET/research-sys/api/v1/kim-types/

Example URI

GET /research-sys/api/v1/kim-types/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "serviceName",
    "namespaceCode",
    "name",
    "active"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Kim Types
GET/research-sys/api/v1/kim-types/

Example URI

GET /research-sys/api/v1/kim-types/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Kim Types.md"
transfer-encoding: chunked

Update Kim Types
PUT/research-sys/api/v1/kim-types/(key)

Example URI

PUT /research-sys/api/v1/kim-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "serviceName": "(val)",
  "namespaceCode": "(val)",
  "name": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Kim Types
PUT/research-sys/api/v1/kim-types/

Example URI

PUT /research-sys/api/v1/kim-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "serviceName": "(val)",
    "namespaceCode": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "serviceName": "(val)",
    "namespaceCode": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Kim Types
PATCH/research-sys/api/v1/kim-types/(key)

Example URI

PATCH /research-sys/api/v1/kim-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "serviceName": "(val)",
  "namespaceCode": "(val)",
  "name": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "serviceName": "(val)",
  "namespaceCode": "(val)",
  "name": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Kim Types
POST/research-sys/api/v1/kim-types/

Example URI

POST /research-sys/api/v1/kim-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "serviceName": "(val)",
  "namespaceCode": "(val)",
  "name": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "serviceName": "(val)",
  "namespaceCode": "(val)",
  "name": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Kim Types
POST/research-sys/api/v1/kim-types/

Example URI

POST /research-sys/api/v1/kim-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "serviceName": "(val)",
    "namespaceCode": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "serviceName": "(val)",
    "namespaceCode": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "serviceName": "(val)",
    "namespaceCode": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "serviceName": "(val)",
    "namespaceCode": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Kim Types by Key
DELETE/research-sys/api/v1/kim-types/(key)

Example URI

DELETE /research-sys/api/v1/kim-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Kim Types
DELETE/research-sys/api/v1/kim-types/

Example URI

DELETE /research-sys/api/v1/kim-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Kim Types with Matching
DELETE/research-sys/api/v1/kim-types/

Example URI

DELETE /research-sys/api/v1/kim-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 

Type Identifier. Maximum length is 40.

serviceName
string (optional) 

Srvc Nm. Maximum length is 200.

namespaceCode
string (optional) 

Nmspc Cd. Maximum length is 20.

name
string (optional) 

Nm. Maximum length is 100.

active
string (optional) 

This attribute is used to describe whether the associated object is active or inactive. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Krms Attribute Definitions

Get Krms Attribute Definitions by Key
GET/research-sys/api/v1/krms-attribute-definitions/(key)

Example URI

GET /research-sys/api/v1/krms-attribute-definitions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "name": "(val)",
  "namespace": "(val)",
  "label": "(val)",
  "description": "(val)",
  "active": "(val)",
  "componentName": "(val)",
  "_primaryKey": "(val)"
}

Get All Krms Attribute Definitions
GET/research-sys/api/v1/krms-attribute-definitions/

Example URI

GET /research-sys/api/v1/krms-attribute-definitions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "label": "(val)",
    "description": "(val)",
    "active": "(val)",
    "componentName": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "label": "(val)",
    "description": "(val)",
    "active": "(val)",
    "componentName": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Krms Attribute Definitions with Filtering
GET/research-sys/api/v1/krms-attribute-definitions/

Example URI

GET /research-sys/api/v1/krms-attribute-definitions/
URI Parameters
HideShow
id
string (optional) 

Attribute Id.

name
string (optional) 

Attribute Name.

namespace
string (optional) 

Attribute Namespace.

label
string (optional) 

Attribute Label.

description
string (optional) 

Description.

active
string (optional) 

This attribute is used to describe whether the associated object is active or inactive. Maximum length is 1.

componentName
string (optional) 

Attribute Component Name.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "label": "(val)",
    "description": "(val)",
    "active": "(val)",
    "componentName": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "label": "(val)",
    "description": "(val)",
    "active": "(val)",
    "componentName": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Krms Attribute Definitions
GET/research-sys/api/v1/krms-attribute-definitions/

Example URI

GET /research-sys/api/v1/krms-attribute-definitions/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "name",
    "namespace",
    "label",
    "description",
    "active",
    "componentName"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Krms Attribute Definitions
GET/research-sys/api/v1/krms-attribute-definitions/

Example URI

GET /research-sys/api/v1/krms-attribute-definitions/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Krms Attribute Definitions.md"
transfer-encoding: chunked

Update Krms Attribute Definitions
PUT/research-sys/api/v1/krms-attribute-definitions/(key)

Example URI

PUT /research-sys/api/v1/krms-attribute-definitions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "name": "(val)",
  "namespace": "(val)",
  "label": "(val)",
  "description": "(val)",
  "active": "(val)",
  "componentName": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Krms Attribute Definitions
PUT/research-sys/api/v1/krms-attribute-definitions/

Example URI

PUT /research-sys/api/v1/krms-attribute-definitions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "label": "(val)",
    "description": "(val)",
    "active": "(val)",
    "componentName": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "label": "(val)",
    "description": "(val)",
    "active": "(val)",
    "componentName": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Krms Attribute Definitions
PATCH/research-sys/api/v1/krms-attribute-definitions/(key)

Example URI

PATCH /research-sys/api/v1/krms-attribute-definitions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "name": "(val)",
  "namespace": "(val)",
  "label": "(val)",
  "description": "(val)",
  "active": "(val)",
  "componentName": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "name": "(val)",
  "namespace": "(val)",
  "label": "(val)",
  "description": "(val)",
  "active": "(val)",
  "componentName": "(val)",
  "_primaryKey": "(val)"
}

Insert Krms Attribute Definitions
POST/research-sys/api/v1/krms-attribute-definitions/

Example URI

POST /research-sys/api/v1/krms-attribute-definitions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "name": "(val)",
  "namespace": "(val)",
  "label": "(val)",
  "description": "(val)",
  "active": "(val)",
  "componentName": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "name": "(val)",
  "namespace": "(val)",
  "label": "(val)",
  "description": "(val)",
  "active": "(val)",
  "componentName": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Krms Attribute Definitions
POST/research-sys/api/v1/krms-attribute-definitions/

Example URI

POST /research-sys/api/v1/krms-attribute-definitions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "label": "(val)",
    "description": "(val)",
    "active": "(val)",
    "componentName": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "label": "(val)",
    "description": "(val)",
    "active": "(val)",
    "componentName": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "label": "(val)",
    "description": "(val)",
    "active": "(val)",
    "componentName": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "label": "(val)",
    "description": "(val)",
    "active": "(val)",
    "componentName": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Krms Attribute Definitions by Key
DELETE/research-sys/api/v1/krms-attribute-definitions/(key)

Example URI

DELETE /research-sys/api/v1/krms-attribute-definitions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Krms Attribute Definitions
DELETE/research-sys/api/v1/krms-attribute-definitions/

Example URI

DELETE /research-sys/api/v1/krms-attribute-definitions/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Krms Attribute Definitions with Matching
DELETE/research-sys/api/v1/krms-attribute-definitions/

Example URI

DELETE /research-sys/api/v1/krms-attribute-definitions/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 

Attribute Id.

name
string (optional) 

Attribute Name.

namespace
string (optional) 

Attribute Namespace.

label
string (optional) 

Attribute Label.

description
string (optional) 

Description.

active
string (optional) 

This attribute is used to describe whether the associated object is active or inactive. Maximum length is 1.

componentName
string (optional) 

Attribute Component Name.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Krms Type Attributes

Get Krms Type Attributes by Key
GET/research-sys/api/v1/krms-type-attributes/(key)

Example URI

GET /research-sys/api/v1/krms-type-attributes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "sequenceNumber": "(val)",
  "active": "(val)",
  "attributeDefinitionId": "(val)",
  "_primaryKey": "(val)"
}

Get All Krms Type Attributes
GET/research-sys/api/v1/krms-type-attributes/

Example URI

GET /research-sys/api/v1/krms-type-attributes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "sequenceNumber": "(val)",
    "active": "(val)",
    "attributeDefinitionId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "sequenceNumber": "(val)",
    "active": "(val)",
    "attributeDefinitionId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Krms Type Attributes with Filtering
GET/research-sys/api/v1/krms-type-attributes/

Example URI

GET /research-sys/api/v1/krms-type-attributes/
URI Parameters
HideShow
id
string (optional) 
sequenceNumber
string (optional) 
active
string (optional) 
attributeDefinitionId
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "sequenceNumber": "(val)",
    "active": "(val)",
    "attributeDefinitionId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "sequenceNumber": "(val)",
    "active": "(val)",
    "attributeDefinitionId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Krms Type Attributes
GET/research-sys/api/v1/krms-type-attributes/

Example URI

GET /research-sys/api/v1/krms-type-attributes/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "sequenceNumber",
    "active",
    "attributeDefinitionId"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Krms Type Attributes
GET/research-sys/api/v1/krms-type-attributes/

Example URI

GET /research-sys/api/v1/krms-type-attributes/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Krms Type Attributes.md"
transfer-encoding: chunked

Update Krms Type Attributes
PUT/research-sys/api/v1/krms-type-attributes/(key)

Example URI

PUT /research-sys/api/v1/krms-type-attributes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "sequenceNumber": "(val)",
  "active": "(val)",
  "attributeDefinitionId": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Krms Type Attributes
PUT/research-sys/api/v1/krms-type-attributes/

Example URI

PUT /research-sys/api/v1/krms-type-attributes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "sequenceNumber": "(val)",
    "active": "(val)",
    "attributeDefinitionId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "sequenceNumber": "(val)",
    "active": "(val)",
    "attributeDefinitionId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Krms Type Attributes
PATCH/research-sys/api/v1/krms-type-attributes/(key)

Example URI

PATCH /research-sys/api/v1/krms-type-attributes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "sequenceNumber": "(val)",
  "active": "(val)",
  "attributeDefinitionId": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "sequenceNumber": "(val)",
  "active": "(val)",
  "attributeDefinitionId": "(val)",
  "_primaryKey": "(val)"
}

Insert Krms Type Attributes
POST/research-sys/api/v1/krms-type-attributes/

Example URI

POST /research-sys/api/v1/krms-type-attributes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "sequenceNumber": "(val)",
  "active": "(val)",
  "attributeDefinitionId": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "sequenceNumber": "(val)",
  "active": "(val)",
  "attributeDefinitionId": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Krms Type Attributes
POST/research-sys/api/v1/krms-type-attributes/

Example URI

POST /research-sys/api/v1/krms-type-attributes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "sequenceNumber": "(val)",
    "active": "(val)",
    "attributeDefinitionId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "sequenceNumber": "(val)",
    "active": "(val)",
    "attributeDefinitionId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "sequenceNumber": "(val)",
    "active": "(val)",
    "attributeDefinitionId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "sequenceNumber": "(val)",
    "active": "(val)",
    "attributeDefinitionId": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Krms Type Attributes by Key
DELETE/research-sys/api/v1/krms-type-attributes/(key)

Example URI

DELETE /research-sys/api/v1/krms-type-attributes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Krms Type Attributes
DELETE/research-sys/api/v1/krms-type-attributes/

Example URI

DELETE /research-sys/api/v1/krms-type-attributes/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Krms Type Attributes with Matching
DELETE/research-sys/api/v1/krms-type-attributes/

Example URI

DELETE /research-sys/api/v1/krms-type-attributes/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 
sequenceNumber
string (optional) 
active
string (optional) 
attributeDefinitionId
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Krms Types

Get Krms Types by Key
GET/research-sys/api/v1/krms-types/(key)

Example URI

GET /research-sys/api/v1/krms-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "name": "(val)",
  "namespace": "(val)",
  "serviceName": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Get All Krms Types
GET/research-sys/api/v1/krms-types/

Example URI

GET /research-sys/api/v1/krms-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "serviceName": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "serviceName": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Krms Types with Filtering
GET/research-sys/api/v1/krms-types/

Example URI

GET /research-sys/api/v1/krms-types/
URI Parameters
HideShow
id
string (optional) 
name
string (optional) 
namespace
string (optional) 
serviceName
string (optional) 
active
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "serviceName": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "serviceName": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Krms Types
GET/research-sys/api/v1/krms-types/

Example URI

GET /research-sys/api/v1/krms-types/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "name",
    "namespace",
    "serviceName",
    "active"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Krms Types
GET/research-sys/api/v1/krms-types/

Example URI

GET /research-sys/api/v1/krms-types/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Krms Types.md"
transfer-encoding: chunked

Update Krms Types
PUT/research-sys/api/v1/krms-types/(key)

Example URI

PUT /research-sys/api/v1/krms-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "name": "(val)",
  "namespace": "(val)",
  "serviceName": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Krms Types
PUT/research-sys/api/v1/krms-types/

Example URI

PUT /research-sys/api/v1/krms-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "serviceName": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "serviceName": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Krms Types
PATCH/research-sys/api/v1/krms-types/(key)

Example URI

PATCH /research-sys/api/v1/krms-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "name": "(val)",
  "namespace": "(val)",
  "serviceName": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "name": "(val)",
  "namespace": "(val)",
  "serviceName": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Krms Types
POST/research-sys/api/v1/krms-types/

Example URI

POST /research-sys/api/v1/krms-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "name": "(val)",
  "namespace": "(val)",
  "serviceName": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "name": "(val)",
  "namespace": "(val)",
  "serviceName": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Krms Types
POST/research-sys/api/v1/krms-types/

Example URI

POST /research-sys/api/v1/krms-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "serviceName": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "serviceName": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "serviceName": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "serviceName": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Krms Types by Key
DELETE/research-sys/api/v1/krms-types/(key)

Example URI

DELETE /research-sys/api/v1/krms-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Krms Types
DELETE/research-sys/api/v1/krms-types/

Example URI

DELETE /research-sys/api/v1/krms-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Krms Types with Matching
DELETE/research-sys/api/v1/krms-types/

Example URI

DELETE /research-sys/api/v1/krms-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 
name
string (optional) 
namespace
string (optional) 
serviceName
string (optional) 
active
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Lite View Roles

Get Lite View Roles by Key
GET/research-sys/api/v1/lite-view-roles/(key)

Example URI

GET /research-sys/api/v1/lite-view-roles/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "name": "(val)",
  "description": "(val)",
  "active": "(val)",
  "kimTypeId": "(val)",
  "namespaceCode": "(val)",
  "_primaryKey": "(val)"
}

Get All Lite View Roles
GET/research-sys/api/v1/lite-view-roles/

Example URI

GET /research-sys/api/v1/lite-view-roles/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "active": "(val)",
    "kimTypeId": "(val)",
    "namespaceCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "active": "(val)",
    "kimTypeId": "(val)",
    "namespaceCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Lite View Roles with Filtering
GET/research-sys/api/v1/lite-view-roles/

Example URI

GET /research-sys/api/v1/lite-view-roles/
URI Parameters
HideShow
id
string (optional) 
name
string (optional) 
description
string (optional) 
active
string (optional) 
kimTypeId
string (optional) 
namespaceCode
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "active": "(val)",
    "kimTypeId": "(val)",
    "namespaceCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "active": "(val)",
    "kimTypeId": "(val)",
    "namespaceCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Lite View Roles
GET/research-sys/api/v1/lite-view-roles/

Example URI

GET /research-sys/api/v1/lite-view-roles/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "name",
    "description",
    "active",
    "kimTypeId",
    "namespaceCode"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Lite View Roles
GET/research-sys/api/v1/lite-view-roles/

Example URI

GET /research-sys/api/v1/lite-view-roles/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Lite View Roles.md"
transfer-encoding: chunked

Update Lite View Roles
PUT/research-sys/api/v1/lite-view-roles/(key)

Example URI

PUT /research-sys/api/v1/lite-view-roles/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "name": "(val)",
  "description": "(val)",
  "active": "(val)",
  "kimTypeId": "(val)",
  "namespaceCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Lite View Roles
PUT/research-sys/api/v1/lite-view-roles/

Example URI

PUT /research-sys/api/v1/lite-view-roles/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "active": "(val)",
    "kimTypeId": "(val)",
    "namespaceCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "active": "(val)",
    "kimTypeId": "(val)",
    "namespaceCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Lite View Roles
PATCH/research-sys/api/v1/lite-view-roles/(key)

Example URI

PATCH /research-sys/api/v1/lite-view-roles/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "name": "(val)",
  "description": "(val)",
  "active": "(val)",
  "kimTypeId": "(val)",
  "namespaceCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "name": "(val)",
  "description": "(val)",
  "active": "(val)",
  "kimTypeId": "(val)",
  "namespaceCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Lite View Roles
POST/research-sys/api/v1/lite-view-roles/

Example URI

POST /research-sys/api/v1/lite-view-roles/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "name": "(val)",
  "description": "(val)",
  "active": "(val)",
  "kimTypeId": "(val)",
  "namespaceCode": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "name": "(val)",
  "description": "(val)",
  "active": "(val)",
  "kimTypeId": "(val)",
  "namespaceCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Lite View Roles
POST/research-sys/api/v1/lite-view-roles/

Example URI

POST /research-sys/api/v1/lite-view-roles/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "active": "(val)",
    "kimTypeId": "(val)",
    "namespaceCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "active": "(val)",
    "kimTypeId": "(val)",
    "namespaceCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "active": "(val)",
    "kimTypeId": "(val)",
    "namespaceCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "active": "(val)",
    "kimTypeId": "(val)",
    "namespaceCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Lite View Roles by Key
DELETE/research-sys/api/v1/lite-view-roles/(key)

Example URI

DELETE /research-sys/api/v1/lite-view-roles/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Lite View Roles
DELETE/research-sys/api/v1/lite-view-roles/

Example URI

DELETE /research-sys/api/v1/lite-view-roles/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Lite View Roles with Matching
DELETE/research-sys/api/v1/lite-view-roles/

Example URI

DELETE /research-sys/api/v1/lite-view-roles/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 
name
string (optional) 
description
string (optional) 
active
string (optional) 
kimTypeId
string (optional) 
namespaceCode
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Maintenance Document Bases

Get Maintenance Document Bases by Key
GET/research-sys/api/v1/maintenance-document-bases/(key)

Example URI

GET /research-sys/api/v1/maintenance-document-bases/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "xmlDocumentContents": "(val)",
  "documentNumber": "(val)",
  "_primaryKey": "(val)"
}

Get All Maintenance Document Bases
GET/research-sys/api/v1/maintenance-document-bases/

Example URI

GET /research-sys/api/v1/maintenance-document-bases/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "xmlDocumentContents": "(val)",
    "documentNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "xmlDocumentContents": "(val)",
    "documentNumber": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Maintenance Document Bases with Filtering
GET/research-sys/api/v1/maintenance-document-bases/

Example URI

GET /research-sys/api/v1/maintenance-document-bases/
URI Parameters
HideShow
xmlDocumentContents
string (optional) 
documentNumber
string (optional) 

Document Number. Maximum length is 14.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "xmlDocumentContents": "(val)",
    "documentNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "xmlDocumentContents": "(val)",
    "documentNumber": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Maintenance Document Bases
GET/research-sys/api/v1/maintenance-document-bases/

Example URI

GET /research-sys/api/v1/maintenance-document-bases/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "xmlDocumentContents",
    "documentNumber"
  ],
  "primaryKey": "documentNumber"
}

Get Blueprint API specification for Maintenance Document Bases
GET/research-sys/api/v1/maintenance-document-bases/

Example URI

GET /research-sys/api/v1/maintenance-document-bases/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Maintenance Document Bases.md"
transfer-encoding: chunked

Update Maintenance Document Bases
PUT/research-sys/api/v1/maintenance-document-bases/(key)

Example URI

PUT /research-sys/api/v1/maintenance-document-bases/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "xmlDocumentContents": "(val)",
  "documentNumber": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Maintenance Document Bases
PUT/research-sys/api/v1/maintenance-document-bases/

Example URI

PUT /research-sys/api/v1/maintenance-document-bases/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "xmlDocumentContents": "(val)",
    "documentNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "xmlDocumentContents": "(val)",
    "documentNumber": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Maintenance Document Bases
PATCH/research-sys/api/v1/maintenance-document-bases/(key)

Example URI

PATCH /research-sys/api/v1/maintenance-document-bases/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "xmlDocumentContents": "(val)",
  "documentNumber": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "xmlDocumentContents": "(val)",
  "documentNumber": "(val)",
  "_primaryKey": "(val)"
}

Insert Maintenance Document Bases
POST/research-sys/api/v1/maintenance-document-bases/

Example URI

POST /research-sys/api/v1/maintenance-document-bases/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "xmlDocumentContents": "(val)",
  "documentNumber": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "xmlDocumentContents": "(val)",
  "documentNumber": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Maintenance Document Bases
POST/research-sys/api/v1/maintenance-document-bases/

Example URI

POST /research-sys/api/v1/maintenance-document-bases/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "xmlDocumentContents": "(val)",
    "documentNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "xmlDocumentContents": "(val)",
    "documentNumber": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "xmlDocumentContents": "(val)",
    "documentNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "xmlDocumentContents": "(val)",
    "documentNumber": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Maintenance Document Bases by Key
DELETE/research-sys/api/v1/maintenance-document-bases/(key)

Example URI

DELETE /research-sys/api/v1/maintenance-document-bases/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Maintenance Document Bases
DELETE/research-sys/api/v1/maintenance-document-bases/

Example URI

DELETE /research-sys/api/v1/maintenance-document-bases/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Maintenance Document Bases with Matching
DELETE/research-sys/api/v1/maintenance-document-bases/

Example URI

DELETE /research-sys/api/v1/maintenance-document-bases/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

xmlDocumentContents
string (optional) 
documentNumber
string (optional) 

Document Number. Maximum length is 14.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Maintenance Locks

Get Maintenance Locks by Key
GET/research-sys/api/v1/maintenance-locks/(key)

Example URI

GET /research-sys/api/v1/maintenance-locks/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "lockId": "(val)",
  "lockingRepresentation": "(val)",
  "documentNumber": "(val)",
  "_primaryKey": "(val)"
}

Get All Maintenance Locks
GET/research-sys/api/v1/maintenance-locks/

Example URI

GET /research-sys/api/v1/maintenance-locks/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "lockId": "(val)",
    "lockingRepresentation": "(val)",
    "documentNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "lockId": "(val)",
    "lockingRepresentation": "(val)",
    "documentNumber": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Maintenance Locks with Filtering
GET/research-sys/api/v1/maintenance-locks/

Example URI

GET /research-sys/api/v1/maintenance-locks/
URI Parameters
HideShow
lockId
string (optional) 
lockingRepresentation
string (optional) 
documentNumber
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "lockId": "(val)",
    "lockingRepresentation": "(val)",
    "documentNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "lockId": "(val)",
    "lockingRepresentation": "(val)",
    "documentNumber": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Maintenance Locks
GET/research-sys/api/v1/maintenance-locks/

Example URI

GET /research-sys/api/v1/maintenance-locks/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "lockId",
    "lockingRepresentation",
    "documentNumber"
  ],
  "primaryKey": "lockId"
}

Get Blueprint API specification for Maintenance Locks
GET/research-sys/api/v1/maintenance-locks/

Example URI

GET /research-sys/api/v1/maintenance-locks/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Maintenance Locks.md"
transfer-encoding: chunked

Update Maintenance Locks
PUT/research-sys/api/v1/maintenance-locks/(key)

Example URI

PUT /research-sys/api/v1/maintenance-locks/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "lockId": "(val)",
  "lockingRepresentation": "(val)",
  "documentNumber": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Maintenance Locks
PUT/research-sys/api/v1/maintenance-locks/

Example URI

PUT /research-sys/api/v1/maintenance-locks/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "lockId": "(val)",
    "lockingRepresentation": "(val)",
    "documentNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "lockId": "(val)",
    "lockingRepresentation": "(val)",
    "documentNumber": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Maintenance Locks
PATCH/research-sys/api/v1/maintenance-locks/(key)

Example URI

PATCH /research-sys/api/v1/maintenance-locks/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "lockId": "(val)",
  "lockingRepresentation": "(val)",
  "documentNumber": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "lockId": "(val)",
  "lockingRepresentation": "(val)",
  "documentNumber": "(val)",
  "_primaryKey": "(val)"
}

Insert Maintenance Locks
POST/research-sys/api/v1/maintenance-locks/

Example URI

POST /research-sys/api/v1/maintenance-locks/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "lockId": "(val)",
  "lockingRepresentation": "(val)",
  "documentNumber": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "lockId": "(val)",
  "lockingRepresentation": "(val)",
  "documentNumber": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Maintenance Locks
POST/research-sys/api/v1/maintenance-locks/

Example URI

POST /research-sys/api/v1/maintenance-locks/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "lockId": "(val)",
    "lockingRepresentation": "(val)",
    "documentNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "lockId": "(val)",
    "lockingRepresentation": "(val)",
    "documentNumber": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "lockId": "(val)",
    "lockingRepresentation": "(val)",
    "documentNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "lockId": "(val)",
    "lockingRepresentation": "(val)",
    "documentNumber": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Maintenance Locks by Key
DELETE/research-sys/api/v1/maintenance-locks/(key)

Example URI

DELETE /research-sys/api/v1/maintenance-locks/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Maintenance Locks
DELETE/research-sys/api/v1/maintenance-locks/

Example URI

DELETE /research-sys/api/v1/maintenance-locks/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Maintenance Locks with Matching
DELETE/research-sys/api/v1/maintenance-locks/

Example URI

DELETE /research-sys/api/v1/maintenance-locks/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

lockId
string (optional) 
lockingRepresentation
string (optional) 
documentNumber
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Message Deliveries

Get Message Deliveries by Key
GET/research-sys/api/v1/message-deliveries/(key)

Example URI

GET /research-sys/api/v1/message-deliveries/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "delivererTypeName": "(val)",
  "delivererSystemId": "(val)",
  "deliveryStatus": "(val)",
  "processCount": "(val)",
  "lockVerNbr": "(val)",
  "lockedDate": "(val)",
  "_primaryKey": "(val)"
}

Get All Message Deliveries
GET/research-sys/api/v1/message-deliveries/

Example URI

GET /research-sys/api/v1/message-deliveries/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "delivererTypeName": "(val)",
    "delivererSystemId": "(val)",
    "deliveryStatus": "(val)",
    "processCount": "(val)",
    "lockVerNbr": "(val)",
    "lockedDate": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "delivererTypeName": "(val)",
    "delivererSystemId": "(val)",
    "deliveryStatus": "(val)",
    "processCount": "(val)",
    "lockVerNbr": "(val)",
    "lockedDate": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Message Deliveries with Filtering
GET/research-sys/api/v1/message-deliveries/

Example URI

GET /research-sys/api/v1/message-deliveries/
URI Parameters
HideShow
id
string (optional) 
delivererTypeName
string (optional) 
delivererSystemId
string (optional) 
deliveryStatus
string (optional) 
processCount
string (optional) 
lockVerNbr
string (optional) 
lockedDate
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "delivererTypeName": "(val)",
    "delivererSystemId": "(val)",
    "deliveryStatus": "(val)",
    "processCount": "(val)",
    "lockVerNbr": "(val)",
    "lockedDate": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "delivererTypeName": "(val)",
    "delivererSystemId": "(val)",
    "deliveryStatus": "(val)",
    "processCount": "(val)",
    "lockVerNbr": "(val)",
    "lockedDate": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Message Deliveries
GET/research-sys/api/v1/message-deliveries/

Example URI

GET /research-sys/api/v1/message-deliveries/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "delivererTypeName",
    "delivererSystemId",
    "deliveryStatus",
    "processCount",
    "lockVerNbr",
    "lockedDate"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Message Deliveries
GET/research-sys/api/v1/message-deliveries/

Example URI

GET /research-sys/api/v1/message-deliveries/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Message Deliveries.md"
transfer-encoding: chunked

Update Message Deliveries
PUT/research-sys/api/v1/message-deliveries/(key)

Example URI

PUT /research-sys/api/v1/message-deliveries/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "delivererTypeName": "(val)",
  "delivererSystemId": "(val)",
  "deliveryStatus": "(val)",
  "processCount": "(val)",
  "lockVerNbr": "(val)",
  "lockedDate": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Message Deliveries
PUT/research-sys/api/v1/message-deliveries/

Example URI

PUT /research-sys/api/v1/message-deliveries/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "delivererTypeName": "(val)",
    "delivererSystemId": "(val)",
    "deliveryStatus": "(val)",
    "processCount": "(val)",
    "lockVerNbr": "(val)",
    "lockedDate": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "delivererTypeName": "(val)",
    "delivererSystemId": "(val)",
    "deliveryStatus": "(val)",
    "processCount": "(val)",
    "lockVerNbr": "(val)",
    "lockedDate": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Message Deliveries
PATCH/research-sys/api/v1/message-deliveries/(key)

Example URI

PATCH /research-sys/api/v1/message-deliveries/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "delivererTypeName": "(val)",
  "delivererSystemId": "(val)",
  "deliveryStatus": "(val)",
  "processCount": "(val)",
  "lockVerNbr": "(val)",
  "lockedDate": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "delivererTypeName": "(val)",
  "delivererSystemId": "(val)",
  "deliveryStatus": "(val)",
  "processCount": "(val)",
  "lockVerNbr": "(val)",
  "lockedDate": "(val)",
  "_primaryKey": "(val)"
}

Insert Message Deliveries
POST/research-sys/api/v1/message-deliveries/

Example URI

POST /research-sys/api/v1/message-deliveries/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "delivererTypeName": "(val)",
  "delivererSystemId": "(val)",
  "deliveryStatus": "(val)",
  "processCount": "(val)",
  "lockVerNbr": "(val)",
  "lockedDate": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "delivererTypeName": "(val)",
  "delivererSystemId": "(val)",
  "deliveryStatus": "(val)",
  "processCount": "(val)",
  "lockVerNbr": "(val)",
  "lockedDate": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Message Deliveries
POST/research-sys/api/v1/message-deliveries/

Example URI

POST /research-sys/api/v1/message-deliveries/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "delivererTypeName": "(val)",
    "delivererSystemId": "(val)",
    "deliveryStatus": "(val)",
    "processCount": "(val)",
    "lockVerNbr": "(val)",
    "lockedDate": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "delivererTypeName": "(val)",
    "delivererSystemId": "(val)",
    "deliveryStatus": "(val)",
    "processCount": "(val)",
    "lockVerNbr": "(val)",
    "lockedDate": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "delivererTypeName": "(val)",
    "delivererSystemId": "(val)",
    "deliveryStatus": "(val)",
    "processCount": "(val)",
    "lockVerNbr": "(val)",
    "lockedDate": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "delivererTypeName": "(val)",
    "delivererSystemId": "(val)",
    "deliveryStatus": "(val)",
    "processCount": "(val)",
    "lockVerNbr": "(val)",
    "lockedDate": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Message Deliveries by Key
DELETE/research-sys/api/v1/message-deliveries/(key)

Example URI

DELETE /research-sys/api/v1/message-deliveries/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Message Deliveries
DELETE/research-sys/api/v1/message-deliveries/

Example URI

DELETE /research-sys/api/v1/message-deliveries/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Message Deliveries with Matching
DELETE/research-sys/api/v1/message-deliveries/

Example URI

DELETE /research-sys/api/v1/message-deliveries/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 
delivererTypeName
string (optional) 
delivererSystemId
string (optional) 
deliveryStatus
string (optional) 
processCount
string (optional) 
lockVerNbr
string (optional) 
lockedDate
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Messages

Get Messages by Key
GET/research-sys/api/v1/messages/(key)

Example URI

GET /research-sys/api/v1/messages/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "originId": "(val)",
  "deliveryType": "(val)",
  "channel": "(val)",
  "producer": "(val)",
  "creationDateTime": "(val)",
  "title": "(val)",
  "content": "(val)",
  "contentType": "(val)",
  "url": "(val)",
  "recipient": "(val)",
  "lockVerNbr": "(val)",
  "_primaryKey": "(val)"
}

Get All Messages
GET/research-sys/api/v1/messages/

Example URI

GET /research-sys/api/v1/messages/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "originId": "(val)",
    "deliveryType": "(val)",
    "channel": "(val)",
    "producer": "(val)",
    "creationDateTime": "(val)",
    "title": "(val)",
    "content": "(val)",
    "contentType": "(val)",
    "url": "(val)",
    "recipient": "(val)",
    "lockVerNbr": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "originId": "(val)",
    "deliveryType": "(val)",
    "channel": "(val)",
    "producer": "(val)",
    "creationDateTime": "(val)",
    "title": "(val)",
    "content": "(val)",
    "contentType": "(val)",
    "url": "(val)",
    "recipient": "(val)",
    "lockVerNbr": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Messages with Filtering
GET/research-sys/api/v1/messages/

Example URI

GET /research-sys/api/v1/messages/
URI Parameters
HideShow
id
string (optional) 
originId
string (optional) 
deliveryType
string (optional) 
channel
string (optional) 
producer
string (optional) 
creationDateTime
string (optional) 
title
string (optional) 
content
string (optional) 
contentType
string (optional) 
url
string (optional) 
recipient
string (optional) 
lockVerNbr
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "originId": "(val)",
    "deliveryType": "(val)",
    "channel": "(val)",
    "producer": "(val)",
    "creationDateTime": "(val)",
    "title": "(val)",
    "content": "(val)",
    "contentType": "(val)",
    "url": "(val)",
    "recipient": "(val)",
    "lockVerNbr": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "originId": "(val)",
    "deliveryType": "(val)",
    "channel": "(val)",
    "producer": "(val)",
    "creationDateTime": "(val)",
    "title": "(val)",
    "content": "(val)",
    "contentType": "(val)",
    "url": "(val)",
    "recipient": "(val)",
    "lockVerNbr": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Messages
GET/research-sys/api/v1/messages/

Example URI

GET /research-sys/api/v1/messages/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "originId",
    "deliveryType",
    "channel",
    "producer",
    "creationDateTime",
    "title",
    "content",
    "contentType",
    "url",
    "recipient",
    "lockVerNbr"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Messages
GET/research-sys/api/v1/messages/

Example URI

GET /research-sys/api/v1/messages/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Messages.md"
transfer-encoding: chunked

Update Messages
PUT/research-sys/api/v1/messages/(key)

Example URI

PUT /research-sys/api/v1/messages/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "originId": "(val)",
  "deliveryType": "(val)",
  "channel": "(val)",
  "producer": "(val)",
  "creationDateTime": "(val)",
  "title": "(val)",
  "content": "(val)",
  "contentType": "(val)",
  "url": "(val)",
  "recipient": "(val)",
  "lockVerNbr": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Messages
PUT/research-sys/api/v1/messages/

Example URI

PUT /research-sys/api/v1/messages/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "originId": "(val)",
    "deliveryType": "(val)",
    "channel": "(val)",
    "producer": "(val)",
    "creationDateTime": "(val)",
    "title": "(val)",
    "content": "(val)",
    "contentType": "(val)",
    "url": "(val)",
    "recipient": "(val)",
    "lockVerNbr": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "originId": "(val)",
    "deliveryType": "(val)",
    "channel": "(val)",
    "producer": "(val)",
    "creationDateTime": "(val)",
    "title": "(val)",
    "content": "(val)",
    "contentType": "(val)",
    "url": "(val)",
    "recipient": "(val)",
    "lockVerNbr": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Messages
PATCH/research-sys/api/v1/messages/(key)

Example URI

PATCH /research-sys/api/v1/messages/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "originId": "(val)",
  "deliveryType": "(val)",
  "channel": "(val)",
  "producer": "(val)",
  "creationDateTime": "(val)",
  "title": "(val)",
  "content": "(val)",
  "contentType": "(val)",
  "url": "(val)",
  "recipient": "(val)",
  "lockVerNbr": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "originId": "(val)",
  "deliveryType": "(val)",
  "channel": "(val)",
  "producer": "(val)",
  "creationDateTime": "(val)",
  "title": "(val)",
  "content": "(val)",
  "contentType": "(val)",
  "url": "(val)",
  "recipient": "(val)",
  "lockVerNbr": "(val)",
  "_primaryKey": "(val)"
}

Insert Messages
POST/research-sys/api/v1/messages/

Example URI

POST /research-sys/api/v1/messages/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "originId": "(val)",
  "deliveryType": "(val)",
  "channel": "(val)",
  "producer": "(val)",
  "creationDateTime": "(val)",
  "title": "(val)",
  "content": "(val)",
  "contentType": "(val)",
  "url": "(val)",
  "recipient": "(val)",
  "lockVerNbr": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "originId": "(val)",
  "deliveryType": "(val)",
  "channel": "(val)",
  "producer": "(val)",
  "creationDateTime": "(val)",
  "title": "(val)",
  "content": "(val)",
  "contentType": "(val)",
  "url": "(val)",
  "recipient": "(val)",
  "lockVerNbr": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Messages
POST/research-sys/api/v1/messages/

Example URI

POST /research-sys/api/v1/messages/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "originId": "(val)",
    "deliveryType": "(val)",
    "channel": "(val)",
    "producer": "(val)",
    "creationDateTime": "(val)",
    "title": "(val)",
    "content": "(val)",
    "contentType": "(val)",
    "url": "(val)",
    "recipient": "(val)",
    "lockVerNbr": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "originId": "(val)",
    "deliveryType": "(val)",
    "channel": "(val)",
    "producer": "(val)",
    "creationDateTime": "(val)",
    "title": "(val)",
    "content": "(val)",
    "contentType": "(val)",
    "url": "(val)",
    "recipient": "(val)",
    "lockVerNbr": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "originId": "(val)",
    "deliveryType": "(val)",
    "channel": "(val)",
    "producer": "(val)",
    "creationDateTime": "(val)",
    "title": "(val)",
    "content": "(val)",
    "contentType": "(val)",
    "url": "(val)",
    "recipient": "(val)",
    "lockVerNbr": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "originId": "(val)",
    "deliveryType": "(val)",
    "channel": "(val)",
    "producer": "(val)",
    "creationDateTime": "(val)",
    "title": "(val)",
    "content": "(val)",
    "contentType": "(val)",
    "url": "(val)",
    "recipient": "(val)",
    "lockVerNbr": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Messages by Key
DELETE/research-sys/api/v1/messages/(key)

Example URI

DELETE /research-sys/api/v1/messages/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Messages
DELETE/research-sys/api/v1/messages/

Example URI

DELETE /research-sys/api/v1/messages/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Messages with Matching
DELETE/research-sys/api/v1/messages/

Example URI

DELETE /research-sys/api/v1/messages/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 
originId
string (optional) 
deliveryType
string (optional) 
channel
string (optional) 
producer
string (optional) 
creationDateTime
string (optional) 
title
string (optional) 
content
string (optional) 
contentType
string (optional) 
url
string (optional) 
recipient
string (optional) 
lockVerNbr
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Multi Document Attachments

Get Multi Document Attachments by Key
GET/research-sys/api/v1/multi-document-attachments/(key)

Example URI

GET /research-sys/api/v1/multi-document-attachments/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "documentNumber": "(val)",
  "fileName": "(val)",
  "attachmentContent": "(val)",
  "contentType": "(val)",
  "_primaryKey": "(val)"
}

Get All Multi Document Attachments
GET/research-sys/api/v1/multi-document-attachments/

Example URI

GET /research-sys/api/v1/multi-document-attachments/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "documentNumber": "(val)",
    "fileName": "(val)",
    "attachmentContent": "(val)",
    "contentType": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "documentNumber": "(val)",
    "fileName": "(val)",
    "attachmentContent": "(val)",
    "contentType": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Multi Document Attachments with Filtering
GET/research-sys/api/v1/multi-document-attachments/

Example URI

GET /research-sys/api/v1/multi-document-attachments/
URI Parameters
HideShow
id
string (optional) 
documentNumber
string (optional) 
fileName
string (optional) 
attachmentContent
string (optional) 
contentType
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "documentNumber": "(val)",
    "fileName": "(val)",
    "attachmentContent": "(val)",
    "contentType": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "documentNumber": "(val)",
    "fileName": "(val)",
    "attachmentContent": "(val)",
    "contentType": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Multi Document Attachments
GET/research-sys/api/v1/multi-document-attachments/

Example URI

GET /research-sys/api/v1/multi-document-attachments/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "documentNumber",
    "fileName",
    "attachmentContent",
    "contentType"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Multi Document Attachments
GET/research-sys/api/v1/multi-document-attachments/

Example URI

GET /research-sys/api/v1/multi-document-attachments/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Multi Document Attachments.md"
transfer-encoding: chunked

Update Multi Document Attachments
PUT/research-sys/api/v1/multi-document-attachments/(key)

Example URI

PUT /research-sys/api/v1/multi-document-attachments/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "documentNumber": "(val)",
  "fileName": "(val)",
  "attachmentContent": "(val)",
  "contentType": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Multi Document Attachments
PUT/research-sys/api/v1/multi-document-attachments/

Example URI

PUT /research-sys/api/v1/multi-document-attachments/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "documentNumber": "(val)",
    "fileName": "(val)",
    "attachmentContent": "(val)",
    "contentType": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "documentNumber": "(val)",
    "fileName": "(val)",
    "attachmentContent": "(val)",
    "contentType": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Multi Document Attachments
PATCH/research-sys/api/v1/multi-document-attachments/(key)

Example URI

PATCH /research-sys/api/v1/multi-document-attachments/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "documentNumber": "(val)",
  "fileName": "(val)",
  "attachmentContent": "(val)",
  "contentType": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "documentNumber": "(val)",
  "fileName": "(val)",
  "attachmentContent": "(val)",
  "contentType": "(val)",
  "_primaryKey": "(val)"
}

Insert Multi Document Attachments
POST/research-sys/api/v1/multi-document-attachments/

Example URI

POST /research-sys/api/v1/multi-document-attachments/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "documentNumber": "(val)",
  "fileName": "(val)",
  "attachmentContent": "(val)",
  "contentType": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "documentNumber": "(val)",
  "fileName": "(val)",
  "attachmentContent": "(val)",
  "contentType": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Multi Document Attachments
POST/research-sys/api/v1/multi-document-attachments/

Example URI

POST /research-sys/api/v1/multi-document-attachments/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "documentNumber": "(val)",
    "fileName": "(val)",
    "attachmentContent": "(val)",
    "contentType": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "documentNumber": "(val)",
    "fileName": "(val)",
    "attachmentContent": "(val)",
    "contentType": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "documentNumber": "(val)",
    "fileName": "(val)",
    "attachmentContent": "(val)",
    "contentType": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "documentNumber": "(val)",
    "fileName": "(val)",
    "attachmentContent": "(val)",
    "contentType": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Multi Document Attachments by Key
DELETE/research-sys/api/v1/multi-document-attachments/(key)

Example URI

DELETE /research-sys/api/v1/multi-document-attachments/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Multi Document Attachments
DELETE/research-sys/api/v1/multi-document-attachments/

Example URI

DELETE /research-sys/api/v1/multi-document-attachments/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Multi Document Attachments with Matching
DELETE/research-sys/api/v1/multi-document-attachments/

Example URI

DELETE /research-sys/api/v1/multi-document-attachments/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 
documentNumber
string (optional) 
fileName
string (optional) 
attachmentContent
string (optional) 
contentType
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Namespaces

Get Namespaces by Key
GET/research-sys/api/v1/namespaces/(key)

Example URI

GET /research-sys/api/v1/namespaces/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "applicationId": "(val)",
  "code": "(val)",
  "name": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Get All Namespaces
GET/research-sys/api/v1/namespaces/

Example URI

GET /research-sys/api/v1/namespaces/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "applicationId": "(val)",
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "applicationId": "(val)",
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Namespaces with Filtering
GET/research-sys/api/v1/namespaces/

Example URI

GET /research-sys/api/v1/namespaces/
URI Parameters
HideShow
applicationId
string (optional) 

The id of the application which owns this namespace. Maximum length is 20.

code
string (optional) 

Code identifying the namespace. Maximum length is 20.

name
string (optional) 

The name of the namespace. Maximum length is 40.

active
string (optional) 

This attribute is used to describe whether the associated object is active or inactive. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "applicationId": "(val)",
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "applicationId": "(val)",
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Namespaces
GET/research-sys/api/v1/namespaces/

Example URI

GET /research-sys/api/v1/namespaces/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "applicationId",
    "code",
    "name",
    "active"
  ],
  "primaryKey": "code"
}

Get Blueprint API specification for Namespaces
GET/research-sys/api/v1/namespaces/

Example URI

GET /research-sys/api/v1/namespaces/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Namespaces.md"
transfer-encoding: chunked

Update Namespaces
PUT/research-sys/api/v1/namespaces/(key)

Example URI

PUT /research-sys/api/v1/namespaces/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "applicationId": "(val)",
  "code": "(val)",
  "name": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Namespaces
PUT/research-sys/api/v1/namespaces/

Example URI

PUT /research-sys/api/v1/namespaces/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "applicationId": "(val)",
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "applicationId": "(val)",
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Namespaces
PATCH/research-sys/api/v1/namespaces/(key)

Example URI

PATCH /research-sys/api/v1/namespaces/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "applicationId": "(val)",
  "code": "(val)",
  "name": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "applicationId": "(val)",
  "code": "(val)",
  "name": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Namespaces
POST/research-sys/api/v1/namespaces/

Example URI

POST /research-sys/api/v1/namespaces/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "applicationId": "(val)",
  "code": "(val)",
  "name": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "applicationId": "(val)",
  "code": "(val)",
  "name": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Namespaces
POST/research-sys/api/v1/namespaces/

Example URI

POST /research-sys/api/v1/namespaces/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "applicationId": "(val)",
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "applicationId": "(val)",
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "applicationId": "(val)",
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "applicationId": "(val)",
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Namespaces by Key
DELETE/research-sys/api/v1/namespaces/(key)

Example URI

DELETE /research-sys/api/v1/namespaces/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Namespaces
DELETE/research-sys/api/v1/namespaces/

Example URI

DELETE /research-sys/api/v1/namespaces/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Namespaces with Matching
DELETE/research-sys/api/v1/namespaces/

Example URI

DELETE /research-sys/api/v1/namespaces/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

applicationId
string (optional) 

The id of the application which owns this namespace. Maximum length is 20.

code
string (optional) 

Code identifying the namespace. Maximum length is 20.

name
string (optional) 

The name of the namespace. Maximum length is 40.

active
string (optional) 

This attribute is used to describe whether the associated object is active or inactive. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Note Types

Get Note Types by Key
GET/research-sys/api/v1/note-types/(key)

Example URI

GET /research-sys/api/v1/note-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "noteTypeCode": "(val)",
  "noteTypeDescription": "(val)",
  "noteTypeActiveIndicator": "(val)",
  "_primaryKey": "(val)"
}

Get All Note Types
GET/research-sys/api/v1/note-types/

Example URI

GET /research-sys/api/v1/note-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "noteTypeCode": "(val)",
    "noteTypeDescription": "(val)",
    "noteTypeActiveIndicator": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "noteTypeCode": "(val)",
    "noteTypeDescription": "(val)",
    "noteTypeActiveIndicator": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Note Types with Filtering
GET/research-sys/api/v1/note-types/

Example URI

GET /research-sys/api/v1/note-types/
URI Parameters
HideShow
noteTypeCode
string (optional) 

noteTypeCode description… Maximum length is 4.

noteTypeDescription
string (optional) 

noteTypeDescription description… Maximum length is 100.

noteTypeActiveIndicator
string (optional) 

noteTypeActiveIndicator description… Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "noteTypeCode": "(val)",
    "noteTypeDescription": "(val)",
    "noteTypeActiveIndicator": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "noteTypeCode": "(val)",
    "noteTypeDescription": "(val)",
    "noteTypeActiveIndicator": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Note Types
GET/research-sys/api/v1/note-types/

Example URI

GET /research-sys/api/v1/note-types/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "noteTypeCode",
    "noteTypeDescription",
    "noteTypeActiveIndicator"
  ],
  "primaryKey": "noteTypeCode"
}

Get Blueprint API specification for Note Types
GET/research-sys/api/v1/note-types/

Example URI

GET /research-sys/api/v1/note-types/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Note Types.md"
transfer-encoding: chunked

Update Note Types
PUT/research-sys/api/v1/note-types/(key)

Example URI

PUT /research-sys/api/v1/note-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "noteTypeCode": "(val)",
  "noteTypeDescription": "(val)",
  "noteTypeActiveIndicator": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Note Types
PUT/research-sys/api/v1/note-types/

Example URI

PUT /research-sys/api/v1/note-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "noteTypeCode": "(val)",
    "noteTypeDescription": "(val)",
    "noteTypeActiveIndicator": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "noteTypeCode": "(val)",
    "noteTypeDescription": "(val)",
    "noteTypeActiveIndicator": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Note Types
PATCH/research-sys/api/v1/note-types/(key)

Example URI

PATCH /research-sys/api/v1/note-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "noteTypeCode": "(val)",
  "noteTypeDescription": "(val)",
  "noteTypeActiveIndicator": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "noteTypeCode": "(val)",
  "noteTypeDescription": "(val)",
  "noteTypeActiveIndicator": "(val)",
  "_primaryKey": "(val)"
}

Insert Note Types
POST/research-sys/api/v1/note-types/

Example URI

POST /research-sys/api/v1/note-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "noteTypeCode": "(val)",
  "noteTypeDescription": "(val)",
  "noteTypeActiveIndicator": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "noteTypeCode": "(val)",
  "noteTypeDescription": "(val)",
  "noteTypeActiveIndicator": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Note Types
POST/research-sys/api/v1/note-types/

Example URI

POST /research-sys/api/v1/note-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "noteTypeCode": "(val)",
    "noteTypeDescription": "(val)",
    "noteTypeActiveIndicator": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "noteTypeCode": "(val)",
    "noteTypeDescription": "(val)",
    "noteTypeActiveIndicator": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "noteTypeCode": "(val)",
    "noteTypeDescription": "(val)",
    "noteTypeActiveIndicator": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "noteTypeCode": "(val)",
    "noteTypeDescription": "(val)",
    "noteTypeActiveIndicator": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Note Types by Key
DELETE/research-sys/api/v1/note-types/(key)

Example URI

DELETE /research-sys/api/v1/note-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Note Types
DELETE/research-sys/api/v1/note-types/

Example URI

DELETE /research-sys/api/v1/note-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Note Types with Matching
DELETE/research-sys/api/v1/note-types/

Example URI

DELETE /research-sys/api/v1/note-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

noteTypeCode
string (optional) 

noteTypeCode description… Maximum length is 4.

noteTypeDescription
string (optional) 

noteTypeDescription description… Maximum length is 100.

noteTypeActiveIndicator
string (optional) 

noteTypeActiveIndicator description… Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Notes

Get Notes by Key
GET/research-sys/api/v1/notes/(key)

Example URI

GET /research-sys/api/v1/notes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "noteIdentifier": "(val)",
  "remoteObjectIdentifier": "(val)",
  "authorUniversalIdentifier": "(val)",
  "notePostedTimestamp": "(val)",
  "noteTypeCode": "(val)",
  "noteText": "(val)",
  "noteTopicText": "(val)",
  "notePurgeCode": "(val)",
  "_primaryKey": "(val)"
}

Get All Notes
GET/research-sys/api/v1/notes/

Example URI

GET /research-sys/api/v1/notes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "noteIdentifier": "(val)",
    "remoteObjectIdentifier": "(val)",
    "authorUniversalIdentifier": "(val)",
    "notePostedTimestamp": "(val)",
    "noteTypeCode": "(val)",
    "noteText": "(val)",
    "noteTopicText": "(val)",
    "notePurgeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "noteIdentifier": "(val)",
    "remoteObjectIdentifier": "(val)",
    "authorUniversalIdentifier": "(val)",
    "notePostedTimestamp": "(val)",
    "noteTypeCode": "(val)",
    "noteText": "(val)",
    "noteTopicText": "(val)",
    "notePurgeCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Notes with Filtering
GET/research-sys/api/v1/notes/

Example URI

GET /research-sys/api/v1/notes/
URI Parameters
HideShow
noteIdentifier
string (optional) 

Note Identifier. Maximum length is 14.

remoteObjectIdentifier
string (optional) 

remoteObjectIdentifier description… Maximum length is 36.

authorUniversalIdentifier
string (optional) 

A free-form text field for the full name of the Author of the Note, expressed as “Lastname, Firstname Initial”. Maximum length is 40.

notePostedTimestamp
string (optional) 

A free-form text field that identifies the time and date at which the Notes is posted. Maximum length is 36.

noteTypeCode
string (optional) 

noteTypeCode description… Maximum length is 4.

noteText
string (optional) 

A free-form text field for the text of the Note. Maximum length is 800.

noteTopicText
string (optional) 

A free-form text field for entering the topic of the Note. Maximum length is 40.

notePurgeCode
string (optional) 

notePurgeCode description… Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "noteIdentifier": "(val)",
    "remoteObjectIdentifier": "(val)",
    "authorUniversalIdentifier": "(val)",
    "notePostedTimestamp": "(val)",
    "noteTypeCode": "(val)",
    "noteText": "(val)",
    "noteTopicText": "(val)",
    "notePurgeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "noteIdentifier": "(val)",
    "remoteObjectIdentifier": "(val)",
    "authorUniversalIdentifier": "(val)",
    "notePostedTimestamp": "(val)",
    "noteTypeCode": "(val)",
    "noteText": "(val)",
    "noteTopicText": "(val)",
    "notePurgeCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Notes
GET/research-sys/api/v1/notes/

Example URI

GET /research-sys/api/v1/notes/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "noteIdentifier",
    "remoteObjectIdentifier",
    "authorUniversalIdentifier",
    "notePostedTimestamp",
    "noteTypeCode",
    "noteText",
    "noteTopicText",
    "notePurgeCode"
  ],
  "primaryKey": "noteIdentifier"
}

Get Blueprint API specification for Notes
GET/research-sys/api/v1/notes/

Example URI

GET /research-sys/api/v1/notes/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Notes.md"
transfer-encoding: chunked

Update Notes
PUT/research-sys/api/v1/notes/(key)

Example URI

PUT /research-sys/api/v1/notes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "noteIdentifier": "(val)",
  "remoteObjectIdentifier": "(val)",
  "authorUniversalIdentifier": "(val)",
  "notePostedTimestamp": "(val)",
  "noteTypeCode": "(val)",
  "noteText": "(val)",
  "noteTopicText": "(val)",
  "notePurgeCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Notes
PUT/research-sys/api/v1/notes/

Example URI

PUT /research-sys/api/v1/notes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "noteIdentifier": "(val)",
    "remoteObjectIdentifier": "(val)",
    "authorUniversalIdentifier": "(val)",
    "notePostedTimestamp": "(val)",
    "noteTypeCode": "(val)",
    "noteText": "(val)",
    "noteTopicText": "(val)",
    "notePurgeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "noteIdentifier": "(val)",
    "remoteObjectIdentifier": "(val)",
    "authorUniversalIdentifier": "(val)",
    "notePostedTimestamp": "(val)",
    "noteTypeCode": "(val)",
    "noteText": "(val)",
    "noteTopicText": "(val)",
    "notePurgeCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Notes
PATCH/research-sys/api/v1/notes/(key)

Example URI

PATCH /research-sys/api/v1/notes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "noteIdentifier": "(val)",
  "remoteObjectIdentifier": "(val)",
  "authorUniversalIdentifier": "(val)",
  "notePostedTimestamp": "(val)",
  "noteTypeCode": "(val)",
  "noteText": "(val)",
  "noteTopicText": "(val)",
  "notePurgeCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "noteIdentifier": "(val)",
  "remoteObjectIdentifier": "(val)",
  "authorUniversalIdentifier": "(val)",
  "notePostedTimestamp": "(val)",
  "noteTypeCode": "(val)",
  "noteText": "(val)",
  "noteTopicText": "(val)",
  "notePurgeCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Notes
POST/research-sys/api/v1/notes/

Example URI

POST /research-sys/api/v1/notes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "noteIdentifier": "(val)",
  "remoteObjectIdentifier": "(val)",
  "authorUniversalIdentifier": "(val)",
  "notePostedTimestamp": "(val)",
  "noteTypeCode": "(val)",
  "noteText": "(val)",
  "noteTopicText": "(val)",
  "notePurgeCode": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "noteIdentifier": "(val)",
  "remoteObjectIdentifier": "(val)",
  "authorUniversalIdentifier": "(val)",
  "notePostedTimestamp": "(val)",
  "noteTypeCode": "(val)",
  "noteText": "(val)",
  "noteTopicText": "(val)",
  "notePurgeCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Notes
POST/research-sys/api/v1/notes/

Example URI

POST /research-sys/api/v1/notes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "noteIdentifier": "(val)",
    "remoteObjectIdentifier": "(val)",
    "authorUniversalIdentifier": "(val)",
    "notePostedTimestamp": "(val)",
    "noteTypeCode": "(val)",
    "noteText": "(val)",
    "noteTopicText": "(val)",
    "notePurgeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "noteIdentifier": "(val)",
    "remoteObjectIdentifier": "(val)",
    "authorUniversalIdentifier": "(val)",
    "notePostedTimestamp": "(val)",
    "noteTypeCode": "(val)",
    "noteText": "(val)",
    "noteTopicText": "(val)",
    "notePurgeCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "noteIdentifier": "(val)",
    "remoteObjectIdentifier": "(val)",
    "authorUniversalIdentifier": "(val)",
    "notePostedTimestamp": "(val)",
    "noteTypeCode": "(val)",
    "noteText": "(val)",
    "noteTopicText": "(val)",
    "notePurgeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "noteIdentifier": "(val)",
    "remoteObjectIdentifier": "(val)",
    "authorUniversalIdentifier": "(val)",
    "notePostedTimestamp": "(val)",
    "noteTypeCode": "(val)",
    "noteText": "(val)",
    "noteTopicText": "(val)",
    "notePurgeCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Notes by Key
DELETE/research-sys/api/v1/notes/(key)

Example URI

DELETE /research-sys/api/v1/notes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Notes
DELETE/research-sys/api/v1/notes/

Example URI

DELETE /research-sys/api/v1/notes/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Notes with Matching
DELETE/research-sys/api/v1/notes/

Example URI

DELETE /research-sys/api/v1/notes/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

noteIdentifier
string (optional) 

Note Identifier. Maximum length is 14.

remoteObjectIdentifier
string (optional) 

remoteObjectIdentifier description… Maximum length is 36.

authorUniversalIdentifier
string (optional) 

A free-form text field for the full name of the Author of the Note, expressed as “Lastname, Firstname Initial”. Maximum length is 40.

notePostedTimestamp
string (optional) 

A free-form text field that identifies the time and date at which the Notes is posted. Maximum length is 36.

noteTypeCode
string (optional) 

noteTypeCode description… Maximum length is 4.

noteText
string (optional) 

A free-form text field for the text of the Note. Maximum length is 800.

noteTopicText
string (optional) 

A free-form text field for entering the topic of the Note. Maximum length is 40.

notePurgeCode
string (optional) 

notePurgeCode description… Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Notification Channel Reviewers

Get Notification Channel Reviewers by Key
GET/research-sys/api/v1/notification-channel-reviewers/(key)

Example URI

GET /research-sys/api/v1/notification-channel-reviewers/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "reviewerType": "(val)",
  "reviewerId": "(val)",
  "_primaryKey": "(val)"
}

Get All Notification Channel Reviewers
GET/research-sys/api/v1/notification-channel-reviewers/

Example URI

GET /research-sys/api/v1/notification-channel-reviewers/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "reviewerType": "(val)",
    "reviewerId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "reviewerType": "(val)",
    "reviewerId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Notification Channel Reviewers with Filtering
GET/research-sys/api/v1/notification-channel-reviewers/

Example URI

GET /research-sys/api/v1/notification-channel-reviewers/
URI Parameters
HideShow
id
string (optional) 
reviewerType
string (optional) 
reviewerId
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "reviewerType": "(val)",
    "reviewerId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "reviewerType": "(val)",
    "reviewerId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Notification Channel Reviewers
GET/research-sys/api/v1/notification-channel-reviewers/

Example URI

GET /research-sys/api/v1/notification-channel-reviewers/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "reviewerType",
    "reviewerId"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Notification Channel Reviewers
GET/research-sys/api/v1/notification-channel-reviewers/

Example URI

GET /research-sys/api/v1/notification-channel-reviewers/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Notification Channel Reviewers.md"
transfer-encoding: chunked

Update Notification Channel Reviewers
PUT/research-sys/api/v1/notification-channel-reviewers/(key)

Example URI

PUT /research-sys/api/v1/notification-channel-reviewers/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "reviewerType": "(val)",
  "reviewerId": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Notification Channel Reviewers
PUT/research-sys/api/v1/notification-channel-reviewers/

Example URI

PUT /research-sys/api/v1/notification-channel-reviewers/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "reviewerType": "(val)",
    "reviewerId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "reviewerType": "(val)",
    "reviewerId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Notification Channel Reviewers
PATCH/research-sys/api/v1/notification-channel-reviewers/(key)

Example URI

PATCH /research-sys/api/v1/notification-channel-reviewers/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "reviewerType": "(val)",
  "reviewerId": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "reviewerType": "(val)",
  "reviewerId": "(val)",
  "_primaryKey": "(val)"
}

Insert Notification Channel Reviewers
POST/research-sys/api/v1/notification-channel-reviewers/

Example URI

POST /research-sys/api/v1/notification-channel-reviewers/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "reviewerType": "(val)",
  "reviewerId": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "reviewerType": "(val)",
  "reviewerId": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Notification Channel Reviewers
POST/research-sys/api/v1/notification-channel-reviewers/

Example URI

POST /research-sys/api/v1/notification-channel-reviewers/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "reviewerType": "(val)",
    "reviewerId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "reviewerType": "(val)",
    "reviewerId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "reviewerType": "(val)",
    "reviewerId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "reviewerType": "(val)",
    "reviewerId": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Notification Channel Reviewers by Key
DELETE/research-sys/api/v1/notification-channel-reviewers/(key)

Example URI

DELETE /research-sys/api/v1/notification-channel-reviewers/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Notification Channel Reviewers
DELETE/research-sys/api/v1/notification-channel-reviewers/

Example URI

DELETE /research-sys/api/v1/notification-channel-reviewers/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Notification Channel Reviewers with Matching
DELETE/research-sys/api/v1/notification-channel-reviewers/

Example URI

DELETE /research-sys/api/v1/notification-channel-reviewers/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 
reviewerType
string (optional) 
reviewerId
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Notification Channels

Get Notification Channels by Key
GET/research-sys/api/v1/notification-channels/(key)

Example URI

GET /research-sys/api/v1/notification-channels/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "name": "(val)",
  "description": "(val)",
  "subscribable": "(val)",
  "_primaryKey": "(val)"
}

Get All Notification Channels
GET/research-sys/api/v1/notification-channels/

Example URI

GET /research-sys/api/v1/notification-channels/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "subscribable": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "subscribable": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Notification Channels with Filtering
GET/research-sys/api/v1/notification-channels/

Example URI

GET /research-sys/api/v1/notification-channels/
URI Parameters
HideShow
id
string (optional) 
name
string (optional) 
description
string (optional) 
subscribable
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "subscribable": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "subscribable": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Notification Channels
GET/research-sys/api/v1/notification-channels/

Example URI

GET /research-sys/api/v1/notification-channels/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "name",
    "description",
    "subscribable"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Notification Channels
GET/research-sys/api/v1/notification-channels/

Example URI

GET /research-sys/api/v1/notification-channels/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Notification Channels.md"
transfer-encoding: chunked

Update Notification Channels
PUT/research-sys/api/v1/notification-channels/(key)

Example URI

PUT /research-sys/api/v1/notification-channels/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "name": "(val)",
  "description": "(val)",
  "subscribable": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Notification Channels
PUT/research-sys/api/v1/notification-channels/

Example URI

PUT /research-sys/api/v1/notification-channels/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "subscribable": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "subscribable": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Notification Channels
PATCH/research-sys/api/v1/notification-channels/(key)

Example URI

PATCH /research-sys/api/v1/notification-channels/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "name": "(val)",
  "description": "(val)",
  "subscribable": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "name": "(val)",
  "description": "(val)",
  "subscribable": "(val)",
  "_primaryKey": "(val)"
}

Insert Notification Channels
POST/research-sys/api/v1/notification-channels/

Example URI

POST /research-sys/api/v1/notification-channels/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "name": "(val)",
  "description": "(val)",
  "subscribable": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "name": "(val)",
  "description": "(val)",
  "subscribable": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Notification Channels
POST/research-sys/api/v1/notification-channels/

Example URI

POST /research-sys/api/v1/notification-channels/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "subscribable": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "subscribable": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "subscribable": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "subscribable": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Notification Channels by Key
DELETE/research-sys/api/v1/notification-channels/(key)

Example URI

DELETE /research-sys/api/v1/notification-channels/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Notification Channels
DELETE/research-sys/api/v1/notification-channels/

Example URI

DELETE /research-sys/api/v1/notification-channels/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Notification Channels with Matching
DELETE/research-sys/api/v1/notification-channels/

Example URI

DELETE /research-sys/api/v1/notification-channels/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 
name
string (optional) 
description
string (optional) 
subscribable
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Notification Content Types

Get Notification Content Types by Key
GET/research-sys/api/v1/notification-content-types/(key)

Example URI

GET /research-sys/api/v1/notification-content-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "name": "(val)",
  "current": "(val)",
  "version": "(val)",
  "description": "(val)",
  "namespace": "(val)",
  "xsd": "(val)",
  "xsl": "(val)",
  "_primaryKey": "(val)"
}

Get All Notification Content Types
GET/research-sys/api/v1/notification-content-types/

Example URI

GET /research-sys/api/v1/notification-content-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "current": "(val)",
    "version": "(val)",
    "description": "(val)",
    "namespace": "(val)",
    "xsd": "(val)",
    "xsl": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "current": "(val)",
    "version": "(val)",
    "description": "(val)",
    "namespace": "(val)",
    "xsd": "(val)",
    "xsl": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Notification Content Types with Filtering
GET/research-sys/api/v1/notification-content-types/

Example URI

GET /research-sys/api/v1/notification-content-types/
URI Parameters
HideShow
id
string (optional) 
name
string (optional) 
current
string (optional) 
version
string (optional) 
description
string (optional) 
namespace
string (optional) 
xsd
string (optional) 
xsl
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "current": "(val)",
    "version": "(val)",
    "description": "(val)",
    "namespace": "(val)",
    "xsd": "(val)",
    "xsl": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "current": "(val)",
    "version": "(val)",
    "description": "(val)",
    "namespace": "(val)",
    "xsd": "(val)",
    "xsl": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Notification Content Types
GET/research-sys/api/v1/notification-content-types/

Example URI

GET /research-sys/api/v1/notification-content-types/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "name",
    "current",
    "version",
    "description",
    "namespace",
    "xsd",
    "xsl"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Notification Content Types
GET/research-sys/api/v1/notification-content-types/

Example URI

GET /research-sys/api/v1/notification-content-types/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Notification Content Types.md"
transfer-encoding: chunked

Update Notification Content Types
PUT/research-sys/api/v1/notification-content-types/(key)

Example URI

PUT /research-sys/api/v1/notification-content-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "name": "(val)",
  "current": "(val)",
  "version": "(val)",
  "description": "(val)",
  "namespace": "(val)",
  "xsd": "(val)",
  "xsl": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Notification Content Types
PUT/research-sys/api/v1/notification-content-types/

Example URI

PUT /research-sys/api/v1/notification-content-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "current": "(val)",
    "version": "(val)",
    "description": "(val)",
    "namespace": "(val)",
    "xsd": "(val)",
    "xsl": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "current": "(val)",
    "version": "(val)",
    "description": "(val)",
    "namespace": "(val)",
    "xsd": "(val)",
    "xsl": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Notification Content Types
PATCH/research-sys/api/v1/notification-content-types/(key)

Example URI

PATCH /research-sys/api/v1/notification-content-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "name": "(val)",
  "current": "(val)",
  "version": "(val)",
  "description": "(val)",
  "namespace": "(val)",
  "xsd": "(val)",
  "xsl": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "name": "(val)",
  "current": "(val)",
  "version": "(val)",
  "description": "(val)",
  "namespace": "(val)",
  "xsd": "(val)",
  "xsl": "(val)",
  "_primaryKey": "(val)"
}

Insert Notification Content Types
POST/research-sys/api/v1/notification-content-types/

Example URI

POST /research-sys/api/v1/notification-content-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "name": "(val)",
  "current": "(val)",
  "version": "(val)",
  "description": "(val)",
  "namespace": "(val)",
  "xsd": "(val)",
  "xsl": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "name": "(val)",
  "current": "(val)",
  "version": "(val)",
  "description": "(val)",
  "namespace": "(val)",
  "xsd": "(val)",
  "xsl": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Notification Content Types
POST/research-sys/api/v1/notification-content-types/

Example URI

POST /research-sys/api/v1/notification-content-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "current": "(val)",
    "version": "(val)",
    "description": "(val)",
    "namespace": "(val)",
    "xsd": "(val)",
    "xsl": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "current": "(val)",
    "version": "(val)",
    "description": "(val)",
    "namespace": "(val)",
    "xsd": "(val)",
    "xsl": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "current": "(val)",
    "version": "(val)",
    "description": "(val)",
    "namespace": "(val)",
    "xsd": "(val)",
    "xsl": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "current": "(val)",
    "version": "(val)",
    "description": "(val)",
    "namespace": "(val)",
    "xsd": "(val)",
    "xsl": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Notification Content Types by Key
DELETE/research-sys/api/v1/notification-content-types/(key)

Example URI

DELETE /research-sys/api/v1/notification-content-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Notification Content Types
DELETE/research-sys/api/v1/notification-content-types/

Example URI

DELETE /research-sys/api/v1/notification-content-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Notification Content Types with Matching
DELETE/research-sys/api/v1/notification-content-types/

Example URI

DELETE /research-sys/api/v1/notification-content-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 
name
string (optional) 
current
string (optional) 
version
string (optional) 
description
string (optional) 
namespace
string (optional) 
xsd
string (optional) 
xsl
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Notification Message Deliveries

Get Notification Message Deliveries by Key
GET/research-sys/api/v1/notification-message-deliveries/(key)

Example URI

GET /research-sys/api/v1/notification-message-deliveries/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "messageDeliveryStatus": "(val)",
  "userRecipientId": "(val)",
  "deliverySystemId": "(val)",
  "lockedDateValue": "(val)",
  "_primaryKey": "(val)"
}

Get All Notification Message Deliveries
GET/research-sys/api/v1/notification-message-deliveries/

Example URI

GET /research-sys/api/v1/notification-message-deliveries/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "messageDeliveryStatus": "(val)",
    "userRecipientId": "(val)",
    "deliverySystemId": "(val)",
    "lockedDateValue": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "messageDeliveryStatus": "(val)",
    "userRecipientId": "(val)",
    "deliverySystemId": "(val)",
    "lockedDateValue": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Notification Message Deliveries with Filtering
GET/research-sys/api/v1/notification-message-deliveries/

Example URI

GET /research-sys/api/v1/notification-message-deliveries/
URI Parameters
HideShow
id
string (optional) 
messageDeliveryStatus
string (optional) 
userRecipientId
string (optional) 
deliverySystemId
string (optional) 
lockedDateValue
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "messageDeliveryStatus": "(val)",
    "userRecipientId": "(val)",
    "deliverySystemId": "(val)",
    "lockedDateValue": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "messageDeliveryStatus": "(val)",
    "userRecipientId": "(val)",
    "deliverySystemId": "(val)",
    "lockedDateValue": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Notification Message Deliveries
GET/research-sys/api/v1/notification-message-deliveries/

Example URI

GET /research-sys/api/v1/notification-message-deliveries/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "messageDeliveryStatus",
    "userRecipientId",
    "deliverySystemId",
    "lockedDateValue"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Notification Message Deliveries
GET/research-sys/api/v1/notification-message-deliveries/

Example URI

GET /research-sys/api/v1/notification-message-deliveries/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Notification Message Deliveries.md"
transfer-encoding: chunked

Update Notification Message Deliveries
PUT/research-sys/api/v1/notification-message-deliveries/(key)

Example URI

PUT /research-sys/api/v1/notification-message-deliveries/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "messageDeliveryStatus": "(val)",
  "userRecipientId": "(val)",
  "deliverySystemId": "(val)",
  "lockedDateValue": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Notification Message Deliveries
PUT/research-sys/api/v1/notification-message-deliveries/

Example URI

PUT /research-sys/api/v1/notification-message-deliveries/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "messageDeliveryStatus": "(val)",
    "userRecipientId": "(val)",
    "deliverySystemId": "(val)",
    "lockedDateValue": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "messageDeliveryStatus": "(val)",
    "userRecipientId": "(val)",
    "deliverySystemId": "(val)",
    "lockedDateValue": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Notification Message Deliveries
PATCH/research-sys/api/v1/notification-message-deliveries/(key)

Example URI

PATCH /research-sys/api/v1/notification-message-deliveries/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "messageDeliveryStatus": "(val)",
  "userRecipientId": "(val)",
  "deliverySystemId": "(val)",
  "lockedDateValue": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "messageDeliveryStatus": "(val)",
  "userRecipientId": "(val)",
  "deliverySystemId": "(val)",
  "lockedDateValue": "(val)",
  "_primaryKey": "(val)"
}

Insert Notification Message Deliveries
POST/research-sys/api/v1/notification-message-deliveries/

Example URI

POST /research-sys/api/v1/notification-message-deliveries/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "messageDeliveryStatus": "(val)",
  "userRecipientId": "(val)",
  "deliverySystemId": "(val)",
  "lockedDateValue": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "messageDeliveryStatus": "(val)",
  "userRecipientId": "(val)",
  "deliverySystemId": "(val)",
  "lockedDateValue": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Notification Message Deliveries
POST/research-sys/api/v1/notification-message-deliveries/

Example URI

POST /research-sys/api/v1/notification-message-deliveries/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "messageDeliveryStatus": "(val)",
    "userRecipientId": "(val)",
    "deliverySystemId": "(val)",
    "lockedDateValue": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "messageDeliveryStatus": "(val)",
    "userRecipientId": "(val)",
    "deliverySystemId": "(val)",
    "lockedDateValue": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "messageDeliveryStatus": "(val)",
    "userRecipientId": "(val)",
    "deliverySystemId": "(val)",
    "lockedDateValue": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "messageDeliveryStatus": "(val)",
    "userRecipientId": "(val)",
    "deliverySystemId": "(val)",
    "lockedDateValue": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Notification Message Deliveries by Key
DELETE/research-sys/api/v1/notification-message-deliveries/(key)

Example URI

DELETE /research-sys/api/v1/notification-message-deliveries/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Notification Message Deliveries
DELETE/research-sys/api/v1/notification-message-deliveries/

Example URI

DELETE /research-sys/api/v1/notification-message-deliveries/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Notification Message Deliveries with Matching
DELETE/research-sys/api/v1/notification-message-deliveries/

Example URI

DELETE /research-sys/api/v1/notification-message-deliveries/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 
messageDeliveryStatus
string (optional) 
userRecipientId
string (optional) 
deliverySystemId
string (optional) 
lockedDateValue
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Notification Priorities

Get Notification Priorities by Key
GET/research-sys/api/v1/notification-priorities/(key)

Example URI

GET /research-sys/api/v1/notification-priorities/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "name": "(val)",
  "description": "(val)",
  "order": "(val)",
  "_primaryKey": "(val)"
}

Get All Notification Priorities
GET/research-sys/api/v1/notification-priorities/

Example URI

GET /research-sys/api/v1/notification-priorities/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "order": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "order": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Notification Priorities with Filtering
GET/research-sys/api/v1/notification-priorities/

Example URI

GET /research-sys/api/v1/notification-priorities/
URI Parameters
HideShow
id
string (optional) 
name
string (optional) 
description
string (optional) 
order
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "order": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "order": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Notification Priorities
GET/research-sys/api/v1/notification-priorities/

Example URI

GET /research-sys/api/v1/notification-priorities/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "name",
    "description",
    "order"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Notification Priorities
GET/research-sys/api/v1/notification-priorities/

Example URI

GET /research-sys/api/v1/notification-priorities/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Notification Priorities.md"
transfer-encoding: chunked

Update Notification Priorities
PUT/research-sys/api/v1/notification-priorities/(key)

Example URI

PUT /research-sys/api/v1/notification-priorities/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "name": "(val)",
  "description": "(val)",
  "order": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Notification Priorities
PUT/research-sys/api/v1/notification-priorities/

Example URI

PUT /research-sys/api/v1/notification-priorities/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "order": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "order": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Notification Priorities
PATCH/research-sys/api/v1/notification-priorities/(key)

Example URI

PATCH /research-sys/api/v1/notification-priorities/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "name": "(val)",
  "description": "(val)",
  "order": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "name": "(val)",
  "description": "(val)",
  "order": "(val)",
  "_primaryKey": "(val)"
}

Insert Notification Priorities
POST/research-sys/api/v1/notification-priorities/

Example URI

POST /research-sys/api/v1/notification-priorities/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "name": "(val)",
  "description": "(val)",
  "order": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "name": "(val)",
  "description": "(val)",
  "order": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Notification Priorities
POST/research-sys/api/v1/notification-priorities/

Example URI

POST /research-sys/api/v1/notification-priorities/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "order": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "order": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "order": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "order": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Notification Priorities by Key
DELETE/research-sys/api/v1/notification-priorities/(key)

Example URI

DELETE /research-sys/api/v1/notification-priorities/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Notification Priorities
DELETE/research-sys/api/v1/notification-priorities/

Example URI

DELETE /research-sys/api/v1/notification-priorities/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Notification Priorities with Matching
DELETE/research-sys/api/v1/notification-priorities/

Example URI

DELETE /research-sys/api/v1/notification-priorities/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 
name
string (optional) 
description
string (optional) 
order
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Notification Producers

Get Notification Producers by Key
GET/research-sys/api/v1/notification-producers/(key)

Example URI

GET /research-sys/api/v1/notification-producers/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "name": "(val)",
  "description": "(val)",
  "contactInfo": "(val)",
  "_primaryKey": "(val)"
}

Get All Notification Producers
GET/research-sys/api/v1/notification-producers/

Example URI

GET /research-sys/api/v1/notification-producers/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "contactInfo": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "contactInfo": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Notification Producers with Filtering
GET/research-sys/api/v1/notification-producers/

Example URI

GET /research-sys/api/v1/notification-producers/
URI Parameters
HideShow
id
string (optional) 
name
string (optional) 
description
string (optional) 
contactInfo
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "contactInfo": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "contactInfo": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Notification Producers
GET/research-sys/api/v1/notification-producers/

Example URI

GET /research-sys/api/v1/notification-producers/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "name",
    "description",
    "contactInfo"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Notification Producers
GET/research-sys/api/v1/notification-producers/

Example URI

GET /research-sys/api/v1/notification-producers/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Notification Producers.md"
transfer-encoding: chunked

Update Notification Producers
PUT/research-sys/api/v1/notification-producers/(key)

Example URI

PUT /research-sys/api/v1/notification-producers/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "name": "(val)",
  "description": "(val)",
  "contactInfo": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Notification Producers
PUT/research-sys/api/v1/notification-producers/

Example URI

PUT /research-sys/api/v1/notification-producers/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "contactInfo": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "contactInfo": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Notification Producers
PATCH/research-sys/api/v1/notification-producers/(key)

Example URI

PATCH /research-sys/api/v1/notification-producers/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "name": "(val)",
  "description": "(val)",
  "contactInfo": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "name": "(val)",
  "description": "(val)",
  "contactInfo": "(val)",
  "_primaryKey": "(val)"
}

Insert Notification Producers
POST/research-sys/api/v1/notification-producers/

Example URI

POST /research-sys/api/v1/notification-producers/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "name": "(val)",
  "description": "(val)",
  "contactInfo": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "name": "(val)",
  "description": "(val)",
  "contactInfo": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Notification Producers
POST/research-sys/api/v1/notification-producers/

Example URI

POST /research-sys/api/v1/notification-producers/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "contactInfo": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "contactInfo": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "contactInfo": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "contactInfo": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Notification Producers by Key
DELETE/research-sys/api/v1/notification-producers/(key)

Example URI

DELETE /research-sys/api/v1/notification-producers/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Notification Producers
DELETE/research-sys/api/v1/notification-producers/

Example URI

DELETE /research-sys/api/v1/notification-producers/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Notification Producers with Matching
DELETE/research-sys/api/v1/notification-producers/

Example URI

DELETE /research-sys/api/v1/notification-producers/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 
name
string (optional) 
description
string (optional) 
contactInfo
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Notification Recipient Lists

Get Notification Recipient Lists by Key
GET/research-sys/api/v1/notification-recipient-lists/(key)

Example URI

GET /research-sys/api/v1/notification-recipient-lists/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "recipientType": "(val)",
  "recipientId": "(val)",
  "_primaryKey": "(val)"
}

Get All Notification Recipient Lists
GET/research-sys/api/v1/notification-recipient-lists/

Example URI

GET /research-sys/api/v1/notification-recipient-lists/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "recipientType": "(val)",
    "recipientId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "recipientType": "(val)",
    "recipientId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Notification Recipient Lists with Filtering
GET/research-sys/api/v1/notification-recipient-lists/

Example URI

GET /research-sys/api/v1/notification-recipient-lists/
URI Parameters
HideShow
id
string (optional) 
recipientType
string (optional) 
recipientId
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "recipientType": "(val)",
    "recipientId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "recipientType": "(val)",
    "recipientId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Notification Recipient Lists
GET/research-sys/api/v1/notification-recipient-lists/

Example URI

GET /research-sys/api/v1/notification-recipient-lists/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "recipientType",
    "recipientId"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Notification Recipient Lists
GET/research-sys/api/v1/notification-recipient-lists/

Example URI

GET /research-sys/api/v1/notification-recipient-lists/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Notification Recipient Lists.md"
transfer-encoding: chunked

Update Notification Recipient Lists
PUT/research-sys/api/v1/notification-recipient-lists/(key)

Example URI

PUT /research-sys/api/v1/notification-recipient-lists/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "recipientType": "(val)",
  "recipientId": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Notification Recipient Lists
PUT/research-sys/api/v1/notification-recipient-lists/

Example URI

PUT /research-sys/api/v1/notification-recipient-lists/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "recipientType": "(val)",
    "recipientId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "recipientType": "(val)",
    "recipientId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Notification Recipient Lists
PATCH/research-sys/api/v1/notification-recipient-lists/(key)

Example URI

PATCH /research-sys/api/v1/notification-recipient-lists/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "recipientType": "(val)",
  "recipientId": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "recipientType": "(val)",
  "recipientId": "(val)",
  "_primaryKey": "(val)"
}

Insert Notification Recipient Lists
POST/research-sys/api/v1/notification-recipient-lists/

Example URI

POST /research-sys/api/v1/notification-recipient-lists/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "recipientType": "(val)",
  "recipientId": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "recipientType": "(val)",
  "recipientId": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Notification Recipient Lists
POST/research-sys/api/v1/notification-recipient-lists/

Example URI

POST /research-sys/api/v1/notification-recipient-lists/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "recipientType": "(val)",
    "recipientId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "recipientType": "(val)",
    "recipientId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "recipientType": "(val)",
    "recipientId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "recipientType": "(val)",
    "recipientId": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Notification Recipient Lists by Key
DELETE/research-sys/api/v1/notification-recipient-lists/(key)

Example URI

DELETE /research-sys/api/v1/notification-recipient-lists/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Notification Recipient Lists
DELETE/research-sys/api/v1/notification-recipient-lists/

Example URI

DELETE /research-sys/api/v1/notification-recipient-lists/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Notification Recipient Lists with Matching
DELETE/research-sys/api/v1/notification-recipient-lists/

Example URI

DELETE /research-sys/api/v1/notification-recipient-lists/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 
recipientType
string (optional) 
recipientId
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Notification Recipients

Get Notification Recipients by Key
GET/research-sys/api/v1/notification-recipients/(key)

Example URI

GET /research-sys/api/v1/notification-recipients/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "recipientType": "(val)",
  "recipientId": "(val)",
  "_primaryKey": "(val)"
}

Get All Notification Recipients
GET/research-sys/api/v1/notification-recipients/

Example URI

GET /research-sys/api/v1/notification-recipients/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "recipientType": "(val)",
    "recipientId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "recipientType": "(val)",
    "recipientId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Notification Recipients with Filtering
GET/research-sys/api/v1/notification-recipients/

Example URI

GET /research-sys/api/v1/notification-recipients/
URI Parameters
HideShow
id
string (optional) 
recipientType
string (optional) 
recipientId
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "recipientType": "(val)",
    "recipientId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "recipientType": "(val)",
    "recipientId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Notification Recipients
GET/research-sys/api/v1/notification-recipients/

Example URI

GET /research-sys/api/v1/notification-recipients/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "recipientType",
    "recipientId"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Notification Recipients
GET/research-sys/api/v1/notification-recipients/

Example URI

GET /research-sys/api/v1/notification-recipients/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Notification Recipients.md"
transfer-encoding: chunked

Update Notification Recipients
PUT/research-sys/api/v1/notification-recipients/(key)

Example URI

PUT /research-sys/api/v1/notification-recipients/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "recipientType": "(val)",
  "recipientId": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Notification Recipients
PUT/research-sys/api/v1/notification-recipients/

Example URI

PUT /research-sys/api/v1/notification-recipients/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "recipientType": "(val)",
    "recipientId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "recipientType": "(val)",
    "recipientId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Notification Recipients
PATCH/research-sys/api/v1/notification-recipients/(key)

Example URI

PATCH /research-sys/api/v1/notification-recipients/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "recipientType": "(val)",
  "recipientId": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "recipientType": "(val)",
  "recipientId": "(val)",
  "_primaryKey": "(val)"
}

Insert Notification Recipients
POST/research-sys/api/v1/notification-recipients/

Example URI

POST /research-sys/api/v1/notification-recipients/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "recipientType": "(val)",
  "recipientId": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "recipientType": "(val)",
  "recipientId": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Notification Recipients
POST/research-sys/api/v1/notification-recipients/

Example URI

POST /research-sys/api/v1/notification-recipients/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "recipientType": "(val)",
    "recipientId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "recipientType": "(val)",
    "recipientId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "recipientType": "(val)",
    "recipientId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "recipientType": "(val)",
    "recipientId": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Notification Recipients by Key
DELETE/research-sys/api/v1/notification-recipients/(key)

Example URI

DELETE /research-sys/api/v1/notification-recipients/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Notification Recipients
DELETE/research-sys/api/v1/notification-recipients/

Example URI

DELETE /research-sys/api/v1/notification-recipients/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Notification Recipients with Matching
DELETE/research-sys/api/v1/notification-recipients/

Example URI

DELETE /research-sys/api/v1/notification-recipients/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 
recipientType
string (optional) 
recipientId
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Notification Senders

Get Notification Senders by Key
GET/research-sys/api/v1/notification-senders/(key)

Example URI

GET /research-sys/api/v1/notification-senders/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "senderName": "(val)",
  "_primaryKey": "(val)"
}

Get All Notification Senders
GET/research-sys/api/v1/notification-senders/

Example URI

GET /research-sys/api/v1/notification-senders/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "senderName": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "senderName": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Notification Senders with Filtering
GET/research-sys/api/v1/notification-senders/

Example URI

GET /research-sys/api/v1/notification-senders/
URI Parameters
HideShow
id
string (optional) 
senderName
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "senderName": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "senderName": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Notification Senders
GET/research-sys/api/v1/notification-senders/

Example URI

GET /research-sys/api/v1/notification-senders/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "senderName"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Notification Senders
GET/research-sys/api/v1/notification-senders/

Example URI

GET /research-sys/api/v1/notification-senders/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Notification Senders.md"
transfer-encoding: chunked

Update Notification Senders
PUT/research-sys/api/v1/notification-senders/(key)

Example URI

PUT /research-sys/api/v1/notification-senders/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "senderName": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Notification Senders
PUT/research-sys/api/v1/notification-senders/

Example URI

PUT /research-sys/api/v1/notification-senders/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "senderName": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "senderName": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Notification Senders
PATCH/research-sys/api/v1/notification-senders/(key)

Example URI

PATCH /research-sys/api/v1/notification-senders/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "senderName": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "senderName": "(val)",
  "_primaryKey": "(val)"
}

Insert Notification Senders
POST/research-sys/api/v1/notification-senders/

Example URI

POST /research-sys/api/v1/notification-senders/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "senderName": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "senderName": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Notification Senders
POST/research-sys/api/v1/notification-senders/

Example URI

POST /research-sys/api/v1/notification-senders/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "senderName": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "senderName": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "senderName": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "senderName": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Notification Senders by Key
DELETE/research-sys/api/v1/notification-senders/(key)

Example URI

DELETE /research-sys/api/v1/notification-senders/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Notification Senders
DELETE/research-sys/api/v1/notification-senders/

Example URI

DELETE /research-sys/api/v1/notification-senders/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Notification Senders with Matching
DELETE/research-sys/api/v1/notification-senders/

Example URI

DELETE /research-sys/api/v1/notification-senders/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 
senderName
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Notifications

Get Notifications by Key
GET/research-sys/api/v1/notifications/(key)

Example URI

GET /research-sys/api/v1/notifications/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "deliveryType": "(val)",
  "creationDateTimeValue": "(val)",
  "sendDateTimeValue": "(val)",
  "autoRemoveDateTimeValue": "(val)",
  "title": "(val)",
  "content": "(val)",
  "processingFlag": "(val)",
  "lockedDateValue": "(val)",
  "docTypeName": "(val)",
  "_primaryKey": "(val)"
}

Get All Notifications
GET/research-sys/api/v1/notifications/

Example URI

GET /research-sys/api/v1/notifications/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "deliveryType": "(val)",
    "creationDateTimeValue": "(val)",
    "sendDateTimeValue": "(val)",
    "autoRemoveDateTimeValue": "(val)",
    "title": "(val)",
    "content": "(val)",
    "processingFlag": "(val)",
    "lockedDateValue": "(val)",
    "docTypeName": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "deliveryType": "(val)",
    "creationDateTimeValue": "(val)",
    "sendDateTimeValue": "(val)",
    "autoRemoveDateTimeValue": "(val)",
    "title": "(val)",
    "content": "(val)",
    "processingFlag": "(val)",
    "lockedDateValue": "(val)",
    "docTypeName": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Notifications with Filtering
GET/research-sys/api/v1/notifications/

Example URI

GET /research-sys/api/v1/notifications/
URI Parameters
HideShow
id
string (optional) 
deliveryType
string (optional) 
creationDateTimeValue
string (optional) 
sendDateTimeValue
string (optional) 
autoRemoveDateTimeValue
string (optional) 
title
string (optional) 
content
string (optional) 
processingFlag
string (optional) 
lockedDateValue
string (optional) 
docTypeName
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "deliveryType": "(val)",
    "creationDateTimeValue": "(val)",
    "sendDateTimeValue": "(val)",
    "autoRemoveDateTimeValue": "(val)",
    "title": "(val)",
    "content": "(val)",
    "processingFlag": "(val)",
    "lockedDateValue": "(val)",
    "docTypeName": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "deliveryType": "(val)",
    "creationDateTimeValue": "(val)",
    "sendDateTimeValue": "(val)",
    "autoRemoveDateTimeValue": "(val)",
    "title": "(val)",
    "content": "(val)",
    "processingFlag": "(val)",
    "lockedDateValue": "(val)",
    "docTypeName": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Notifications
GET/research-sys/api/v1/notifications/

Example URI

GET /research-sys/api/v1/notifications/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "deliveryType",
    "creationDateTimeValue",
    "sendDateTimeValue",
    "autoRemoveDateTimeValue",
    "title",
    "content",
    "processingFlag",
    "lockedDateValue",
    "docTypeName"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Notifications
GET/research-sys/api/v1/notifications/

Example URI

GET /research-sys/api/v1/notifications/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Notifications.md"
transfer-encoding: chunked

Update Notifications
PUT/research-sys/api/v1/notifications/(key)

Example URI

PUT /research-sys/api/v1/notifications/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "deliveryType": "(val)",
  "creationDateTimeValue": "(val)",
  "sendDateTimeValue": "(val)",
  "autoRemoveDateTimeValue": "(val)",
  "title": "(val)",
  "content": "(val)",
  "processingFlag": "(val)",
  "lockedDateValue": "(val)",
  "docTypeName": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Notifications
PUT/research-sys/api/v1/notifications/

Example URI

PUT /research-sys/api/v1/notifications/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "deliveryType": "(val)",
    "creationDateTimeValue": "(val)",
    "sendDateTimeValue": "(val)",
    "autoRemoveDateTimeValue": "(val)",
    "title": "(val)",
    "content": "(val)",
    "processingFlag": "(val)",
    "lockedDateValue": "(val)",
    "docTypeName": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "deliveryType": "(val)",
    "creationDateTimeValue": "(val)",
    "sendDateTimeValue": "(val)",
    "autoRemoveDateTimeValue": "(val)",
    "title": "(val)",
    "content": "(val)",
    "processingFlag": "(val)",
    "lockedDateValue": "(val)",
    "docTypeName": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Notifications
PATCH/research-sys/api/v1/notifications/(key)

Example URI

PATCH /research-sys/api/v1/notifications/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "deliveryType": "(val)",
  "creationDateTimeValue": "(val)",
  "sendDateTimeValue": "(val)",
  "autoRemoveDateTimeValue": "(val)",
  "title": "(val)",
  "content": "(val)",
  "processingFlag": "(val)",
  "lockedDateValue": "(val)",
  "docTypeName": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "deliveryType": "(val)",
  "creationDateTimeValue": "(val)",
  "sendDateTimeValue": "(val)",
  "autoRemoveDateTimeValue": "(val)",
  "title": "(val)",
  "content": "(val)",
  "processingFlag": "(val)",
  "lockedDateValue": "(val)",
  "docTypeName": "(val)",
  "_primaryKey": "(val)"
}

Insert Notifications
POST/research-sys/api/v1/notifications/

Example URI

POST /research-sys/api/v1/notifications/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "deliveryType": "(val)",
  "creationDateTimeValue": "(val)",
  "sendDateTimeValue": "(val)",
  "autoRemoveDateTimeValue": "(val)",
  "title": "(val)",
  "content": "(val)",
  "processingFlag": "(val)",
  "lockedDateValue": "(val)",
  "docTypeName": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "deliveryType": "(val)",
  "creationDateTimeValue": "(val)",
  "sendDateTimeValue": "(val)",
  "autoRemoveDateTimeValue": "(val)",
  "title": "(val)",
  "content": "(val)",
  "processingFlag": "(val)",
  "lockedDateValue": "(val)",
  "docTypeName": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Notifications
POST/research-sys/api/v1/notifications/

Example URI

POST /research-sys/api/v1/notifications/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "deliveryType": "(val)",
    "creationDateTimeValue": "(val)",
    "sendDateTimeValue": "(val)",
    "autoRemoveDateTimeValue": "(val)",
    "title": "(val)",
    "content": "(val)",
    "processingFlag": "(val)",
    "lockedDateValue": "(val)",
    "docTypeName": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "deliveryType": "(val)",
    "creationDateTimeValue": "(val)",
    "sendDateTimeValue": "(val)",
    "autoRemoveDateTimeValue": "(val)",
    "title": "(val)",
    "content": "(val)",
    "processingFlag": "(val)",
    "lockedDateValue": "(val)",
    "docTypeName": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "deliveryType": "(val)",
    "creationDateTimeValue": "(val)",
    "sendDateTimeValue": "(val)",
    "autoRemoveDateTimeValue": "(val)",
    "title": "(val)",
    "content": "(val)",
    "processingFlag": "(val)",
    "lockedDateValue": "(val)",
    "docTypeName": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "deliveryType": "(val)",
    "creationDateTimeValue": "(val)",
    "sendDateTimeValue": "(val)",
    "autoRemoveDateTimeValue": "(val)",
    "title": "(val)",
    "content": "(val)",
    "processingFlag": "(val)",
    "lockedDateValue": "(val)",
    "docTypeName": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Notifications by Key
DELETE/research-sys/api/v1/notifications/(key)

Example URI

DELETE /research-sys/api/v1/notifications/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Notifications
DELETE/research-sys/api/v1/notifications/

Example URI

DELETE /research-sys/api/v1/notifications/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Notifications with Matching
DELETE/research-sys/api/v1/notifications/

Example URI

DELETE /research-sys/api/v1/notifications/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 
deliveryType
string (optional) 
creationDateTimeValue
string (optional) 
sendDateTimeValue
string (optional) 
autoRemoveDateTimeValue
string (optional) 
title
string (optional) 
content
string (optional) 
processingFlag
string (optional) 
lockedDateValue
string (optional) 
docTypeName
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Parameter Types

Get Parameter Types by Key
GET/research-sys/api/v1/parameter-types/(key)

Example URI

GET /research-sys/api/v1/parameter-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "code": "(val)",
  "name": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Get All Parameter Types
GET/research-sys/api/v1/parameter-types/

Example URI

GET /research-sys/api/v1/parameter-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Parameter Types with Filtering
GET/research-sys/api/v1/parameter-types/

Example URI

GET /research-sys/api/v1/parameter-types/
URI Parameters
HideShow
code
string (optional) 

Code identifying the parameter type. Maximum length is 5.

name
string (optional) 

The name of the parameter type. Maximum length is 40.

active
string (optional) 

This attribute is used to describe whether the associated object is active or inactive. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Parameter Types
GET/research-sys/api/v1/parameter-types/

Example URI

GET /research-sys/api/v1/parameter-types/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "code",
    "name",
    "active"
  ],
  "primaryKey": "code"
}

Get Blueprint API specification for Parameter Types
GET/research-sys/api/v1/parameter-types/

Example URI

GET /research-sys/api/v1/parameter-types/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Parameter Types.md"
transfer-encoding: chunked

Update Parameter Types
PUT/research-sys/api/v1/parameter-types/(key)

Example URI

PUT /research-sys/api/v1/parameter-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "code": "(val)",
  "name": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Parameter Types
PUT/research-sys/api/v1/parameter-types/

Example URI

PUT /research-sys/api/v1/parameter-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Parameter Types
PATCH/research-sys/api/v1/parameter-types/(key)

Example URI

PATCH /research-sys/api/v1/parameter-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "code": "(val)",
  "name": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "code": "(val)",
  "name": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Parameter Types
POST/research-sys/api/v1/parameter-types/

Example URI

POST /research-sys/api/v1/parameter-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "code": "(val)",
  "name": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "code": "(val)",
  "name": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Parameter Types
POST/research-sys/api/v1/parameter-types/

Example URI

POST /research-sys/api/v1/parameter-types/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "code": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Parameter Types by Key
DELETE/research-sys/api/v1/parameter-types/(key)

Example URI

DELETE /research-sys/api/v1/parameter-types/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Parameter Types
DELETE/research-sys/api/v1/parameter-types/

Example URI

DELETE /research-sys/api/v1/parameter-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Parameter Types with Matching
DELETE/research-sys/api/v1/parameter-types/

Example URI

DELETE /research-sys/api/v1/parameter-types/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

code
string (optional) 

Code identifying the parameter type. Maximum length is 5.

name
string (optional) 

The name of the parameter type. Maximum length is 40.

active
string (optional) 

This attribute is used to describe whether the associated object is active or inactive. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Parameters

Get Parameters by Key
GET/research-sys/api/v1/parameters/(key)

Example URI

GET /research-sys/api/v1/parameters/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "namespaceCode": "(val)",
  "componentCode": "(val)",
  "name": "(val)",
  "applicationId": "(val)",
  "value": "(val)",
  "description": "(val)",
  "parameterTypeCode": "(val)",
  "evaluationOperatorCode": "(val)",
  "_primaryKey": "(val)"
}

Get All Parameters
GET/research-sys/api/v1/parameters/

Example URI

GET /research-sys/api/v1/parameters/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "namespaceCode": "(val)",
    "componentCode": "(val)",
    "name": "(val)",
    "applicationId": "(val)",
    "value": "(val)",
    "description": "(val)",
    "parameterTypeCode": "(val)",
    "evaluationOperatorCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "namespaceCode": "(val)",
    "componentCode": "(val)",
    "name": "(val)",
    "applicationId": "(val)",
    "value": "(val)",
    "description": "(val)",
    "parameterTypeCode": "(val)",
    "evaluationOperatorCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Parameters with Filtering
GET/research-sys/api/v1/parameters/

Example URI

GET /research-sys/api/v1/parameters/
URI Parameters
HideShow
namespaceCode
string (optional) 

This value is used to categorize parameters by namespace. Maximum length is 20.

componentCode
string (optional) 

Code identifying the Component. Maximum length is 100.

name
string (optional) 

This will be used as the identifier for the parameter. Parameter values will be accessed using this field and the namespace as the key. Maximum length is 100.

applicationId
string (optional) 

This will be used as the identifier to determine which application the parameter is used by. Maximum length is 20.

value
string (optional) 

This field houses the actual value associated with the parameter. This is what’s returned by the KualiConfigurationService. Maximum length is 4000.

description
string (optional) 

This field houses the purpose of this parameter. Maximum length is 4000.

parameterTypeCode
string (optional) 

Code identifying the parameter type. Maximum length is 5.

evaluationOperatorCode
string (optional) 

evaluationOperatorCode description… Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "namespaceCode": "(val)",
    "componentCode": "(val)",
    "name": "(val)",
    "applicationId": "(val)",
    "value": "(val)",
    "description": "(val)",
    "parameterTypeCode": "(val)",
    "evaluationOperatorCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "namespaceCode": "(val)",
    "componentCode": "(val)",
    "name": "(val)",
    "applicationId": "(val)",
    "value": "(val)",
    "description": "(val)",
    "parameterTypeCode": "(val)",
    "evaluationOperatorCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Parameters
GET/research-sys/api/v1/parameters/

Example URI

GET /research-sys/api/v1/parameters/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "namespaceCode",
    "componentCode",
    "name",
    "applicationId",
    "value",
    "description",
    "parameterTypeCode",
    "evaluationOperatorCode"
  ],
  "primaryKey": "applicationId:componentCode:name:namespaceCode"
}

Get Blueprint API specification for Parameters
GET/research-sys/api/v1/parameters/

Example URI

GET /research-sys/api/v1/parameters/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Parameters.md"
transfer-encoding: chunked

Update Parameters
PUT/research-sys/api/v1/parameters/(key)

Example URI

PUT /research-sys/api/v1/parameters/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "namespaceCode": "(val)",
  "componentCode": "(val)",
  "name": "(val)",
  "applicationId": "(val)",
  "value": "(val)",
  "description": "(val)",
  "parameterTypeCode": "(val)",
  "evaluationOperatorCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Parameters
PUT/research-sys/api/v1/parameters/

Example URI

PUT /research-sys/api/v1/parameters/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "namespaceCode": "(val)",
    "componentCode": "(val)",
    "name": "(val)",
    "applicationId": "(val)",
    "value": "(val)",
    "description": "(val)",
    "parameterTypeCode": "(val)",
    "evaluationOperatorCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "namespaceCode": "(val)",
    "componentCode": "(val)",
    "name": "(val)",
    "applicationId": "(val)",
    "value": "(val)",
    "description": "(val)",
    "parameterTypeCode": "(val)",
    "evaluationOperatorCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Parameters
PATCH/research-sys/api/v1/parameters/(key)

Example URI

PATCH /research-sys/api/v1/parameters/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "namespaceCode": "(val)",
  "componentCode": "(val)",
  "name": "(val)",
  "applicationId": "(val)",
  "value": "(val)",
  "description": "(val)",
  "parameterTypeCode": "(val)",
  "evaluationOperatorCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "namespaceCode": "(val)",
  "componentCode": "(val)",
  "name": "(val)",
  "applicationId": "(val)",
  "value": "(val)",
  "description": "(val)",
  "parameterTypeCode": "(val)",
  "evaluationOperatorCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Parameters
POST/research-sys/api/v1/parameters/

Example URI

POST /research-sys/api/v1/parameters/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "namespaceCode": "(val)",
  "componentCode": "(val)",
  "name": "(val)",
  "applicationId": "(val)",
  "value": "(val)",
  "description": "(val)",
  "parameterTypeCode": "(val)",
  "evaluationOperatorCode": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "namespaceCode": "(val)",
  "componentCode": "(val)",
  "name": "(val)",
  "applicationId": "(val)",
  "value": "(val)",
  "description": "(val)",
  "parameterTypeCode": "(val)",
  "evaluationOperatorCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Parameters
POST/research-sys/api/v1/parameters/

Example URI

POST /research-sys/api/v1/parameters/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "namespaceCode": "(val)",
    "componentCode": "(val)",
    "name": "(val)",
    "applicationId": "(val)",
    "value": "(val)",
    "description": "(val)",
    "parameterTypeCode": "(val)",
    "evaluationOperatorCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "namespaceCode": "(val)",
    "componentCode": "(val)",
    "name": "(val)",
    "applicationId": "(val)",
    "value": "(val)",
    "description": "(val)",
    "parameterTypeCode": "(val)",
    "evaluationOperatorCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "namespaceCode": "(val)",
    "componentCode": "(val)",
    "name": "(val)",
    "applicationId": "(val)",
    "value": "(val)",
    "description": "(val)",
    "parameterTypeCode": "(val)",
    "evaluationOperatorCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "namespaceCode": "(val)",
    "componentCode": "(val)",
    "name": "(val)",
    "applicationId": "(val)",
    "value": "(val)",
    "description": "(val)",
    "parameterTypeCode": "(val)",
    "evaluationOperatorCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Parameters by Key
DELETE/research-sys/api/v1/parameters/(key)

Example URI

DELETE /research-sys/api/v1/parameters/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Parameters
DELETE/research-sys/api/v1/parameters/

Example URI

DELETE /research-sys/api/v1/parameters/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Parameters with Matching
DELETE/research-sys/api/v1/parameters/

Example URI

DELETE /research-sys/api/v1/parameters/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

namespaceCode
string (optional) 

This value is used to categorize parameters by namespace. Maximum length is 20.

componentCode
string (optional) 

Code identifying the Component. Maximum length is 100.

name
string (optional) 

This will be used as the identifier for the parameter. Parameter values will be accessed using this field and the namespace as the key. Maximum length is 100.

applicationId
string (optional) 

This will be used as the identifier to determine which application the parameter is used by. Maximum length is 20.

value
string (optional) 

This field houses the actual value associated with the parameter. This is what’s returned by the KualiConfigurationService. Maximum length is 4000.

description
string (optional) 

This field houses the purpose of this parameter. Maximum length is 4000.

parameterTypeCode
string (optional) 

Code identifying the parameter type. Maximum length is 5.

evaluationOperatorCode
string (optional) 

evaluationOperatorCode description… Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

People Flow Attributes

Get People Flow Attributes by Key
GET/research-sys/api/v1/people-flow-attributes/(key)

Example URI

GET /research-sys/api/v1/people-flow-attributes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "value": "(val)",
  "_primaryKey": "(val)"
}

Get All People Flow Attributes
GET/research-sys/api/v1/people-flow-attributes/

Example URI

GET /research-sys/api/v1/people-flow-attributes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All People Flow Attributes with Filtering
GET/research-sys/api/v1/people-flow-attributes/

Example URI

GET /research-sys/api/v1/people-flow-attributes/
URI Parameters
HideShow
id
string (optional) 
value
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for People Flow Attributes
GET/research-sys/api/v1/people-flow-attributes/

Example URI

GET /research-sys/api/v1/people-flow-attributes/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "value"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for People Flow Attributes
GET/research-sys/api/v1/people-flow-attributes/

Example URI

GET /research-sys/api/v1/people-flow-attributes/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="People Flow Attributes.md"
transfer-encoding: chunked

Update People Flow Attributes
PUT/research-sys/api/v1/people-flow-attributes/(key)

Example URI

PUT /research-sys/api/v1/people-flow-attributes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "value": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple People Flow Attributes
PUT/research-sys/api/v1/people-flow-attributes/

Example URI

PUT /research-sys/api/v1/people-flow-attributes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes People Flow Attributes
PATCH/research-sys/api/v1/people-flow-attributes/(key)

Example URI

PATCH /research-sys/api/v1/people-flow-attributes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "value": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "value": "(val)",
  "_primaryKey": "(val)"
}

Insert People Flow Attributes
POST/research-sys/api/v1/people-flow-attributes/

Example URI

POST /research-sys/api/v1/people-flow-attributes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "value": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "value": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple People Flow Attributes
POST/research-sys/api/v1/people-flow-attributes/

Example URI

POST /research-sys/api/v1/people-flow-attributes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete People Flow Attributes by Key
DELETE/research-sys/api/v1/people-flow-attributes/(key)

Example URI

DELETE /research-sys/api/v1/people-flow-attributes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All People Flow Attributes
DELETE/research-sys/api/v1/people-flow-attributes/

Example URI

DELETE /research-sys/api/v1/people-flow-attributes/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All People Flow Attributes with Matching
DELETE/research-sys/api/v1/people-flow-attributes/

Example URI

DELETE /research-sys/api/v1/people-flow-attributes/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 
value
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

People Flow Delegates

Get People Flow Delegates by Key
GET/research-sys/api/v1/people-flow-delegates/(key)

Example URI

GET /research-sys/api/v1/people-flow-delegates/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "memberId": "(val)",
  "memberTypeCode": "(val)",
  "actionRequestPolicyCode": "(val)",
  "delegationTypeCode": "(val)",
  "responsibilityId": "(val)",
  "_primaryKey": "(val)"
}

Get All People Flow Delegates
GET/research-sys/api/v1/people-flow-delegates/

Example URI

GET /research-sys/api/v1/people-flow-delegates/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "memberId": "(val)",
    "memberTypeCode": "(val)",
    "actionRequestPolicyCode": "(val)",
    "delegationTypeCode": "(val)",
    "responsibilityId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "memberId": "(val)",
    "memberTypeCode": "(val)",
    "actionRequestPolicyCode": "(val)",
    "delegationTypeCode": "(val)",
    "responsibilityId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All People Flow Delegates with Filtering
GET/research-sys/api/v1/people-flow-delegates/

Example URI

GET /research-sys/api/v1/people-flow-delegates/
URI Parameters
HideShow
id
string (optional) 

Id.

memberId
string (optional) 

Member id for the map stop. Maximum length is 40.

memberTypeCode
string (optional) 

Type of the member the stop will go to. Maximum length is 1.

actionRequestPolicyCode
string (optional) 

For role members determines whether all members must take action or just the first.

delegationTypeCode
string (optional) 

Delegation type (primary or secondary) for the delegate.

responsibilityId
string (optional) 

Responsibility Id.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "memberId": "(val)",
    "memberTypeCode": "(val)",
    "actionRequestPolicyCode": "(val)",
    "delegationTypeCode": "(val)",
    "responsibilityId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "memberId": "(val)",
    "memberTypeCode": "(val)",
    "actionRequestPolicyCode": "(val)",
    "delegationTypeCode": "(val)",
    "responsibilityId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for People Flow Delegates
GET/research-sys/api/v1/people-flow-delegates/

Example URI

GET /research-sys/api/v1/people-flow-delegates/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "memberId",
    "memberTypeCode",
    "actionRequestPolicyCode",
    "delegationTypeCode",
    "responsibilityId"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for People Flow Delegates
GET/research-sys/api/v1/people-flow-delegates/

Example URI

GET /research-sys/api/v1/people-flow-delegates/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="People Flow Delegates.md"
transfer-encoding: chunked

Update People Flow Delegates
PUT/research-sys/api/v1/people-flow-delegates/(key)

Example URI

PUT /research-sys/api/v1/people-flow-delegates/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "memberId": "(val)",
  "memberTypeCode": "(val)",
  "actionRequestPolicyCode": "(val)",
  "delegationTypeCode": "(val)",
  "responsibilityId": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple People Flow Delegates
PUT/research-sys/api/v1/people-flow-delegates/

Example URI

PUT /research-sys/api/v1/people-flow-delegates/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "memberId": "(val)",
    "memberTypeCode": "(val)",
    "actionRequestPolicyCode": "(val)",
    "delegationTypeCode": "(val)",
    "responsibilityId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "memberId": "(val)",
    "memberTypeCode": "(val)",
    "actionRequestPolicyCode": "(val)",
    "delegationTypeCode": "(val)",
    "responsibilityId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes People Flow Delegates
PATCH/research-sys/api/v1/people-flow-delegates/(key)

Example URI

PATCH /research-sys/api/v1/people-flow-delegates/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "memberId": "(val)",
  "memberTypeCode": "(val)",
  "actionRequestPolicyCode": "(val)",
  "delegationTypeCode": "(val)",
  "responsibilityId": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "memberId": "(val)",
  "memberTypeCode": "(val)",
  "actionRequestPolicyCode": "(val)",
  "delegationTypeCode": "(val)",
  "responsibilityId": "(val)",
  "_primaryKey": "(val)"
}

Insert People Flow Delegates
POST/research-sys/api/v1/people-flow-delegates/

Example URI

POST /research-sys/api/v1/people-flow-delegates/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "memberId": "(val)",
  "memberTypeCode": "(val)",
  "actionRequestPolicyCode": "(val)",
  "delegationTypeCode": "(val)",
  "responsibilityId": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "memberId": "(val)",
  "memberTypeCode": "(val)",
  "actionRequestPolicyCode": "(val)",
  "delegationTypeCode": "(val)",
  "responsibilityId": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple People Flow Delegates
POST/research-sys/api/v1/people-flow-delegates/

Example URI

POST /research-sys/api/v1/people-flow-delegates/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "memberId": "(val)",
    "memberTypeCode": "(val)",
    "actionRequestPolicyCode": "(val)",
    "delegationTypeCode": "(val)",
    "responsibilityId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "memberId": "(val)",
    "memberTypeCode": "(val)",
    "actionRequestPolicyCode": "(val)",
    "delegationTypeCode": "(val)",
    "responsibilityId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "memberId": "(val)",
    "memberTypeCode": "(val)",
    "actionRequestPolicyCode": "(val)",
    "delegationTypeCode": "(val)",
    "responsibilityId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "memberId": "(val)",
    "memberTypeCode": "(val)",
    "actionRequestPolicyCode": "(val)",
    "delegationTypeCode": "(val)",
    "responsibilityId": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete People Flow Delegates by Key
DELETE/research-sys/api/v1/people-flow-delegates/(key)

Example URI

DELETE /research-sys/api/v1/people-flow-delegates/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All People Flow Delegates
DELETE/research-sys/api/v1/people-flow-delegates/

Example URI

DELETE /research-sys/api/v1/people-flow-delegates/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All People Flow Delegates with Matching
DELETE/research-sys/api/v1/people-flow-delegates/

Example URI

DELETE /research-sys/api/v1/people-flow-delegates/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 

Id.

memberId
string (optional) 

Member id for the map stop. Maximum length is 40.

memberTypeCode
string (optional) 

Type of the member the stop will go to. Maximum length is 1.

actionRequestPolicyCode
string (optional) 

For role members determines whether all members must take action or just the first.

delegationTypeCode
string (optional) 

Delegation type (primary or secondary) for the delegate.

responsibilityId
string (optional) 

Responsibility Id.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

People Flow Members

Get People Flow Members by Key
GET/research-sys/api/v1/people-flow-members/(key)

Example URI

GET /research-sys/api/v1/people-flow-members/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "memberId": "(val)",
  "memberTypeCode": "(val)",
  "actionRequestPolicyCode": "(val)",
  "responsibilityId": "(val)",
  "priority": "(val)",
  "forceAction": "(val)",
  "_primaryKey": "(val)"
}

Get All People Flow Members
GET/research-sys/api/v1/people-flow-members/

Example URI

GET /research-sys/api/v1/people-flow-members/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "memberId": "(val)",
    "memberTypeCode": "(val)",
    "actionRequestPolicyCode": "(val)",
    "responsibilityId": "(val)",
    "priority": "(val)",
    "forceAction": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "memberId": "(val)",
    "memberTypeCode": "(val)",
    "actionRequestPolicyCode": "(val)",
    "responsibilityId": "(val)",
    "priority": "(val)",
    "forceAction": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All People Flow Members with Filtering
GET/research-sys/api/v1/people-flow-members/

Example URI

GET /research-sys/api/v1/people-flow-members/
URI Parameters
HideShow
id
string (optional) 

Id.

memberId
string (optional) 

Member id for the map stop. Maximum length is 40.

memberTypeCode
string (optional) 

Type of the member the stop will go to. Maximum length is 1.

actionRequestPolicyCode
string (optional) 

For role members determines whether all members must take action or just the first.

responsibilityId
string (optional) 

Responsibility Id.

priority
string (optional) 

Stop number that the member should receive the request.

forceAction
string (optional) 

Specifies whether requests for this member must be acted on even if they have already taken that action in the workflow.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "memberId": "(val)",
    "memberTypeCode": "(val)",
    "actionRequestPolicyCode": "(val)",
    "responsibilityId": "(val)",
    "priority": "(val)",
    "forceAction": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "memberId": "(val)",
    "memberTypeCode": "(val)",
    "actionRequestPolicyCode": "(val)",
    "responsibilityId": "(val)",
    "priority": "(val)",
    "forceAction": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for People Flow Members
GET/research-sys/api/v1/people-flow-members/

Example URI

GET /research-sys/api/v1/people-flow-members/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "memberId",
    "memberTypeCode",
    "actionRequestPolicyCode",
    "responsibilityId",
    "priority",
    "forceAction"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for People Flow Members
GET/research-sys/api/v1/people-flow-members/

Example URI

GET /research-sys/api/v1/people-flow-members/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="People Flow Members.md"
transfer-encoding: chunked

Update People Flow Members
PUT/research-sys/api/v1/people-flow-members/(key)

Example URI

PUT /research-sys/api/v1/people-flow-members/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "memberId": "(val)",
  "memberTypeCode": "(val)",
  "actionRequestPolicyCode": "(val)",
  "responsibilityId": "(val)",
  "priority": "(val)",
  "forceAction": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple People Flow Members
PUT/research-sys/api/v1/people-flow-members/

Example URI

PUT /research-sys/api/v1/people-flow-members/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "memberId": "(val)",
    "memberTypeCode": "(val)",
    "actionRequestPolicyCode": "(val)",
    "responsibilityId": "(val)",
    "priority": "(val)",
    "forceAction": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "memberId": "(val)",
    "memberTypeCode": "(val)",
    "actionRequestPolicyCode": "(val)",
    "responsibilityId": "(val)",
    "priority": "(val)",
    "forceAction": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes People Flow Members
PATCH/research-sys/api/v1/people-flow-members/(key)

Example URI

PATCH /research-sys/api/v1/people-flow-members/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "memberId": "(val)",
  "memberTypeCode": "(val)",
  "actionRequestPolicyCode": "(val)",
  "responsibilityId": "(val)",
  "priority": "(val)",
  "forceAction": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "memberId": "(val)",
  "memberTypeCode": "(val)",
  "actionRequestPolicyCode": "(val)",
  "responsibilityId": "(val)",
  "priority": "(val)",
  "forceAction": "(val)",
  "_primaryKey": "(val)"
}

Insert People Flow Members
POST/research-sys/api/v1/people-flow-members/

Example URI

POST /research-sys/api/v1/people-flow-members/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "memberId": "(val)",
  "memberTypeCode": "(val)",
  "actionRequestPolicyCode": "(val)",
  "responsibilityId": "(val)",
  "priority": "(val)",
  "forceAction": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "memberId": "(val)",
  "memberTypeCode": "(val)",
  "actionRequestPolicyCode": "(val)",
  "responsibilityId": "(val)",
  "priority": "(val)",
  "forceAction": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple People Flow Members
POST/research-sys/api/v1/people-flow-members/

Example URI

POST /research-sys/api/v1/people-flow-members/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "memberId": "(val)",
    "memberTypeCode": "(val)",
    "actionRequestPolicyCode": "(val)",
    "responsibilityId": "(val)",
    "priority": "(val)",
    "forceAction": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "memberId": "(val)",
    "memberTypeCode": "(val)",
    "actionRequestPolicyCode": "(val)",
    "responsibilityId": "(val)",
    "priority": "(val)",
    "forceAction": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "memberId": "(val)",
    "memberTypeCode": "(val)",
    "actionRequestPolicyCode": "(val)",
    "responsibilityId": "(val)",
    "priority": "(val)",
    "forceAction": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "memberId": "(val)",
    "memberTypeCode": "(val)",
    "actionRequestPolicyCode": "(val)",
    "responsibilityId": "(val)",
    "priority": "(val)",
    "forceAction": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete People Flow Members by Key
DELETE/research-sys/api/v1/people-flow-members/(key)

Example URI

DELETE /research-sys/api/v1/people-flow-members/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All People Flow Members
DELETE/research-sys/api/v1/people-flow-members/

Example URI

DELETE /research-sys/api/v1/people-flow-members/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All People Flow Members with Matching
DELETE/research-sys/api/v1/people-flow-members/

Example URI

DELETE /research-sys/api/v1/people-flow-members/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 

Id.

memberId
string (optional) 

Member id for the map stop. Maximum length is 40.

memberTypeCode
string (optional) 

Type of the member the stop will go to. Maximum length is 1.

actionRequestPolicyCode
string (optional) 

For role members determines whether all members must take action or just the first.

responsibilityId
string (optional) 

Responsibility Id.

priority
string (optional) 

Stop number that the member should receive the request.

forceAction
string (optional) 

Specifies whether requests for this member must be acted on even if they have already taken that action in the workflow.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

People Flows

Get People Flows by Key
GET/research-sys/api/v1/people-flows/(key)

Example URI

GET /research-sys/api/v1/people-flows/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "name": "(val)",
  "namespaceCode": "(val)",
  "typeId": "(val)",
  "description": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Get All People Flows
GET/research-sys/api/v1/people-flows/

Example URI

GET /research-sys/api/v1/people-flows/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "namespaceCode": "(val)",
    "typeId": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "namespaceCode": "(val)",
    "typeId": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All People Flows with Filtering
GET/research-sys/api/v1/people-flows/

Example URI

GET /research-sys/api/v1/people-flows/
URI Parameters
HideShow
id
string (optional) 

Generated ID for the people flow definition. Maximum length is 40.

name
string (optional) 

Name for the people flow definition. Maximum length is 100.

namespaceCode
string (optional) 

Code identifying the namespace. Maximum length is 20.

typeId
string (optional) 

Type name for the people flow definition. Maximum length is 40.

description
string (optional) 

Description for the people flow definition. Maximum length is 4000.

active
string (optional) 

Active. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "namespaceCode": "(val)",
    "typeId": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "namespaceCode": "(val)",
    "typeId": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for People Flows
GET/research-sys/api/v1/people-flows/

Example URI

GET /research-sys/api/v1/people-flows/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "name",
    "namespaceCode",
    "typeId",
    "description",
    "active"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for People Flows
GET/research-sys/api/v1/people-flows/

Example URI

GET /research-sys/api/v1/people-flows/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="People Flows.md"
transfer-encoding: chunked

Update People Flows
PUT/research-sys/api/v1/people-flows/(key)

Example URI

PUT /research-sys/api/v1/people-flows/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "name": "(val)",
  "namespaceCode": "(val)",
  "typeId": "(val)",
  "description": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple People Flows
PUT/research-sys/api/v1/people-flows/

Example URI

PUT /research-sys/api/v1/people-flows/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "namespaceCode": "(val)",
    "typeId": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "namespaceCode": "(val)",
    "typeId": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes People Flows
PATCH/research-sys/api/v1/people-flows/(key)

Example URI

PATCH /research-sys/api/v1/people-flows/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "name": "(val)",
  "namespaceCode": "(val)",
  "typeId": "(val)",
  "description": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "name": "(val)",
  "namespaceCode": "(val)",
  "typeId": "(val)",
  "description": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert People Flows
POST/research-sys/api/v1/people-flows/

Example URI

POST /research-sys/api/v1/people-flows/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "name": "(val)",
  "namespaceCode": "(val)",
  "typeId": "(val)",
  "description": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "name": "(val)",
  "namespaceCode": "(val)",
  "typeId": "(val)",
  "description": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple People Flows
POST/research-sys/api/v1/people-flows/

Example URI

POST /research-sys/api/v1/people-flows/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "namespaceCode": "(val)",
    "typeId": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "namespaceCode": "(val)",
    "typeId": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "namespaceCode": "(val)",
    "typeId": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "namespaceCode": "(val)",
    "typeId": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete People Flows by Key
DELETE/research-sys/api/v1/people-flows/(key)

Example URI

DELETE /research-sys/api/v1/people-flows/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All People Flows
DELETE/research-sys/api/v1/people-flows/

Example URI

DELETE /research-sys/api/v1/people-flows/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All People Flows with Matching
DELETE/research-sys/api/v1/people-flows/

Example URI

DELETE /research-sys/api/v1/people-flows/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 

Generated ID for the people flow definition. Maximum length is 40.

name
string (optional) 

Name for the people flow definition. Maximum length is 100.

namespaceCode
string (optional) 

Code identifying the namespace. Maximum length is 20.

typeId
string (optional) 

Type name for the people flow definition. Maximum length is 40.

description
string (optional) 

Description for the people flow definition. Maximum length is 4000.

active
string (optional) 

Active. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Permission Attributes

Get Permission Attributes by Key
GET/research-sys/api/v1/permission-attributes/(key)

Example URI

GET /research-sys/api/v1/permission-attributes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "assignedToId": "(val)",
  "attributeValue": "(val)",
  "kimTypeId": "(val)",
  "kimAttributeId": "(val)",
  "_primaryKey": "(val)"
}

Get All Permission Attributes
GET/research-sys/api/v1/permission-attributes/

Example URI

GET /research-sys/api/v1/permission-attributes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "assignedToId": "(val)",
    "attributeValue": "(val)",
    "kimTypeId": "(val)",
    "kimAttributeId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "assignedToId": "(val)",
    "attributeValue": "(val)",
    "kimTypeId": "(val)",
    "kimAttributeId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Permission Attributes with Filtering
GET/research-sys/api/v1/permission-attributes/

Example URI

GET /research-sys/api/v1/permission-attributes/
URI Parameters
HideShow
id
string (optional) 

Id.

assignedToId
string (optional) 

Assigned To Id.

attributeValue
string (optional) 

Attribute Value. Maximum length is 40.

kimTypeId
string (optional) 

Kim Type Id.

kimAttributeId
string (optional) 

Attribute Id. Maximum length is 40.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "assignedToId": "(val)",
    "attributeValue": "(val)",
    "kimTypeId": "(val)",
    "kimAttributeId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "assignedToId": "(val)",
    "attributeValue": "(val)",
    "kimTypeId": "(val)",
    "kimAttributeId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Permission Attributes
GET/research-sys/api/v1/permission-attributes/

Example URI

GET /research-sys/api/v1/permission-attributes/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "assignedToId",
    "attributeValue",
    "kimTypeId",
    "kimAttributeId"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Permission Attributes
GET/research-sys/api/v1/permission-attributes/

Example URI

GET /research-sys/api/v1/permission-attributes/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Permission Attributes.md"
transfer-encoding: chunked

Update Permission Attributes
PUT/research-sys/api/v1/permission-attributes/(key)

Example URI

PUT /research-sys/api/v1/permission-attributes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "assignedToId": "(val)",
  "attributeValue": "(val)",
  "kimTypeId": "(val)",
  "kimAttributeId": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Permission Attributes
PUT/research-sys/api/v1/permission-attributes/

Example URI

PUT /research-sys/api/v1/permission-attributes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "assignedToId": "(val)",
    "attributeValue": "(val)",
    "kimTypeId": "(val)",
    "kimAttributeId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "assignedToId": "(val)",
    "attributeValue": "(val)",
    "kimTypeId": "(val)",
    "kimAttributeId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Permission Attributes
PATCH/research-sys/api/v1/permission-attributes/(key)

Example URI

PATCH /research-sys/api/v1/permission-attributes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "assignedToId": "(val)",
  "attributeValue": "(val)",
  "kimTypeId": "(val)",
  "kimAttributeId": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "assignedToId": "(val)",
  "attributeValue": "(val)",
  "kimTypeId": "(val)",
  "kimAttributeId": "(val)",
  "_primaryKey": "(val)"
}

Insert Permission Attributes
POST/research-sys/api/v1/permission-attributes/

Example URI

POST /research-sys/api/v1/permission-attributes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "assignedToId": "(val)",
  "attributeValue": "(val)",
  "kimTypeId": "(val)",
  "kimAttributeId": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "assignedToId": "(val)",
  "attributeValue": "(val)",
  "kimTypeId": "(val)",
  "kimAttributeId": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Permission Attributes
POST/research-sys/api/v1/permission-attributes/

Example URI

POST /research-sys/api/v1/permission-attributes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "assignedToId": "(val)",
    "attributeValue": "(val)",
    "kimTypeId": "(val)",
    "kimAttributeId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "assignedToId": "(val)",
    "attributeValue": "(val)",
    "kimTypeId": "(val)",
    "kimAttributeId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "assignedToId": "(val)",
    "attributeValue": "(val)",
    "kimTypeId": "(val)",
    "kimAttributeId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "assignedToId": "(val)",
    "attributeValue": "(val)",
    "kimTypeId": "(val)",
    "kimAttributeId": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Permission Attributes by Key
DELETE/research-sys/api/v1/permission-attributes/(key)

Example URI

DELETE /research-sys/api/v1/permission-attributes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Permission Attributes
DELETE/research-sys/api/v1/permission-attributes/

Example URI

DELETE /research-sys/api/v1/permission-attributes/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Permission Attributes with Matching
DELETE/research-sys/api/v1/permission-attributes/

Example URI

DELETE /research-sys/api/v1/permission-attributes/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 

Id.

assignedToId
string (optional) 

Assigned To Id.

attributeValue
string (optional) 

Attribute Value. Maximum length is 40.

kimTypeId
string (optional) 

Kim Type Id.

kimAttributeId
string (optional) 

Attribute Id. Maximum length is 40.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Permission Templates

Get Permission Templates by Key
GET/research-sys/api/v1/permission-templates/(key)

Example URI

GET /research-sys/api/v1/permission-templates/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "kimTypeId": "(val)",
  "name": "(val)",
  "active": "(val)",
  "description": "(val)",
  "namespaceCode": "(val)",
  "_primaryKey": "(val)"
}

Get All Permission Templates
GET/research-sys/api/v1/permission-templates/

Example URI

GET /research-sys/api/v1/permission-templates/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "kimTypeId": "(val)",
    "name": "(val)",
    "active": "(val)",
    "description": "(val)",
    "namespaceCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "kimTypeId": "(val)",
    "name": "(val)",
    "active": "(val)",
    "description": "(val)",
    "namespaceCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Permission Templates with Filtering
GET/research-sys/api/v1/permission-templates/

Example URI

GET /research-sys/api/v1/permission-templates/
URI Parameters
HideShow
id
string (optional) 

Template Id. Maximum length is 40.

kimTypeId
string (optional) 

Kim Type Id.

name
string (optional) 

Template Name. Maximum length is 40.

active
string (optional) 

Active.

description
string (optional) 

Permission Template Description. Maximum length is 40.

namespaceCode
string (optional) 

Nmspc Cd. Maximum length is 40.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "kimTypeId": "(val)",
    "name": "(val)",
    "active": "(val)",
    "description": "(val)",
    "namespaceCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "kimTypeId": "(val)",
    "name": "(val)",
    "active": "(val)",
    "description": "(val)",
    "namespaceCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Permission Templates
GET/research-sys/api/v1/permission-templates/

Example URI

GET /research-sys/api/v1/permission-templates/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "kimTypeId",
    "name",
    "active",
    "description",
    "namespaceCode"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Permission Templates
GET/research-sys/api/v1/permission-templates/

Example URI

GET /research-sys/api/v1/permission-templates/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Permission Templates.md"
transfer-encoding: chunked

Update Permission Templates
PUT/research-sys/api/v1/permission-templates/(key)

Example URI

PUT /research-sys/api/v1/permission-templates/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "kimTypeId": "(val)",
  "name": "(val)",
  "active": "(val)",
  "description": "(val)",
  "namespaceCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Permission Templates
PUT/research-sys/api/v1/permission-templates/

Example URI

PUT /research-sys/api/v1/permission-templates/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "kimTypeId": "(val)",
    "name": "(val)",
    "active": "(val)",
    "description": "(val)",
    "namespaceCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "kimTypeId": "(val)",
    "name": "(val)",
    "active": "(val)",
    "description": "(val)",
    "namespaceCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Permission Templates
PATCH/research-sys/api/v1/permission-templates/(key)

Example URI

PATCH /research-sys/api/v1/permission-templates/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "kimTypeId": "(val)",
  "name": "(val)",
  "active": "(val)",
  "description": "(val)",
  "namespaceCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "kimTypeId": "(val)",
  "name": "(val)",
  "active": "(val)",
  "description": "(val)",
  "namespaceCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Permission Templates
POST/research-sys/api/v1/permission-templates/

Example URI

POST /research-sys/api/v1/permission-templates/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "kimTypeId": "(val)",
  "name": "(val)",
  "active": "(val)",
  "description": "(val)",
  "namespaceCode": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "kimTypeId": "(val)",
  "name": "(val)",
  "active": "(val)",
  "description": "(val)",
  "namespaceCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Permission Templates
POST/research-sys/api/v1/permission-templates/

Example URI

POST /research-sys/api/v1/permission-templates/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "kimTypeId": "(val)",
    "name": "(val)",
    "active": "(val)",
    "description": "(val)",
    "namespaceCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "kimTypeId": "(val)",
    "name": "(val)",
    "active": "(val)",
    "description": "(val)",
    "namespaceCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "kimTypeId": "(val)",
    "name": "(val)",
    "active": "(val)",
    "description": "(val)",
    "namespaceCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "kimTypeId": "(val)",
    "name": "(val)",
    "active": "(val)",
    "description": "(val)",
    "namespaceCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Permission Templates by Key
DELETE/research-sys/api/v1/permission-templates/(key)

Example URI

DELETE /research-sys/api/v1/permission-templates/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Permission Templates
DELETE/research-sys/api/v1/permission-templates/

Example URI

DELETE /research-sys/api/v1/permission-templates/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Permission Templates with Matching
DELETE/research-sys/api/v1/permission-templates/

Example URI

DELETE /research-sys/api/v1/permission-templates/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 

Template Id. Maximum length is 40.

kimTypeId
string (optional) 

Kim Type Id.

name
string (optional) 

Template Name. Maximum length is 40.

active
string (optional) 

Active.

description
string (optional) 

Permission Template Description. Maximum length is 40.

namespaceCode
string (optional) 

Nmspc Cd. Maximum length is 40.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Permissions

Get Permissions by Key
GET/research-sys/api/v1/permissions/(key)

Example URI

GET /research-sys/api/v1/permissions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "namespaceCode": "(val)",
  "name": "(val)",
  "description": "(val)",
  "templateId": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Get All Permissions
GET/research-sys/api/v1/permissions/

Example URI

GET /research-sys/api/v1/permissions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "namespaceCode": "(val)",
    "name": "(val)",
    "description": "(val)",
    "templateId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "namespaceCode": "(val)",
    "name": "(val)",
    "description": "(val)",
    "templateId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Permissions with Filtering
GET/research-sys/api/v1/permissions/

Example URI

GET /research-sys/api/v1/permissions/
URI Parameters
HideShow
id
string (optional) 

Permission Identifier. Maximum length is 40.

namespaceCode
string (optional) 

This value is used to categorize parameters by namespace. Maximum length is 20.

name
string (optional) 

Nm. Maximum length is 100.

description
string (optional) 

Permission Description. Maximum length is 400.

templateId
string (optional) 

Template Id. Maximum length is 40.

active
string (optional) 

This attribute is used to describe whether the associated object is active or inactive. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "namespaceCode": "(val)",
    "name": "(val)",
    "description": "(val)",
    "templateId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "namespaceCode": "(val)",
    "name": "(val)",
    "description": "(val)",
    "templateId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Permissions
GET/research-sys/api/v1/permissions/

Example URI

GET /research-sys/api/v1/permissions/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "namespaceCode",
    "name",
    "description",
    "templateId",
    "active"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Permissions
GET/research-sys/api/v1/permissions/

Example URI

GET /research-sys/api/v1/permissions/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Permissions.md"
transfer-encoding: chunked

Update Permissions
PUT/research-sys/api/v1/permissions/(key)

Example URI

PUT /research-sys/api/v1/permissions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "namespaceCode": "(val)",
  "name": "(val)",
  "description": "(val)",
  "templateId": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Permissions
PUT/research-sys/api/v1/permissions/

Example URI

PUT /research-sys/api/v1/permissions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "namespaceCode": "(val)",
    "name": "(val)",
    "description": "(val)",
    "templateId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "namespaceCode": "(val)",
    "name": "(val)",
    "description": "(val)",
    "templateId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Permissions
PATCH/research-sys/api/v1/permissions/(key)

Example URI

PATCH /research-sys/api/v1/permissions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "namespaceCode": "(val)",
  "name": "(val)",
  "description": "(val)",
  "templateId": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "namespaceCode": "(val)",
  "name": "(val)",
  "description": "(val)",
  "templateId": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Permissions
POST/research-sys/api/v1/permissions/

Example URI

POST /research-sys/api/v1/permissions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "namespaceCode": "(val)",
  "name": "(val)",
  "description": "(val)",
  "templateId": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "namespaceCode": "(val)",
  "name": "(val)",
  "description": "(val)",
  "templateId": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Permissions
POST/research-sys/api/v1/permissions/

Example URI

POST /research-sys/api/v1/permissions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "namespaceCode": "(val)",
    "name": "(val)",
    "description": "(val)",
    "templateId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "namespaceCode": "(val)",
    "name": "(val)",
    "description": "(val)",
    "templateId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "namespaceCode": "(val)",
    "name": "(val)",
    "description": "(val)",
    "templateId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "namespaceCode": "(val)",
    "name": "(val)",
    "description": "(val)",
    "templateId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Permissions by Key
DELETE/research-sys/api/v1/permissions/(key)

Example URI

DELETE /research-sys/api/v1/permissions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Permissions
DELETE/research-sys/api/v1/permissions/

Example URI

DELETE /research-sys/api/v1/permissions/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Permissions with Matching
DELETE/research-sys/api/v1/permissions/

Example URI

DELETE /research-sys/api/v1/permissions/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 

Permission Identifier. Maximum length is 40.

namespaceCode
string (optional) 

This value is used to categorize parameters by namespace. Maximum length is 20.

name
string (optional) 

Nm. Maximum length is 100.

description
string (optional) 

Permission Description. Maximum length is 400.

templateId
string (optional) 

Template Id. Maximum length is 40.

active
string (optional) 

This attribute is used to describe whether the associated object is active or inactive. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Person Document Addresses

Get Person Document Addresses by Key
GET/research-sys/api/v1/person-document-addresses/(key)

Example URI

GET /research-sys/api/v1/person-document-addresses/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "entityAddressId": "(val)",
  "addressTypeCode": "(val)",
  "city": "(val)",
  "stateProvinceCode": "(val)",
  "postalCode": "(val)",
  "countryCode": "(val)",
  "attentionLine": "(val)",
  "line1": "(val)",
  "line2": "(val)",
  "line3": "(val)",
  "addressFormat": "(val)",
  "modifiedDate": "(val)",
  "validatedDate": "(val)",
  "validated": "(val)",
  "noteMessage": "(val)",
  "dflt": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Get All Person Document Addresses
GET/research-sys/api/v1/person-document-addresses/

Example URI

GET /research-sys/api/v1/person-document-addresses/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "entityAddressId": "(val)",
    "addressTypeCode": "(val)",
    "city": "(val)",
    "stateProvinceCode": "(val)",
    "postalCode": "(val)",
    "countryCode": "(val)",
    "attentionLine": "(val)",
    "line1": "(val)",
    "line2": "(val)",
    "line3": "(val)",
    "addressFormat": "(val)",
    "modifiedDate": "(val)",
    "validatedDate": "(val)",
    "validated": "(val)",
    "noteMessage": "(val)",
    "dflt": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "entityAddressId": "(val)",
    "addressTypeCode": "(val)",
    "city": "(val)",
    "stateProvinceCode": "(val)",
    "postalCode": "(val)",
    "countryCode": "(val)",
    "attentionLine": "(val)",
    "line1": "(val)",
    "line2": "(val)",
    "line3": "(val)",
    "addressFormat": "(val)",
    "modifiedDate": "(val)",
    "validatedDate": "(val)",
    "validated": "(val)",
    "noteMessage": "(val)",
    "dflt": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Person Document Addresses with Filtering
GET/research-sys/api/v1/person-document-addresses/

Example URI

GET /research-sys/api/v1/person-document-addresses/
URI Parameters
HideShow
entityAddressId
string (optional) 

Entity Address Id.

addressTypeCode
string (optional) 

Address Type. Maximum length is 40.

city
string (optional) 

City. Maximum length is 30.

stateProvinceCode
string (optional) 

State/Province. Maximum length is 2.

postalCode
string (optional) 

Postal Code. Maximum length is 20.

countryCode
string (optional) 

Country. Maximum length is 2.

attentionLine
string (optional) 

Attention Line.

line1
string (optional) 

Line 1. Maximum length is 128.

line2
string (optional) 

Line 2. Maximum length is 128.

line3
string (optional) 

Line 3. Maximum length is 128.

addressFormat
string (optional) 

Address Format.

modifiedDate
string (optional) 

Modified Date.

validatedDate
string (optional) 

Validated Date.

validated
string (optional) 

Validated.

noteMessage
string (optional) 

Note Message.

dflt
string (optional) 

Default. Maximum length is 1.

edit
string (optional) 

Edit.

documentNumber
string (optional) 

Document Number.

active
string (optional) 

Active. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "entityAddressId": "(val)",
    "addressTypeCode": "(val)",
    "city": "(val)",
    "stateProvinceCode": "(val)",
    "postalCode": "(val)",
    "countryCode": "(val)",
    "attentionLine": "(val)",
    "line1": "(val)",
    "line2": "(val)",
    "line3": "(val)",
    "addressFormat": "(val)",
    "modifiedDate": "(val)",
    "validatedDate": "(val)",
    "validated": "(val)",
    "noteMessage": "(val)",
    "dflt": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "entityAddressId": "(val)",
    "addressTypeCode": "(val)",
    "city": "(val)",
    "stateProvinceCode": "(val)",
    "postalCode": "(val)",
    "countryCode": "(val)",
    "attentionLine": "(val)",
    "line1": "(val)",
    "line2": "(val)",
    "line3": "(val)",
    "addressFormat": "(val)",
    "modifiedDate": "(val)",
    "validatedDate": "(val)",
    "validated": "(val)",
    "noteMessage": "(val)",
    "dflt": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Person Document Addresses
GET/research-sys/api/v1/person-document-addresses/

Example URI

GET /research-sys/api/v1/person-document-addresses/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "entityAddressId",
    "addressTypeCode",
    "city",
    "stateProvinceCode",
    "postalCode",
    "countryCode",
    "attentionLine",
    "line1",
    "line2",
    "line3",
    "addressFormat",
    "modifiedDate",
    "validatedDate",
    "validated",
    "noteMessage",
    "dflt",
    "edit",
    "documentNumber",
    "active"
  ],
  "primaryKey": "entityAddressId"
}

Get Blueprint API specification for Person Document Addresses
GET/research-sys/api/v1/person-document-addresses/

Example URI

GET /research-sys/api/v1/person-document-addresses/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Person Document Addresses.md"
transfer-encoding: chunked

Update Person Document Addresses
PUT/research-sys/api/v1/person-document-addresses/(key)

Example URI

PUT /research-sys/api/v1/person-document-addresses/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "entityAddressId": "(val)",
  "addressTypeCode": "(val)",
  "city": "(val)",
  "stateProvinceCode": "(val)",
  "postalCode": "(val)",
  "countryCode": "(val)",
  "attentionLine": "(val)",
  "line1": "(val)",
  "line2": "(val)",
  "line3": "(val)",
  "addressFormat": "(val)",
  "modifiedDate": "(val)",
  "validatedDate": "(val)",
  "validated": "(val)",
  "noteMessage": "(val)",
  "dflt": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Person Document Addresses
PUT/research-sys/api/v1/person-document-addresses/

Example URI

PUT /research-sys/api/v1/person-document-addresses/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "entityAddressId": "(val)",
    "addressTypeCode": "(val)",
    "city": "(val)",
    "stateProvinceCode": "(val)",
    "postalCode": "(val)",
    "countryCode": "(val)",
    "attentionLine": "(val)",
    "line1": "(val)",
    "line2": "(val)",
    "line3": "(val)",
    "addressFormat": "(val)",
    "modifiedDate": "(val)",
    "validatedDate": "(val)",
    "validated": "(val)",
    "noteMessage": "(val)",
    "dflt": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "entityAddressId": "(val)",
    "addressTypeCode": "(val)",
    "city": "(val)",
    "stateProvinceCode": "(val)",
    "postalCode": "(val)",
    "countryCode": "(val)",
    "attentionLine": "(val)",
    "line1": "(val)",
    "line2": "(val)",
    "line3": "(val)",
    "addressFormat": "(val)",
    "modifiedDate": "(val)",
    "validatedDate": "(val)",
    "validated": "(val)",
    "noteMessage": "(val)",
    "dflt": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Person Document Addresses
PATCH/research-sys/api/v1/person-document-addresses/(key)

Example URI

PATCH /research-sys/api/v1/person-document-addresses/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "entityAddressId": "(val)",
  "addressTypeCode": "(val)",
  "city": "(val)",
  "stateProvinceCode": "(val)",
  "postalCode": "(val)",
  "countryCode": "(val)",
  "attentionLine": "(val)",
  "line1": "(val)",
  "line2": "(val)",
  "line3": "(val)",
  "addressFormat": "(val)",
  "modifiedDate": "(val)",
  "validatedDate": "(val)",
  "validated": "(val)",
  "noteMessage": "(val)",
  "dflt": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "entityAddressId": "(val)",
  "addressTypeCode": "(val)",
  "city": "(val)",
  "stateProvinceCode": "(val)",
  "postalCode": "(val)",
  "countryCode": "(val)",
  "attentionLine": "(val)",
  "line1": "(val)",
  "line2": "(val)",
  "line3": "(val)",
  "addressFormat": "(val)",
  "modifiedDate": "(val)",
  "validatedDate": "(val)",
  "validated": "(val)",
  "noteMessage": "(val)",
  "dflt": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Person Document Addresses
POST/research-sys/api/v1/person-document-addresses/

Example URI

POST /research-sys/api/v1/person-document-addresses/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "entityAddressId": "(val)",
  "addressTypeCode": "(val)",
  "city": "(val)",
  "stateProvinceCode": "(val)",
  "postalCode": "(val)",
  "countryCode": "(val)",
  "attentionLine": "(val)",
  "line1": "(val)",
  "line2": "(val)",
  "line3": "(val)",
  "addressFormat": "(val)",
  "modifiedDate": "(val)",
  "validatedDate": "(val)",
  "validated": "(val)",
  "noteMessage": "(val)",
  "dflt": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "entityAddressId": "(val)",
  "addressTypeCode": "(val)",
  "city": "(val)",
  "stateProvinceCode": "(val)",
  "postalCode": "(val)",
  "countryCode": "(val)",
  "attentionLine": "(val)",
  "line1": "(val)",
  "line2": "(val)",
  "line3": "(val)",
  "addressFormat": "(val)",
  "modifiedDate": "(val)",
  "validatedDate": "(val)",
  "validated": "(val)",
  "noteMessage": "(val)",
  "dflt": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Person Document Addresses
POST/research-sys/api/v1/person-document-addresses/

Example URI

POST /research-sys/api/v1/person-document-addresses/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "entityAddressId": "(val)",
    "addressTypeCode": "(val)",
    "city": "(val)",
    "stateProvinceCode": "(val)",
    "postalCode": "(val)",
    "countryCode": "(val)",
    "attentionLine": "(val)",
    "line1": "(val)",
    "line2": "(val)",
    "line3": "(val)",
    "addressFormat": "(val)",
    "modifiedDate": "(val)",
    "validatedDate": "(val)",
    "validated": "(val)",
    "noteMessage": "(val)",
    "dflt": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "entityAddressId": "(val)",
    "addressTypeCode": "(val)",
    "city": "(val)",
    "stateProvinceCode": "(val)",
    "postalCode": "(val)",
    "countryCode": "(val)",
    "attentionLine": "(val)",
    "line1": "(val)",
    "line2": "(val)",
    "line3": "(val)",
    "addressFormat": "(val)",
    "modifiedDate": "(val)",
    "validatedDate": "(val)",
    "validated": "(val)",
    "noteMessage": "(val)",
    "dflt": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "entityAddressId": "(val)",
    "addressTypeCode": "(val)",
    "city": "(val)",
    "stateProvinceCode": "(val)",
    "postalCode": "(val)",
    "countryCode": "(val)",
    "attentionLine": "(val)",
    "line1": "(val)",
    "line2": "(val)",
    "line3": "(val)",
    "addressFormat": "(val)",
    "modifiedDate": "(val)",
    "validatedDate": "(val)",
    "validated": "(val)",
    "noteMessage": "(val)",
    "dflt": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "entityAddressId": "(val)",
    "addressTypeCode": "(val)",
    "city": "(val)",
    "stateProvinceCode": "(val)",
    "postalCode": "(val)",
    "countryCode": "(val)",
    "attentionLine": "(val)",
    "line1": "(val)",
    "line2": "(val)",
    "line3": "(val)",
    "addressFormat": "(val)",
    "modifiedDate": "(val)",
    "validatedDate": "(val)",
    "validated": "(val)",
    "noteMessage": "(val)",
    "dflt": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Person Document Addresses by Key
DELETE/research-sys/api/v1/person-document-addresses/(key)

Example URI

DELETE /research-sys/api/v1/person-document-addresses/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Person Document Addresses
DELETE/research-sys/api/v1/person-document-addresses/

Example URI

DELETE /research-sys/api/v1/person-document-addresses/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Person Document Addresses with Matching
DELETE/research-sys/api/v1/person-document-addresses/

Example URI

DELETE /research-sys/api/v1/person-document-addresses/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

entityAddressId
string (optional) 

Entity Address Id.

addressTypeCode
string (optional) 

Address Type. Maximum length is 40.

city
string (optional) 

City. Maximum length is 30.

stateProvinceCode
string (optional) 

State/Province. Maximum length is 2.

postalCode
string (optional) 

Postal Code. Maximum length is 20.

countryCode
string (optional) 

Country. Maximum length is 2.

attentionLine
string (optional) 

Attention Line.

line1
string (optional) 

Line 1. Maximum length is 128.

line2
string (optional) 

Line 2. Maximum length is 128.

line3
string (optional) 

Line 3. Maximum length is 128.

addressFormat
string (optional) 

Address Format.

modifiedDate
string (optional) 

Modified Date.

validatedDate
string (optional) 

Validated Date.

validated
string (optional) 

Validated.

noteMessage
string (optional) 

Note Message.

dflt
string (optional) 

Default. Maximum length is 1.

edit
string (optional) 

Edit.

documentNumber
string (optional) 

Document Number.

active
string (optional) 

Active. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Person Document Affiliations

Get Person Document Affiliations by Key
GET/research-sys/api/v1/person-document-affiliations/(key)

Example URI

GET /research-sys/api/v1/person-document-affiliations/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "entityAffiliationId": "(val)",
  "affiliationTypeCode": "(val)",
  "campusCode": "(val)",
  "dflt": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Get All Person Document Affiliations
GET/research-sys/api/v1/person-document-affiliations/

Example URI

GET /research-sys/api/v1/person-document-affiliations/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "entityAffiliationId": "(val)",
    "affiliationTypeCode": "(val)",
    "campusCode": "(val)",
    "dflt": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "entityAffiliationId": "(val)",
    "affiliationTypeCode": "(val)",
    "campusCode": "(val)",
    "dflt": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Person Document Affiliations with Filtering
GET/research-sys/api/v1/person-document-affiliations/

Example URI

GET /research-sys/api/v1/person-document-affiliations/
URI Parameters
HideShow
entityAffiliationId
string (optional) 

Affiliation Entity Id. Maximum length is 40.

affiliationTypeCode
string (optional) 

Affiliation Type. Maximum length is 40.

campusCode
string (optional) 

Campus Code. Maximum length is 2.

dflt
string (optional) 

Default. Maximum length is 1.

edit
string (optional) 

Edit.

documentNumber
string (optional) 

Document Number.

active
string (optional) 

Active. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "entityAffiliationId": "(val)",
    "affiliationTypeCode": "(val)",
    "campusCode": "(val)",
    "dflt": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "entityAffiliationId": "(val)",
    "affiliationTypeCode": "(val)",
    "campusCode": "(val)",
    "dflt": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Person Document Affiliations
GET/research-sys/api/v1/person-document-affiliations/

Example URI

GET /research-sys/api/v1/person-document-affiliations/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "entityAffiliationId",
    "affiliationTypeCode",
    "campusCode",
    "dflt",
    "edit",
    "documentNumber",
    "active"
  ],
  "primaryKey": "entityAffiliationId"
}

Get Blueprint API specification for Person Document Affiliations
GET/research-sys/api/v1/person-document-affiliations/

Example URI

GET /research-sys/api/v1/person-document-affiliations/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Person Document Affiliations.md"
transfer-encoding: chunked

Update Person Document Affiliations
PUT/research-sys/api/v1/person-document-affiliations/(key)

Example URI

PUT /research-sys/api/v1/person-document-affiliations/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "entityAffiliationId": "(val)",
  "affiliationTypeCode": "(val)",
  "campusCode": "(val)",
  "dflt": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Person Document Affiliations
PUT/research-sys/api/v1/person-document-affiliations/

Example URI

PUT /research-sys/api/v1/person-document-affiliations/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "entityAffiliationId": "(val)",
    "affiliationTypeCode": "(val)",
    "campusCode": "(val)",
    "dflt": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "entityAffiliationId": "(val)",
    "affiliationTypeCode": "(val)",
    "campusCode": "(val)",
    "dflt": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Person Document Affiliations
PATCH/research-sys/api/v1/person-document-affiliations/(key)

Example URI

PATCH /research-sys/api/v1/person-document-affiliations/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "entityAffiliationId": "(val)",
  "affiliationTypeCode": "(val)",
  "campusCode": "(val)",
  "dflt": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "entityAffiliationId": "(val)",
  "affiliationTypeCode": "(val)",
  "campusCode": "(val)",
  "dflt": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Person Document Affiliations
POST/research-sys/api/v1/person-document-affiliations/

Example URI

POST /research-sys/api/v1/person-document-affiliations/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "entityAffiliationId": "(val)",
  "affiliationTypeCode": "(val)",
  "campusCode": "(val)",
  "dflt": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "entityAffiliationId": "(val)",
  "affiliationTypeCode": "(val)",
  "campusCode": "(val)",
  "dflt": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Person Document Affiliations
POST/research-sys/api/v1/person-document-affiliations/

Example URI

POST /research-sys/api/v1/person-document-affiliations/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "entityAffiliationId": "(val)",
    "affiliationTypeCode": "(val)",
    "campusCode": "(val)",
    "dflt": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "entityAffiliationId": "(val)",
    "affiliationTypeCode": "(val)",
    "campusCode": "(val)",
    "dflt": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "entityAffiliationId": "(val)",
    "affiliationTypeCode": "(val)",
    "campusCode": "(val)",
    "dflt": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "entityAffiliationId": "(val)",
    "affiliationTypeCode": "(val)",
    "campusCode": "(val)",
    "dflt": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Person Document Affiliations by Key
DELETE/research-sys/api/v1/person-document-affiliations/(key)

Example URI

DELETE /research-sys/api/v1/person-document-affiliations/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Person Document Affiliations
DELETE/research-sys/api/v1/person-document-affiliations/

Example URI

DELETE /research-sys/api/v1/person-document-affiliations/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Person Document Affiliations with Matching
DELETE/research-sys/api/v1/person-document-affiliations/

Example URI

DELETE /research-sys/api/v1/person-document-affiliations/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

entityAffiliationId
string (optional) 

Affiliation Entity Id. Maximum length is 40.

affiliationTypeCode
string (optional) 

Affiliation Type. Maximum length is 40.

campusCode
string (optional) 

Campus Code. Maximum length is 2.

dflt
string (optional) 

Default. Maximum length is 1.

edit
string (optional) 

Edit.

documentNumber
string (optional) 

Document Number.

active
string (optional) 

Active. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Person Document Citizenships

Get Person Document Citizenships by Key
GET/research-sys/api/v1/person-document-citizenships/(key)

Example URI

GET /research-sys/api/v1/person-document-citizenships/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "entityCitizenshipId": "(val)",
  "entityId": "(val)",
  "countryCode": "(val)",
  "citizenshipStatusCode": "(val)",
  "startDate": "(val)",
  "endDate": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Get All Person Document Citizenships
GET/research-sys/api/v1/person-document-citizenships/

Example URI

GET /research-sys/api/v1/person-document-citizenships/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "entityCitizenshipId": "(val)",
    "entityId": "(val)",
    "countryCode": "(val)",
    "citizenshipStatusCode": "(val)",
    "startDate": "(val)",
    "endDate": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "entityCitizenshipId": "(val)",
    "entityId": "(val)",
    "countryCode": "(val)",
    "citizenshipStatusCode": "(val)",
    "startDate": "(val)",
    "endDate": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Person Document Citizenships with Filtering
GET/research-sys/api/v1/person-document-citizenships/

Example URI

GET /research-sys/api/v1/person-document-citizenships/
URI Parameters
HideShow
entityCitizenshipId
string (optional) 

Citizenship Entity Id. Maximum length is 40.

entityId
string (optional) 

Entity ID. Maximum length is 40.

countryCode
string (optional) 

Country Code. Maximum length is 2.

citizenshipStatusCode
string (optional) 

Citizenship Status Code.

startDate
string (optional) 

Start Date. Maximum length is 21.

endDate
string (optional) 

End Date. Maximum length is 21.

edit
string (optional) 

Edit.

documentNumber
string (optional) 

Document Number.

active
string (optional) 

Active.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "entityCitizenshipId": "(val)",
    "entityId": "(val)",
    "countryCode": "(val)",
    "citizenshipStatusCode": "(val)",
    "startDate": "(val)",
    "endDate": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "entityCitizenshipId": "(val)",
    "entityId": "(val)",
    "countryCode": "(val)",
    "citizenshipStatusCode": "(val)",
    "startDate": "(val)",
    "endDate": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Person Document Citizenships
GET/research-sys/api/v1/person-document-citizenships/

Example URI

GET /research-sys/api/v1/person-document-citizenships/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "entityCitizenshipId",
    "entityId",
    "countryCode",
    "citizenshipStatusCode",
    "startDate",
    "endDate",
    "edit",
    "documentNumber",
    "active"
  ],
  "primaryKey": "entityCitizenshipId"
}

Get Blueprint API specification for Person Document Citizenships
GET/research-sys/api/v1/person-document-citizenships/

Example URI

GET /research-sys/api/v1/person-document-citizenships/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Person Document Citizenships.md"
transfer-encoding: chunked

Update Person Document Citizenships
PUT/research-sys/api/v1/person-document-citizenships/(key)

Example URI

PUT /research-sys/api/v1/person-document-citizenships/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "entityCitizenshipId": "(val)",
  "entityId": "(val)",
  "countryCode": "(val)",
  "citizenshipStatusCode": "(val)",
  "startDate": "(val)",
  "endDate": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Person Document Citizenships
PUT/research-sys/api/v1/person-document-citizenships/

Example URI

PUT /research-sys/api/v1/person-document-citizenships/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "entityCitizenshipId": "(val)",
    "entityId": "(val)",
    "countryCode": "(val)",
    "citizenshipStatusCode": "(val)",
    "startDate": "(val)",
    "endDate": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "entityCitizenshipId": "(val)",
    "entityId": "(val)",
    "countryCode": "(val)",
    "citizenshipStatusCode": "(val)",
    "startDate": "(val)",
    "endDate": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Person Document Citizenships
PATCH/research-sys/api/v1/person-document-citizenships/(key)

Example URI

PATCH /research-sys/api/v1/person-document-citizenships/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "entityCitizenshipId": "(val)",
  "entityId": "(val)",
  "countryCode": "(val)",
  "citizenshipStatusCode": "(val)",
  "startDate": "(val)",
  "endDate": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "entityCitizenshipId": "(val)",
  "entityId": "(val)",
  "countryCode": "(val)",
  "citizenshipStatusCode": "(val)",
  "startDate": "(val)",
  "endDate": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Person Document Citizenships
POST/research-sys/api/v1/person-document-citizenships/

Example URI

POST /research-sys/api/v1/person-document-citizenships/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "entityCitizenshipId": "(val)",
  "entityId": "(val)",
  "countryCode": "(val)",
  "citizenshipStatusCode": "(val)",
  "startDate": "(val)",
  "endDate": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "entityCitizenshipId": "(val)",
  "entityId": "(val)",
  "countryCode": "(val)",
  "citizenshipStatusCode": "(val)",
  "startDate": "(val)",
  "endDate": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Person Document Citizenships
POST/research-sys/api/v1/person-document-citizenships/

Example URI

POST /research-sys/api/v1/person-document-citizenships/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "entityCitizenshipId": "(val)",
    "entityId": "(val)",
    "countryCode": "(val)",
    "citizenshipStatusCode": "(val)",
    "startDate": "(val)",
    "endDate": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "entityCitizenshipId": "(val)",
    "entityId": "(val)",
    "countryCode": "(val)",
    "citizenshipStatusCode": "(val)",
    "startDate": "(val)",
    "endDate": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "entityCitizenshipId": "(val)",
    "entityId": "(val)",
    "countryCode": "(val)",
    "citizenshipStatusCode": "(val)",
    "startDate": "(val)",
    "endDate": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "entityCitizenshipId": "(val)",
    "entityId": "(val)",
    "countryCode": "(val)",
    "citizenshipStatusCode": "(val)",
    "startDate": "(val)",
    "endDate": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Person Document Citizenships by Key
DELETE/research-sys/api/v1/person-document-citizenships/(key)

Example URI

DELETE /research-sys/api/v1/person-document-citizenships/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Person Document Citizenships
DELETE/research-sys/api/v1/person-document-citizenships/

Example URI

DELETE /research-sys/api/v1/person-document-citizenships/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Person Document Citizenships with Matching
DELETE/research-sys/api/v1/person-document-citizenships/

Example URI

DELETE /research-sys/api/v1/person-document-citizenships/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

entityCitizenshipId
string (optional) 

Citizenship Entity Id. Maximum length is 40.

entityId
string (optional) 

Entity ID. Maximum length is 40.

countryCode
string (optional) 

Country Code. Maximum length is 2.

citizenshipStatusCode
string (optional) 

Citizenship Status Code.

startDate
string (optional) 

Start Date. Maximum length is 21.

endDate
string (optional) 

End Date. Maximum length is 21.

edit
string (optional) 

Edit.

documentNumber
string (optional) 

Document Number.

active
string (optional) 

Active.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Person Document Emails

Get Person Document Emails by Key
GET/research-sys/api/v1/person-document-emails/(key)

Example URI

GET /research-sys/api/v1/person-document-emails/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "entityEmailId": "(val)",
  "entityTypeCode": "(val)",
  "emailTypeCode": "(val)",
  "emailAddress": "(val)",
  "dflt": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Get All Person Document Emails
GET/research-sys/api/v1/person-document-emails/

Example URI

GET /research-sys/api/v1/person-document-emails/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "entityEmailId": "(val)",
    "entityTypeCode": "(val)",
    "emailTypeCode": "(val)",
    "emailAddress": "(val)",
    "dflt": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "entityEmailId": "(val)",
    "entityTypeCode": "(val)",
    "emailTypeCode": "(val)",
    "emailAddress": "(val)",
    "dflt": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Person Document Emails with Filtering
GET/research-sys/api/v1/person-document-emails/

Example URI

GET /research-sys/api/v1/person-document-emails/
URI Parameters
HideShow
entityEmailId
string (optional) 

Entity Email Id.

entityTypeCode
string (optional) 

Entity Type Code.

emailTypeCode
string (optional) 

Type. Maximum length is 10.

emailAddress
string (optional) 

The email address of the university user. Maximum length is 200.

dflt
string (optional) 

Default. Maximum length is 1.

edit
string (optional) 

Edit.

documentNumber
string (optional) 

Document Number.

active
string (optional) 

Active. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "entityEmailId": "(val)",
    "entityTypeCode": "(val)",
    "emailTypeCode": "(val)",
    "emailAddress": "(val)",
    "dflt": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "entityEmailId": "(val)",
    "entityTypeCode": "(val)",
    "emailTypeCode": "(val)",
    "emailAddress": "(val)",
    "dflt": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Person Document Emails
GET/research-sys/api/v1/person-document-emails/

Example URI

GET /research-sys/api/v1/person-document-emails/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "entityEmailId",
    "entityTypeCode",
    "emailTypeCode",
    "emailAddress",
    "dflt",
    "edit",
    "documentNumber",
    "active"
  ],
  "primaryKey": "entityEmailId"
}

Get Blueprint API specification for Person Document Emails
GET/research-sys/api/v1/person-document-emails/

Example URI

GET /research-sys/api/v1/person-document-emails/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Person Document Emails.md"
transfer-encoding: chunked

Update Person Document Emails
PUT/research-sys/api/v1/person-document-emails/(key)

Example URI

PUT /research-sys/api/v1/person-document-emails/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "entityEmailId": "(val)",
  "entityTypeCode": "(val)",
  "emailTypeCode": "(val)",
  "emailAddress": "(val)",
  "dflt": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Person Document Emails
PUT/research-sys/api/v1/person-document-emails/

Example URI

PUT /research-sys/api/v1/person-document-emails/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "entityEmailId": "(val)",
    "entityTypeCode": "(val)",
    "emailTypeCode": "(val)",
    "emailAddress": "(val)",
    "dflt": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "entityEmailId": "(val)",
    "entityTypeCode": "(val)",
    "emailTypeCode": "(val)",
    "emailAddress": "(val)",
    "dflt": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Person Document Emails
PATCH/research-sys/api/v1/person-document-emails/(key)

Example URI

PATCH /research-sys/api/v1/person-document-emails/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "entityEmailId": "(val)",
  "entityTypeCode": "(val)",
  "emailTypeCode": "(val)",
  "emailAddress": "(val)",
  "dflt": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "entityEmailId": "(val)",
  "entityTypeCode": "(val)",
  "emailTypeCode": "(val)",
  "emailAddress": "(val)",
  "dflt": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Person Document Emails
POST/research-sys/api/v1/person-document-emails/

Example URI

POST /research-sys/api/v1/person-document-emails/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "entityEmailId": "(val)",
  "entityTypeCode": "(val)",
  "emailTypeCode": "(val)",
  "emailAddress": "(val)",
  "dflt": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "entityEmailId": "(val)",
  "entityTypeCode": "(val)",
  "emailTypeCode": "(val)",
  "emailAddress": "(val)",
  "dflt": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Person Document Emails
POST/research-sys/api/v1/person-document-emails/

Example URI

POST /research-sys/api/v1/person-document-emails/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "entityEmailId": "(val)",
    "entityTypeCode": "(val)",
    "emailTypeCode": "(val)",
    "emailAddress": "(val)",
    "dflt": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "entityEmailId": "(val)",
    "entityTypeCode": "(val)",
    "emailTypeCode": "(val)",
    "emailAddress": "(val)",
    "dflt": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "entityEmailId": "(val)",
    "entityTypeCode": "(val)",
    "emailTypeCode": "(val)",
    "emailAddress": "(val)",
    "dflt": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "entityEmailId": "(val)",
    "entityTypeCode": "(val)",
    "emailTypeCode": "(val)",
    "emailAddress": "(val)",
    "dflt": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Person Document Emails by Key
DELETE/research-sys/api/v1/person-document-emails/(key)

Example URI

DELETE /research-sys/api/v1/person-document-emails/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Person Document Emails
DELETE/research-sys/api/v1/person-document-emails/

Example URI

DELETE /research-sys/api/v1/person-document-emails/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Person Document Emails with Matching
DELETE/research-sys/api/v1/person-document-emails/

Example URI

DELETE /research-sys/api/v1/person-document-emails/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

entityEmailId
string (optional) 

Entity Email Id.

entityTypeCode
string (optional) 

Entity Type Code.

emailTypeCode
string (optional) 

Type. Maximum length is 10.

emailAddress
string (optional) 

The email address of the university user. Maximum length is 200.

dflt
string (optional) 

Default. Maximum length is 1.

edit
string (optional) 

Edit.

documentNumber
string (optional) 

Document Number.

active
string (optional) 

Active. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Person Document Employment Infos

Get Person Document Employment Infos by Key
GET/research-sys/api/v1/person-document-employment-infos/(key)

Example URI

GET /research-sys/api/v1/person-document-employment-infos/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "entityEmploymentId": "(val)",
  "entityAffiliationId": "(val)",
  "employmentStatusCode": "(val)",
  "employmentTypeCode": "(val)",
  "primaryDepartmentCode": "(val)",
  "baseSalaryAmount": "(val)",
  "employeeId": "(val)",
  "employmentRecordId": "(val)",
  "primary": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Get All Person Document Employment Infos
GET/research-sys/api/v1/person-document-employment-infos/

Example URI

GET /research-sys/api/v1/person-document-employment-infos/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "entityEmploymentId": "(val)",
    "entityAffiliationId": "(val)",
    "employmentStatusCode": "(val)",
    "employmentTypeCode": "(val)",
    "primaryDepartmentCode": "(val)",
    "baseSalaryAmount": "(val)",
    "employeeId": "(val)",
    "employmentRecordId": "(val)",
    "primary": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "entityEmploymentId": "(val)",
    "entityAffiliationId": "(val)",
    "employmentStatusCode": "(val)",
    "employmentTypeCode": "(val)",
    "primaryDepartmentCode": "(val)",
    "baseSalaryAmount": "(val)",
    "employeeId": "(val)",
    "employmentRecordId": "(val)",
    "primary": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Person Document Employment Infos with Filtering
GET/research-sys/api/v1/person-document-employment-infos/

Example URI

GET /research-sys/api/v1/person-document-employment-infos/
URI Parameters
HideShow
entityEmploymentId
string (optional) 

Employment Id. Maximum length is 40.

entityAffiliationId
string (optional) 

Affiliation Entity Id. Maximum length is 40.

employmentStatusCode
string (optional) 

Employee Status. Maximum length is 40.

employmentTypeCode
string (optional) 

Employee Type. Maximum length is 40.

primaryDepartmentCode
string (optional) 

Primary Department Code. Maximum length is 40.

baseSalaryAmount
string (optional) 

Base Salary. Maximum length is 19.

employeeId
string (optional) 

Employee Id. Maximum length is 40.

employmentRecordId
string (optional) 

Employment Record Id. Maximum length is 40.

primary
string (optional) 

Primary. Maximum length is 1.

edit
string (optional) 

Edit.

documentNumber
string (optional) 

Document Number.

active
string (optional) 

Active. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "entityEmploymentId": "(val)",
    "entityAffiliationId": "(val)",
    "employmentStatusCode": "(val)",
    "employmentTypeCode": "(val)",
    "primaryDepartmentCode": "(val)",
    "baseSalaryAmount": "(val)",
    "employeeId": "(val)",
    "employmentRecordId": "(val)",
    "primary": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "entityEmploymentId": "(val)",
    "entityAffiliationId": "(val)",
    "employmentStatusCode": "(val)",
    "employmentTypeCode": "(val)",
    "primaryDepartmentCode": "(val)",
    "baseSalaryAmount": "(val)",
    "employeeId": "(val)",
    "employmentRecordId": "(val)",
    "primary": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Person Document Employment Infos
GET/research-sys/api/v1/person-document-employment-infos/

Example URI

GET /research-sys/api/v1/person-document-employment-infos/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "entityEmploymentId",
    "entityAffiliationId",
    "employmentStatusCode",
    "employmentTypeCode",
    "primaryDepartmentCode",
    "baseSalaryAmount",
    "employeeId",
    "employmentRecordId",
    "primary",
    "edit",
    "documentNumber",
    "active"
  ],
  "primaryKey": "entityEmploymentId"
}

Get Blueprint API specification for Person Document Employment Infos
GET/research-sys/api/v1/person-document-employment-infos/

Example URI

GET /research-sys/api/v1/person-document-employment-infos/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Person Document Employment Infos.md"
transfer-encoding: chunked

Update Person Document Employment Infos
PUT/research-sys/api/v1/person-document-employment-infos/(key)

Example URI

PUT /research-sys/api/v1/person-document-employment-infos/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "entityEmploymentId": "(val)",
  "entityAffiliationId": "(val)",
  "employmentStatusCode": "(val)",
  "employmentTypeCode": "(val)",
  "primaryDepartmentCode": "(val)",
  "baseSalaryAmount": "(val)",
  "employeeId": "(val)",
  "employmentRecordId": "(val)",
  "primary": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Person Document Employment Infos
PUT/research-sys/api/v1/person-document-employment-infos/

Example URI

PUT /research-sys/api/v1/person-document-employment-infos/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "entityEmploymentId": "(val)",
    "entityAffiliationId": "(val)",
    "employmentStatusCode": "(val)",
    "employmentTypeCode": "(val)",
    "primaryDepartmentCode": "(val)",
    "baseSalaryAmount": "(val)",
    "employeeId": "(val)",
    "employmentRecordId": "(val)",
    "primary": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "entityEmploymentId": "(val)",
    "entityAffiliationId": "(val)",
    "employmentStatusCode": "(val)",
    "employmentTypeCode": "(val)",
    "primaryDepartmentCode": "(val)",
    "baseSalaryAmount": "(val)",
    "employeeId": "(val)",
    "employmentRecordId": "(val)",
    "primary": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Person Document Employment Infos
PATCH/research-sys/api/v1/person-document-employment-infos/(key)

Example URI

PATCH /research-sys/api/v1/person-document-employment-infos/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "entityEmploymentId": "(val)",
  "entityAffiliationId": "(val)",
  "employmentStatusCode": "(val)",
  "employmentTypeCode": "(val)",
  "primaryDepartmentCode": "(val)",
  "baseSalaryAmount": "(val)",
  "employeeId": "(val)",
  "employmentRecordId": "(val)",
  "primary": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "entityEmploymentId": "(val)",
  "entityAffiliationId": "(val)",
  "employmentStatusCode": "(val)",
  "employmentTypeCode": "(val)",
  "primaryDepartmentCode": "(val)",
  "baseSalaryAmount": "(val)",
  "employeeId": "(val)",
  "employmentRecordId": "(val)",
  "primary": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Person Document Employment Infos
POST/research-sys/api/v1/person-document-employment-infos/

Example URI

POST /research-sys/api/v1/person-document-employment-infos/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "entityEmploymentId": "(val)",
  "entityAffiliationId": "(val)",
  "employmentStatusCode": "(val)",
  "employmentTypeCode": "(val)",
  "primaryDepartmentCode": "(val)",
  "baseSalaryAmount": "(val)",
  "employeeId": "(val)",
  "employmentRecordId": "(val)",
  "primary": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "entityEmploymentId": "(val)",
  "entityAffiliationId": "(val)",
  "employmentStatusCode": "(val)",
  "employmentTypeCode": "(val)",
  "primaryDepartmentCode": "(val)",
  "baseSalaryAmount": "(val)",
  "employeeId": "(val)",
  "employmentRecordId": "(val)",
  "primary": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Person Document Employment Infos
POST/research-sys/api/v1/person-document-employment-infos/

Example URI

POST /research-sys/api/v1/person-document-employment-infos/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "entityEmploymentId": "(val)",
    "entityAffiliationId": "(val)",
    "employmentStatusCode": "(val)",
    "employmentTypeCode": "(val)",
    "primaryDepartmentCode": "(val)",
    "baseSalaryAmount": "(val)",
    "employeeId": "(val)",
    "employmentRecordId": "(val)",
    "primary": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "entityEmploymentId": "(val)",
    "entityAffiliationId": "(val)",
    "employmentStatusCode": "(val)",
    "employmentTypeCode": "(val)",
    "primaryDepartmentCode": "(val)",
    "baseSalaryAmount": "(val)",
    "employeeId": "(val)",
    "employmentRecordId": "(val)",
    "primary": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "entityEmploymentId": "(val)",
    "entityAffiliationId": "(val)",
    "employmentStatusCode": "(val)",
    "employmentTypeCode": "(val)",
    "primaryDepartmentCode": "(val)",
    "baseSalaryAmount": "(val)",
    "employeeId": "(val)",
    "employmentRecordId": "(val)",
    "primary": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "entityEmploymentId": "(val)",
    "entityAffiliationId": "(val)",
    "employmentStatusCode": "(val)",
    "employmentTypeCode": "(val)",
    "primaryDepartmentCode": "(val)",
    "baseSalaryAmount": "(val)",
    "employeeId": "(val)",
    "employmentRecordId": "(val)",
    "primary": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Person Document Employment Infos by Key
DELETE/research-sys/api/v1/person-document-employment-infos/(key)

Example URI

DELETE /research-sys/api/v1/person-document-employment-infos/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Person Document Employment Infos
DELETE/research-sys/api/v1/person-document-employment-infos/

Example URI

DELETE /research-sys/api/v1/person-document-employment-infos/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Person Document Employment Infos with Matching
DELETE/research-sys/api/v1/person-document-employment-infos/

Example URI

DELETE /research-sys/api/v1/person-document-employment-infos/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

entityEmploymentId
string (optional) 

Employment Id. Maximum length is 40.

entityAffiliationId
string (optional) 

Affiliation Entity Id. Maximum length is 40.

employmentStatusCode
string (optional) 

Employee Status. Maximum length is 40.

employmentTypeCode
string (optional) 

Employee Type. Maximum length is 40.

primaryDepartmentCode
string (optional) 

Primary Department Code. Maximum length is 40.

baseSalaryAmount
string (optional) 

Base Salary. Maximum length is 19.

employeeId
string (optional) 

Employee Id. Maximum length is 40.

employmentRecordId
string (optional) 

Employment Record Id. Maximum length is 40.

primary
string (optional) 

Primary. Maximum length is 1.

edit
string (optional) 

Edit.

documentNumber
string (optional) 

Document Number.

active
string (optional) 

Active. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Person Document Groups

Get Person Document Groups by Key
GET/research-sys/api/v1/person-document-groups/(key)

Example URI

GET /research-sys/api/v1/person-document-groups/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "groupMemberId": "(val)",
  "groupType": "(val)",
  "groupId": "(val)",
  "groupName": "(val)",
  "namespaceCode": "(val)",
  "principalId": "(val)",
  "activeFromDate": "(val)",
  "activeToDate": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Get All Person Document Groups
GET/research-sys/api/v1/person-document-groups/

Example URI

GET /research-sys/api/v1/person-document-groups/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "groupMemberId": "(val)",
    "groupType": "(val)",
    "groupId": "(val)",
    "groupName": "(val)",
    "namespaceCode": "(val)",
    "principalId": "(val)",
    "activeFromDate": "(val)",
    "activeToDate": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "groupMemberId": "(val)",
    "groupType": "(val)",
    "groupId": "(val)",
    "groupName": "(val)",
    "namespaceCode": "(val)",
    "principalId": "(val)",
    "activeFromDate": "(val)",
    "activeToDate": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Person Document Groups with Filtering
GET/research-sys/api/v1/person-document-groups/

Example URI

GET /research-sys/api/v1/person-document-groups/
URI Parameters
HideShow
groupMemberId
string (optional) 

Group Member Id.

groupType
string (optional) 

Group Type.

groupId
string (optional) 

Group. Maximum length is 40.

groupName
string (optional) 

Name. Maximum length is 80.

namespaceCode
string (optional) 

Namespace Code. Maximum length is 40.

principalId
string (optional) 

Principal Id.

activeFromDate
string (optional) 

Start Date. Maximum length is 21.

activeToDate
string (optional) 

End Date. Maximum length is 21.

edit
string (optional) 

Edit.

documentNumber
string (optional) 

Document Number.

active
string (optional) 

Active. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "groupMemberId": "(val)",
    "groupType": "(val)",
    "groupId": "(val)",
    "groupName": "(val)",
    "namespaceCode": "(val)",
    "principalId": "(val)",
    "activeFromDate": "(val)",
    "activeToDate": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "groupMemberId": "(val)",
    "groupType": "(val)",
    "groupId": "(val)",
    "groupName": "(val)",
    "namespaceCode": "(val)",
    "principalId": "(val)",
    "activeFromDate": "(val)",
    "activeToDate": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Person Document Groups
GET/research-sys/api/v1/person-document-groups/

Example URI

GET /research-sys/api/v1/person-document-groups/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "groupMemberId",
    "groupType",
    "groupId",
    "groupName",
    "namespaceCode",
    "principalId",
    "activeFromDate",
    "activeToDate",
    "edit",
    "documentNumber",
    "active"
  ],
  "primaryKey": "groupMemberId"
}

Get Blueprint API specification for Person Document Groups
GET/research-sys/api/v1/person-document-groups/

Example URI

GET /research-sys/api/v1/person-document-groups/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Person Document Groups.md"
transfer-encoding: chunked

Update Person Document Groups
PUT/research-sys/api/v1/person-document-groups/(key)

Example URI

PUT /research-sys/api/v1/person-document-groups/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "groupMemberId": "(val)",
  "groupType": "(val)",
  "groupId": "(val)",
  "groupName": "(val)",
  "namespaceCode": "(val)",
  "principalId": "(val)",
  "activeFromDate": "(val)",
  "activeToDate": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Person Document Groups
PUT/research-sys/api/v1/person-document-groups/

Example URI

PUT /research-sys/api/v1/person-document-groups/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "groupMemberId": "(val)",
    "groupType": "(val)",
    "groupId": "(val)",
    "groupName": "(val)",
    "namespaceCode": "(val)",
    "principalId": "(val)",
    "activeFromDate": "(val)",
    "activeToDate": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "groupMemberId": "(val)",
    "groupType": "(val)",
    "groupId": "(val)",
    "groupName": "(val)",
    "namespaceCode": "(val)",
    "principalId": "(val)",
    "activeFromDate": "(val)",
    "activeToDate": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Person Document Groups
PATCH/research-sys/api/v1/person-document-groups/(key)

Example URI

PATCH /research-sys/api/v1/person-document-groups/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "groupMemberId": "(val)",
  "groupType": "(val)",
  "groupId": "(val)",
  "groupName": "(val)",
  "namespaceCode": "(val)",
  "principalId": "(val)",
  "activeFromDate": "(val)",
  "activeToDate": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "groupMemberId": "(val)",
  "groupType": "(val)",
  "groupId": "(val)",
  "groupName": "(val)",
  "namespaceCode": "(val)",
  "principalId": "(val)",
  "activeFromDate": "(val)",
  "activeToDate": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Person Document Groups
POST/research-sys/api/v1/person-document-groups/

Example URI

POST /research-sys/api/v1/person-document-groups/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "groupMemberId": "(val)",
  "groupType": "(val)",
  "groupId": "(val)",
  "groupName": "(val)",
  "namespaceCode": "(val)",
  "principalId": "(val)",
  "activeFromDate": "(val)",
  "activeToDate": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "groupMemberId": "(val)",
  "groupType": "(val)",
  "groupId": "(val)",
  "groupName": "(val)",
  "namespaceCode": "(val)",
  "principalId": "(val)",
  "activeFromDate": "(val)",
  "activeToDate": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Person Document Groups
POST/research-sys/api/v1/person-document-groups/

Example URI

POST /research-sys/api/v1/person-document-groups/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "groupMemberId": "(val)",
    "groupType": "(val)",
    "groupId": "(val)",
    "groupName": "(val)",
    "namespaceCode": "(val)",
    "principalId": "(val)",
    "activeFromDate": "(val)",
    "activeToDate": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "groupMemberId": "(val)",
    "groupType": "(val)",
    "groupId": "(val)",
    "groupName": "(val)",
    "namespaceCode": "(val)",
    "principalId": "(val)",
    "activeFromDate": "(val)",
    "activeToDate": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "groupMemberId": "(val)",
    "groupType": "(val)",
    "groupId": "(val)",
    "groupName": "(val)",
    "namespaceCode": "(val)",
    "principalId": "(val)",
    "activeFromDate": "(val)",
    "activeToDate": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "groupMemberId": "(val)",
    "groupType": "(val)",
    "groupId": "(val)",
    "groupName": "(val)",
    "namespaceCode": "(val)",
    "principalId": "(val)",
    "activeFromDate": "(val)",
    "activeToDate": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Person Document Groups by Key
DELETE/research-sys/api/v1/person-document-groups/(key)

Example URI

DELETE /research-sys/api/v1/person-document-groups/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Person Document Groups
DELETE/research-sys/api/v1/person-document-groups/

Example URI

DELETE /research-sys/api/v1/person-document-groups/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Person Document Groups with Matching
DELETE/research-sys/api/v1/person-document-groups/

Example URI

DELETE /research-sys/api/v1/person-document-groups/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

groupMemberId
string (optional) 

Group Member Id.

groupType
string (optional) 

Group Type.

groupId
string (optional) 

Group. Maximum length is 40.

groupName
string (optional) 

Name. Maximum length is 80.

namespaceCode
string (optional) 

Namespace Code. Maximum length is 40.

principalId
string (optional) 

Principal Id.

activeFromDate
string (optional) 

Start Date. Maximum length is 21.

activeToDate
string (optional) 

End Date. Maximum length is 21.

edit
string (optional) 

Edit.

documentNumber
string (optional) 

Document Number.

active
string (optional) 

Active. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Person Document Names

Get Person Document Names by Key
GET/research-sys/api/v1/person-document-names/(key)

Example URI

GET /research-sys/api/v1/person-document-names/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "entityNameId": "(val)",
  "nameCode": "(val)",
  "firstName": "(val)",
  "middleName": "(val)",
  "lastName": "(val)",
  "namePrefix": "(val)",
  "nameTitle": "(val)",
  "nameSuffix": "(val)",
  "noteMessage": "(val)",
  "nameChangedDate": "(val)",
  "dflt": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Get All Person Document Names
GET/research-sys/api/v1/person-document-names/

Example URI

GET /research-sys/api/v1/person-document-names/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "entityNameId": "(val)",
    "nameCode": "(val)",
    "firstName": "(val)",
    "middleName": "(val)",
    "lastName": "(val)",
    "namePrefix": "(val)",
    "nameTitle": "(val)",
    "nameSuffix": "(val)",
    "noteMessage": "(val)",
    "nameChangedDate": "(val)",
    "dflt": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "entityNameId": "(val)",
    "nameCode": "(val)",
    "firstName": "(val)",
    "middleName": "(val)",
    "lastName": "(val)",
    "namePrefix": "(val)",
    "nameTitle": "(val)",
    "nameSuffix": "(val)",
    "noteMessage": "(val)",
    "nameChangedDate": "(val)",
    "dflt": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Person Document Names with Filtering
GET/research-sys/api/v1/person-document-names/

Example URI

GET /research-sys/api/v1/person-document-names/
URI Parameters
HideShow
entityNameId
string (optional) 

Entity Name Id.

nameCode
string (optional) 

Name Code. Maximum length is 40.

firstName
string (optional) 

First Name. Maximum length is 40.

middleName
string (optional) 

Middle Name. Maximum length is 40.

lastName
string (optional) 

Last Name. Maximum length is 80.

namePrefix
string (optional) 

Name Prefix. Maximum length is 20.

nameTitle
string (optional) 

Name Title.

nameSuffix
string (optional) 

Name Suffix. Maximum length is 20.

noteMessage
string (optional) 

Note Message.

nameChangedDate
string (optional) 

Name Changed Date.

dflt
string (optional) 

Default. Maximum length is 1.

edit
string (optional) 

Edit.

documentNumber
string (optional) 

Document Number.

active
string (optional) 

Active. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "entityNameId": "(val)",
    "nameCode": "(val)",
    "firstName": "(val)",
    "middleName": "(val)",
    "lastName": "(val)",
    "namePrefix": "(val)",
    "nameTitle": "(val)",
    "nameSuffix": "(val)",
    "noteMessage": "(val)",
    "nameChangedDate": "(val)",
    "dflt": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "entityNameId": "(val)",
    "nameCode": "(val)",
    "firstName": "(val)",
    "middleName": "(val)",
    "lastName": "(val)",
    "namePrefix": "(val)",
    "nameTitle": "(val)",
    "nameSuffix": "(val)",
    "noteMessage": "(val)",
    "nameChangedDate": "(val)",
    "dflt": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Person Document Names
GET/research-sys/api/v1/person-document-names/

Example URI

GET /research-sys/api/v1/person-document-names/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "entityNameId",
    "nameCode",
    "firstName",
    "middleName",
    "lastName",
    "namePrefix",
    "nameTitle",
    "nameSuffix",
    "noteMessage",
    "nameChangedDate",
    "dflt",
    "edit",
    "documentNumber",
    "active"
  ],
  "primaryKey": "entityNameId"
}

Get Blueprint API specification for Person Document Names
GET/research-sys/api/v1/person-document-names/

Example URI

GET /research-sys/api/v1/person-document-names/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Person Document Names.md"
transfer-encoding: chunked

Update Person Document Names
PUT/research-sys/api/v1/person-document-names/(key)

Example URI

PUT /research-sys/api/v1/person-document-names/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "entityNameId": "(val)",
  "nameCode": "(val)",
  "firstName": "(val)",
  "middleName": "(val)",
  "lastName": "(val)",
  "namePrefix": "(val)",
  "nameTitle": "(val)",
  "nameSuffix": "(val)",
  "noteMessage": "(val)",
  "nameChangedDate": "(val)",
  "dflt": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Person Document Names
PUT/research-sys/api/v1/person-document-names/

Example URI

PUT /research-sys/api/v1/person-document-names/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "entityNameId": "(val)",
    "nameCode": "(val)",
    "firstName": "(val)",
    "middleName": "(val)",
    "lastName": "(val)",
    "namePrefix": "(val)",
    "nameTitle": "(val)",
    "nameSuffix": "(val)",
    "noteMessage": "(val)",
    "nameChangedDate": "(val)",
    "dflt": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "entityNameId": "(val)",
    "nameCode": "(val)",
    "firstName": "(val)",
    "middleName": "(val)",
    "lastName": "(val)",
    "namePrefix": "(val)",
    "nameTitle": "(val)",
    "nameSuffix": "(val)",
    "noteMessage": "(val)",
    "nameChangedDate": "(val)",
    "dflt": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Person Document Names
PATCH/research-sys/api/v1/person-document-names/(key)

Example URI

PATCH /research-sys/api/v1/person-document-names/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "entityNameId": "(val)",
  "nameCode": "(val)",
  "firstName": "(val)",
  "middleName": "(val)",
  "lastName": "(val)",
  "namePrefix": "(val)",
  "nameTitle": "(val)",
  "nameSuffix": "(val)",
  "noteMessage": "(val)",
  "nameChangedDate": "(val)",
  "dflt": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "entityNameId": "(val)",
  "nameCode": "(val)",
  "firstName": "(val)",
  "middleName": "(val)",
  "lastName": "(val)",
  "namePrefix": "(val)",
  "nameTitle": "(val)",
  "nameSuffix": "(val)",
  "noteMessage": "(val)",
  "nameChangedDate": "(val)",
  "dflt": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Person Document Names
POST/research-sys/api/v1/person-document-names/

Example URI

POST /research-sys/api/v1/person-document-names/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "entityNameId": "(val)",
  "nameCode": "(val)",
  "firstName": "(val)",
  "middleName": "(val)",
  "lastName": "(val)",
  "namePrefix": "(val)",
  "nameTitle": "(val)",
  "nameSuffix": "(val)",
  "noteMessage": "(val)",
  "nameChangedDate": "(val)",
  "dflt": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "entityNameId": "(val)",
  "nameCode": "(val)",
  "firstName": "(val)",
  "middleName": "(val)",
  "lastName": "(val)",
  "namePrefix": "(val)",
  "nameTitle": "(val)",
  "nameSuffix": "(val)",
  "noteMessage": "(val)",
  "nameChangedDate": "(val)",
  "dflt": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Person Document Names
POST/research-sys/api/v1/person-document-names/

Example URI

POST /research-sys/api/v1/person-document-names/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "entityNameId": "(val)",
    "nameCode": "(val)",
    "firstName": "(val)",
    "middleName": "(val)",
    "lastName": "(val)",
    "namePrefix": "(val)",
    "nameTitle": "(val)",
    "nameSuffix": "(val)",
    "noteMessage": "(val)",
    "nameChangedDate": "(val)",
    "dflt": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "entityNameId": "(val)",
    "nameCode": "(val)",
    "firstName": "(val)",
    "middleName": "(val)",
    "lastName": "(val)",
    "namePrefix": "(val)",
    "nameTitle": "(val)",
    "nameSuffix": "(val)",
    "noteMessage": "(val)",
    "nameChangedDate": "(val)",
    "dflt": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "entityNameId": "(val)",
    "nameCode": "(val)",
    "firstName": "(val)",
    "middleName": "(val)",
    "lastName": "(val)",
    "namePrefix": "(val)",
    "nameTitle": "(val)",
    "nameSuffix": "(val)",
    "noteMessage": "(val)",
    "nameChangedDate": "(val)",
    "dflt": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "entityNameId": "(val)",
    "nameCode": "(val)",
    "firstName": "(val)",
    "middleName": "(val)",
    "lastName": "(val)",
    "namePrefix": "(val)",
    "nameTitle": "(val)",
    "nameSuffix": "(val)",
    "noteMessage": "(val)",
    "nameChangedDate": "(val)",
    "dflt": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Person Document Names by Key
DELETE/research-sys/api/v1/person-document-names/(key)

Example URI

DELETE /research-sys/api/v1/person-document-names/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Person Document Names
DELETE/research-sys/api/v1/person-document-names/

Example URI

DELETE /research-sys/api/v1/person-document-names/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Person Document Names with Matching
DELETE/research-sys/api/v1/person-document-names/

Example URI

DELETE /research-sys/api/v1/person-document-names/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

entityNameId
string (optional) 

Entity Name Id.

nameCode
string (optional) 

Name Code. Maximum length is 40.

firstName
string (optional) 

First Name. Maximum length is 40.

middleName
string (optional) 

Middle Name. Maximum length is 40.

lastName
string (optional) 

Last Name. Maximum length is 80.

namePrefix
string (optional) 

Name Prefix. Maximum length is 20.

nameTitle
string (optional) 

Name Title.

nameSuffix
string (optional) 

Name Suffix. Maximum length is 20.

noteMessage
string (optional) 

Note Message.

nameChangedDate
string (optional) 

Name Changed Date.

dflt
string (optional) 

Default. Maximum length is 1.

edit
string (optional) 

Edit.

documentNumber
string (optional) 

Document Number.

active
string (optional) 

Active. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Person Document Phones

Get Person Document Phones by Key
GET/research-sys/api/v1/person-document-phones/(key)

Example URI

GET /research-sys/api/v1/person-document-phones/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "entityPhoneId": "(val)",
  "entityTypeCode": "(val)",
  "phoneTypeCode": "(val)",
  "phoneNumber": "(val)",
  "extensionNumber": "(val)",
  "countryCode": "(val)",
  "dflt": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Get All Person Document Phones
GET/research-sys/api/v1/person-document-phones/

Example URI

GET /research-sys/api/v1/person-document-phones/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "entityPhoneId": "(val)",
    "entityTypeCode": "(val)",
    "phoneTypeCode": "(val)",
    "phoneNumber": "(val)",
    "extensionNumber": "(val)",
    "countryCode": "(val)",
    "dflt": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "entityPhoneId": "(val)",
    "entityTypeCode": "(val)",
    "phoneTypeCode": "(val)",
    "phoneNumber": "(val)",
    "extensionNumber": "(val)",
    "countryCode": "(val)",
    "dflt": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Person Document Phones with Filtering
GET/research-sys/api/v1/person-document-phones/

Example URI

GET /research-sys/api/v1/person-document-phones/
URI Parameters
HideShow
entityPhoneId
string (optional) 

Entity Phone Id.

entityTypeCode
string (optional) 

Entity Type Code.

phoneTypeCode
string (optional) 

Phone Type. Maximum length is 40.

phoneNumber
string (optional) 

Phone Number. Maximum length is 20.

extensionNumber
string (optional) 

Extension. Maximum length is 8.

countryCode
string (optional) 

Country. Maximum length is 2.

dflt
string (optional) 

Default. Maximum length is 1.

edit
string (optional) 

Edit.

documentNumber
string (optional) 

Document Number.

active
string (optional) 

Active. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "entityPhoneId": "(val)",
    "entityTypeCode": "(val)",
    "phoneTypeCode": "(val)",
    "phoneNumber": "(val)",
    "extensionNumber": "(val)",
    "countryCode": "(val)",
    "dflt": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "entityPhoneId": "(val)",
    "entityTypeCode": "(val)",
    "phoneTypeCode": "(val)",
    "phoneNumber": "(val)",
    "extensionNumber": "(val)",
    "countryCode": "(val)",
    "dflt": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Person Document Phones
GET/research-sys/api/v1/person-document-phones/

Example URI

GET /research-sys/api/v1/person-document-phones/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "entityPhoneId",
    "entityTypeCode",
    "phoneTypeCode",
    "phoneNumber",
    "extensionNumber",
    "countryCode",
    "dflt",
    "edit",
    "documentNumber",
    "active"
  ],
  "primaryKey": "entityPhoneId"
}

Get Blueprint API specification for Person Document Phones
GET/research-sys/api/v1/person-document-phones/

Example URI

GET /research-sys/api/v1/person-document-phones/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Person Document Phones.md"
transfer-encoding: chunked

Update Person Document Phones
PUT/research-sys/api/v1/person-document-phones/(key)

Example URI

PUT /research-sys/api/v1/person-document-phones/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "entityPhoneId": "(val)",
  "entityTypeCode": "(val)",
  "phoneTypeCode": "(val)",
  "phoneNumber": "(val)",
  "extensionNumber": "(val)",
  "countryCode": "(val)",
  "dflt": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Person Document Phones
PUT/research-sys/api/v1/person-document-phones/

Example URI

PUT /research-sys/api/v1/person-document-phones/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "entityPhoneId": "(val)",
    "entityTypeCode": "(val)",
    "phoneTypeCode": "(val)",
    "phoneNumber": "(val)",
    "extensionNumber": "(val)",
    "countryCode": "(val)",
    "dflt": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "entityPhoneId": "(val)",
    "entityTypeCode": "(val)",
    "phoneTypeCode": "(val)",
    "phoneNumber": "(val)",
    "extensionNumber": "(val)",
    "countryCode": "(val)",
    "dflt": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Person Document Phones
PATCH/research-sys/api/v1/person-document-phones/(key)

Example URI

PATCH /research-sys/api/v1/person-document-phones/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "entityPhoneId": "(val)",
  "entityTypeCode": "(val)",
  "phoneTypeCode": "(val)",
  "phoneNumber": "(val)",
  "extensionNumber": "(val)",
  "countryCode": "(val)",
  "dflt": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "entityPhoneId": "(val)",
  "entityTypeCode": "(val)",
  "phoneTypeCode": "(val)",
  "phoneNumber": "(val)",
  "extensionNumber": "(val)",
  "countryCode": "(val)",
  "dflt": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Person Document Phones
POST/research-sys/api/v1/person-document-phones/

Example URI

POST /research-sys/api/v1/person-document-phones/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "entityPhoneId": "(val)",
  "entityTypeCode": "(val)",
  "phoneTypeCode": "(val)",
  "phoneNumber": "(val)",
  "extensionNumber": "(val)",
  "countryCode": "(val)",
  "dflt": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "entityPhoneId": "(val)",
  "entityTypeCode": "(val)",
  "phoneTypeCode": "(val)",
  "phoneNumber": "(val)",
  "extensionNumber": "(val)",
  "countryCode": "(val)",
  "dflt": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Person Document Phones
POST/research-sys/api/v1/person-document-phones/

Example URI

POST /research-sys/api/v1/person-document-phones/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "entityPhoneId": "(val)",
    "entityTypeCode": "(val)",
    "phoneTypeCode": "(val)",
    "phoneNumber": "(val)",
    "extensionNumber": "(val)",
    "countryCode": "(val)",
    "dflt": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "entityPhoneId": "(val)",
    "entityTypeCode": "(val)",
    "phoneTypeCode": "(val)",
    "phoneNumber": "(val)",
    "extensionNumber": "(val)",
    "countryCode": "(val)",
    "dflt": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "entityPhoneId": "(val)",
    "entityTypeCode": "(val)",
    "phoneTypeCode": "(val)",
    "phoneNumber": "(val)",
    "extensionNumber": "(val)",
    "countryCode": "(val)",
    "dflt": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "entityPhoneId": "(val)",
    "entityTypeCode": "(val)",
    "phoneTypeCode": "(val)",
    "phoneNumber": "(val)",
    "extensionNumber": "(val)",
    "countryCode": "(val)",
    "dflt": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Person Document Phones by Key
DELETE/research-sys/api/v1/person-document-phones/(key)

Example URI

DELETE /research-sys/api/v1/person-document-phones/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Person Document Phones
DELETE/research-sys/api/v1/person-document-phones/

Example URI

DELETE /research-sys/api/v1/person-document-phones/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Person Document Phones with Matching
DELETE/research-sys/api/v1/person-document-phones/

Example URI

DELETE /research-sys/api/v1/person-document-phones/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

entityPhoneId
string (optional) 

Entity Phone Id.

entityTypeCode
string (optional) 

Entity Type Code.

phoneTypeCode
string (optional) 

Phone Type. Maximum length is 40.

phoneNumber
string (optional) 

Phone Number. Maximum length is 20.

extensionNumber
string (optional) 

Extension. Maximum length is 8.

countryCode
string (optional) 

Country. Maximum length is 2.

dflt
string (optional) 

Default. Maximum length is 1.

edit
string (optional) 

Edit.

documentNumber
string (optional) 

Document Number.

active
string (optional) 

Active. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Person Document Privacy Entries

Get Person Document Privacy Entries by Key
GET/research-sys/api/v1/person-document-privacy-entries/(key)

Example URI

GET /research-sys/api/v1/person-document-privacy-entries/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "suppressName": "(val)",
  "suppressEmail": "(val)",
  "suppressAddress": "(val)",
  "suppressPhone": "(val)",
  "suppressPersonal": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "_primaryKey": "(val)"
}

Get All Person Document Privacy Entries
GET/research-sys/api/v1/person-document-privacy-entries/

Example URI

GET /research-sys/api/v1/person-document-privacy-entries/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "suppressName": "(val)",
    "suppressEmail": "(val)",
    "suppressAddress": "(val)",
    "suppressPhone": "(val)",
    "suppressPersonal": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "suppressName": "(val)",
    "suppressEmail": "(val)",
    "suppressAddress": "(val)",
    "suppressPhone": "(val)",
    "suppressPersonal": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Person Document Privacy Entries with Filtering
GET/research-sys/api/v1/person-document-privacy-entries/

Example URI

GET /research-sys/api/v1/person-document-privacy-entries/
URI Parameters
HideShow
suppressName
string (optional) 

Suppress Name. Maximum length is 1.

suppressEmail
string (optional) 

Suppress Email. Maximum length is 1.

suppressAddress
string (optional) 

Suppress Address. Maximum length is 1.

suppressPhone
string (optional) 

Suppress Phone. Maximum length is 1.

suppressPersonal
string (optional) 

Suppress Personal. Maximum length is 1.

edit
string (optional) 

Edit.

documentNumber
string (optional) 

Document Number.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "suppressName": "(val)",
    "suppressEmail": "(val)",
    "suppressAddress": "(val)",
    "suppressPhone": "(val)",
    "suppressPersonal": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "suppressName": "(val)",
    "suppressEmail": "(val)",
    "suppressAddress": "(val)",
    "suppressPhone": "(val)",
    "suppressPersonal": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Person Document Privacy Entries
GET/research-sys/api/v1/person-document-privacy-entries/

Example URI

GET /research-sys/api/v1/person-document-privacy-entries/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "suppressName",
    "suppressEmail",
    "suppressAddress",
    "suppressPhone",
    "suppressPersonal",
    "edit",
    "documentNumber"
  ],
  "primaryKey": "documentNumber"
}

Get Blueprint API specification for Person Document Privacy Entries
GET/research-sys/api/v1/person-document-privacy-entries/

Example URI

GET /research-sys/api/v1/person-document-privacy-entries/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Person Document Privacy Entries.md"
transfer-encoding: chunked

Update Person Document Privacy Entries
PUT/research-sys/api/v1/person-document-privacy-entries/(key)

Example URI

PUT /research-sys/api/v1/person-document-privacy-entries/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "suppressName": "(val)",
  "suppressEmail": "(val)",
  "suppressAddress": "(val)",
  "suppressPhone": "(val)",
  "suppressPersonal": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Person Document Privacy Entries
PUT/research-sys/api/v1/person-document-privacy-entries/

Example URI

PUT /research-sys/api/v1/person-document-privacy-entries/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "suppressName": "(val)",
    "suppressEmail": "(val)",
    "suppressAddress": "(val)",
    "suppressPhone": "(val)",
    "suppressPersonal": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "suppressName": "(val)",
    "suppressEmail": "(val)",
    "suppressAddress": "(val)",
    "suppressPhone": "(val)",
    "suppressPersonal": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Person Document Privacy Entries
PATCH/research-sys/api/v1/person-document-privacy-entries/(key)

Example URI

PATCH /research-sys/api/v1/person-document-privacy-entries/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "suppressName": "(val)",
  "suppressEmail": "(val)",
  "suppressAddress": "(val)",
  "suppressPhone": "(val)",
  "suppressPersonal": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "suppressName": "(val)",
  "suppressEmail": "(val)",
  "suppressAddress": "(val)",
  "suppressPhone": "(val)",
  "suppressPersonal": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "_primaryKey": "(val)"
}

Insert Person Document Privacy Entries
POST/research-sys/api/v1/person-document-privacy-entries/

Example URI

POST /research-sys/api/v1/person-document-privacy-entries/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "suppressName": "(val)",
  "suppressEmail": "(val)",
  "suppressAddress": "(val)",
  "suppressPhone": "(val)",
  "suppressPersonal": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "suppressName": "(val)",
  "suppressEmail": "(val)",
  "suppressAddress": "(val)",
  "suppressPhone": "(val)",
  "suppressPersonal": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Person Document Privacy Entries
POST/research-sys/api/v1/person-document-privacy-entries/

Example URI

POST /research-sys/api/v1/person-document-privacy-entries/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "suppressName": "(val)",
    "suppressEmail": "(val)",
    "suppressAddress": "(val)",
    "suppressPhone": "(val)",
    "suppressPersonal": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "suppressName": "(val)",
    "suppressEmail": "(val)",
    "suppressAddress": "(val)",
    "suppressPhone": "(val)",
    "suppressPersonal": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "suppressName": "(val)",
    "suppressEmail": "(val)",
    "suppressAddress": "(val)",
    "suppressPhone": "(val)",
    "suppressPersonal": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "suppressName": "(val)",
    "suppressEmail": "(val)",
    "suppressAddress": "(val)",
    "suppressPhone": "(val)",
    "suppressPersonal": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Person Document Privacy Entries by Key
DELETE/research-sys/api/v1/person-document-privacy-entries/(key)

Example URI

DELETE /research-sys/api/v1/person-document-privacy-entries/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Person Document Privacy Entries
DELETE/research-sys/api/v1/person-document-privacy-entries/

Example URI

DELETE /research-sys/api/v1/person-document-privacy-entries/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Person Document Privacy Entries with Matching
DELETE/research-sys/api/v1/person-document-privacy-entries/

Example URI

DELETE /research-sys/api/v1/person-document-privacy-entries/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

suppressName
string (optional) 

Suppress Name. Maximum length is 1.

suppressEmail
string (optional) 

Suppress Email. Maximum length is 1.

suppressAddress
string (optional) 

Suppress Address. Maximum length is 1.

suppressPhone
string (optional) 

Suppress Phone. Maximum length is 1.

suppressPersonal
string (optional) 

Suppress Personal. Maximum length is 1.

edit
string (optional) 

Edit.

documentNumber
string (optional) 

Document Number.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Person Document Roles

Get Person Document Roles by Key
GET/research-sys/api/v1/person-document-roles/(key)

Example URI

GET /research-sys/api/v1/person-document-roles/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "roleId": "(val)",
  "kimTypeId": "(val)",
  "roleName": "(val)",
  "namespaceCode": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Get All Person Document Roles
GET/research-sys/api/v1/person-document-roles/

Example URI

GET /research-sys/api/v1/person-document-roles/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "roleId": "(val)",
    "kimTypeId": "(val)",
    "roleName": "(val)",
    "namespaceCode": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "roleId": "(val)",
    "kimTypeId": "(val)",
    "roleName": "(val)",
    "namespaceCode": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Person Document Roles with Filtering
GET/research-sys/api/v1/person-document-roles/

Example URI

GET /research-sys/api/v1/person-document-roles/
URI Parameters
HideShow
roleId
string (optional) 

Role. Maximum length is 40.

kimTypeId
string (optional) 

Type. Maximum length is 40.

roleName
string (optional) 

Name. Maximum length is 80.

namespaceCode
string (optional) 

Namespace Code. Maximum length is 40.

edit
string (optional) 

Edit.

documentNumber
string (optional) 

Document Number.

active
string (optional) 

Active.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "roleId": "(val)",
    "kimTypeId": "(val)",
    "roleName": "(val)",
    "namespaceCode": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "roleId": "(val)",
    "kimTypeId": "(val)",
    "roleName": "(val)",
    "namespaceCode": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Person Document Roles
GET/research-sys/api/v1/person-document-roles/

Example URI

GET /research-sys/api/v1/person-document-roles/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "roleId",
    "kimTypeId",
    "roleName",
    "namespaceCode",
    "edit",
    "documentNumber",
    "active"
  ],
  "primaryKey": "roleId"
}

Get Blueprint API specification for Person Document Roles
GET/research-sys/api/v1/person-document-roles/

Example URI

GET /research-sys/api/v1/person-document-roles/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Person Document Roles.md"
transfer-encoding: chunked

Update Person Document Roles
PUT/research-sys/api/v1/person-document-roles/(key)

Example URI

PUT /research-sys/api/v1/person-document-roles/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "roleId": "(val)",
  "kimTypeId": "(val)",
  "roleName": "(val)",
  "namespaceCode": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Person Document Roles
PUT/research-sys/api/v1/person-document-roles/

Example URI

PUT /research-sys/api/v1/person-document-roles/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "roleId": "(val)",
    "kimTypeId": "(val)",
    "roleName": "(val)",
    "namespaceCode": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "roleId": "(val)",
    "kimTypeId": "(val)",
    "roleName": "(val)",
    "namespaceCode": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Person Document Roles
PATCH/research-sys/api/v1/person-document-roles/(key)

Example URI

PATCH /research-sys/api/v1/person-document-roles/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "roleId": "(val)",
  "kimTypeId": "(val)",
  "roleName": "(val)",
  "namespaceCode": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "roleId": "(val)",
  "kimTypeId": "(val)",
  "roleName": "(val)",
  "namespaceCode": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Person Document Roles
POST/research-sys/api/v1/person-document-roles/

Example URI

POST /research-sys/api/v1/person-document-roles/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "roleId": "(val)",
  "kimTypeId": "(val)",
  "roleName": "(val)",
  "namespaceCode": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "roleId": "(val)",
  "kimTypeId": "(val)",
  "roleName": "(val)",
  "namespaceCode": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Person Document Roles
POST/research-sys/api/v1/person-document-roles/

Example URI

POST /research-sys/api/v1/person-document-roles/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "roleId": "(val)",
    "kimTypeId": "(val)",
    "roleName": "(val)",
    "namespaceCode": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "roleId": "(val)",
    "kimTypeId": "(val)",
    "roleName": "(val)",
    "namespaceCode": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "roleId": "(val)",
    "kimTypeId": "(val)",
    "roleName": "(val)",
    "namespaceCode": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "roleId": "(val)",
    "kimTypeId": "(val)",
    "roleName": "(val)",
    "namespaceCode": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Person Document Roles by Key
DELETE/research-sys/api/v1/person-document-roles/(key)

Example URI

DELETE /research-sys/api/v1/person-document-roles/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Person Document Roles
DELETE/research-sys/api/v1/person-document-roles/

Example URI

DELETE /research-sys/api/v1/person-document-roles/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Person Document Roles with Matching
DELETE/research-sys/api/v1/person-document-roles/

Example URI

DELETE /research-sys/api/v1/person-document-roles/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

roleId
string (optional) 

Role. Maximum length is 40.

kimTypeId
string (optional) 

Type. Maximum length is 40.

roleName
string (optional) 

Name. Maximum length is 80.

namespaceCode
string (optional) 

Namespace Code. Maximum length is 40.

edit
string (optional) 

Edit.

documentNumber
string (optional) 

Document Number.

active
string (optional) 

Active.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Person Rule Responsibilities

Get Person Rule Responsibilities by Key
GET/research-sys/api/v1/person-rule-responsibilities/(key)

Example URI

GET /research-sys/api/v1/person-rule-responsibilities/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "responsibilityId": "(val)",
  "ruleBaseValuesId": "(val)",
  "priority": "(val)",
  "actionRequestedCd": "(val)",
  "ruleResponsibilityName": "(val)",
  "ruleResponsibilityType": "(val)",
  "approvePolicy": "(val)",
  "_primaryKey": "(val)"
}

Get All Person Rule Responsibilities
GET/research-sys/api/v1/person-rule-responsibilities/

Example URI

GET /research-sys/api/v1/person-rule-responsibilities/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "responsibilityId": "(val)",
    "ruleBaseValuesId": "(val)",
    "priority": "(val)",
    "actionRequestedCd": "(val)",
    "ruleResponsibilityName": "(val)",
    "ruleResponsibilityType": "(val)",
    "approvePolicy": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "responsibilityId": "(val)",
    "ruleBaseValuesId": "(val)",
    "priority": "(val)",
    "actionRequestedCd": "(val)",
    "ruleResponsibilityName": "(val)",
    "ruleResponsibilityType": "(val)",
    "approvePolicy": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Person Rule Responsibilities with Filtering
GET/research-sys/api/v1/person-rule-responsibilities/

Example URI

GET /research-sys/api/v1/person-rule-responsibilities/
URI Parameters
HideShow
id
string (optional) 
responsibilityId
string (optional) 
ruleBaseValuesId
string (optional) 
priority
string (optional) 

Priority. Maximum length is 30.

actionRequestedCd
string (optional) 

Action Request. Maximum length is 30.

ruleResponsibilityName
string (optional) 
ruleResponsibilityType
string (optional) 
approvePolicy
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "responsibilityId": "(val)",
    "ruleBaseValuesId": "(val)",
    "priority": "(val)",
    "actionRequestedCd": "(val)",
    "ruleResponsibilityName": "(val)",
    "ruleResponsibilityType": "(val)",
    "approvePolicy": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "responsibilityId": "(val)",
    "ruleBaseValuesId": "(val)",
    "priority": "(val)",
    "actionRequestedCd": "(val)",
    "ruleResponsibilityName": "(val)",
    "ruleResponsibilityType": "(val)",
    "approvePolicy": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Person Rule Responsibilities
GET/research-sys/api/v1/person-rule-responsibilities/

Example URI

GET /research-sys/api/v1/person-rule-responsibilities/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "responsibilityId",
    "ruleBaseValuesId",
    "priority",
    "actionRequestedCd",
    "ruleResponsibilityName",
    "ruleResponsibilityType",
    "approvePolicy"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Person Rule Responsibilities
GET/research-sys/api/v1/person-rule-responsibilities/

Example URI

GET /research-sys/api/v1/person-rule-responsibilities/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Person Rule Responsibilities.md"
transfer-encoding: chunked

Update Person Rule Responsibilities
PUT/research-sys/api/v1/person-rule-responsibilities/(key)

Example URI

PUT /research-sys/api/v1/person-rule-responsibilities/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "responsibilityId": "(val)",
  "ruleBaseValuesId": "(val)",
  "priority": "(val)",
  "actionRequestedCd": "(val)",
  "ruleResponsibilityName": "(val)",
  "ruleResponsibilityType": "(val)",
  "approvePolicy": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Person Rule Responsibilities
PUT/research-sys/api/v1/person-rule-responsibilities/

Example URI

PUT /research-sys/api/v1/person-rule-responsibilities/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "responsibilityId": "(val)",
    "ruleBaseValuesId": "(val)",
    "priority": "(val)",
    "actionRequestedCd": "(val)",
    "ruleResponsibilityName": "(val)",
    "ruleResponsibilityType": "(val)",
    "approvePolicy": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "responsibilityId": "(val)",
    "ruleBaseValuesId": "(val)",
    "priority": "(val)",
    "actionRequestedCd": "(val)",
    "ruleResponsibilityName": "(val)",
    "ruleResponsibilityType": "(val)",
    "approvePolicy": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Person Rule Responsibilities
PATCH/research-sys/api/v1/person-rule-responsibilities/(key)

Example URI

PATCH /research-sys/api/v1/person-rule-responsibilities/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "responsibilityId": "(val)",
  "ruleBaseValuesId": "(val)",
  "priority": "(val)",
  "actionRequestedCd": "(val)",
  "ruleResponsibilityName": "(val)",
  "ruleResponsibilityType": "(val)",
  "approvePolicy": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "responsibilityId": "(val)",
  "ruleBaseValuesId": "(val)",
  "priority": "(val)",
  "actionRequestedCd": "(val)",
  "ruleResponsibilityName": "(val)",
  "ruleResponsibilityType": "(val)",
  "approvePolicy": "(val)",
  "_primaryKey": "(val)"
}

Insert Person Rule Responsibilities
POST/research-sys/api/v1/person-rule-responsibilities/

Example URI

POST /research-sys/api/v1/person-rule-responsibilities/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "responsibilityId": "(val)",
  "ruleBaseValuesId": "(val)",
  "priority": "(val)",
  "actionRequestedCd": "(val)",
  "ruleResponsibilityName": "(val)",
  "ruleResponsibilityType": "(val)",
  "approvePolicy": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "responsibilityId": "(val)",
  "ruleBaseValuesId": "(val)",
  "priority": "(val)",
  "actionRequestedCd": "(val)",
  "ruleResponsibilityName": "(val)",
  "ruleResponsibilityType": "(val)",
  "approvePolicy": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Person Rule Responsibilities
POST/research-sys/api/v1/person-rule-responsibilities/

Example URI

POST /research-sys/api/v1/person-rule-responsibilities/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "responsibilityId": "(val)",
    "ruleBaseValuesId": "(val)",
    "priority": "(val)",
    "actionRequestedCd": "(val)",
    "ruleResponsibilityName": "(val)",
    "ruleResponsibilityType": "(val)",
    "approvePolicy": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "responsibilityId": "(val)",
    "ruleBaseValuesId": "(val)",
    "priority": "(val)",
    "actionRequestedCd": "(val)",
    "ruleResponsibilityName": "(val)",
    "ruleResponsibilityType": "(val)",
    "approvePolicy": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "responsibilityId": "(val)",
    "ruleBaseValuesId": "(val)",
    "priority": "(val)",
    "actionRequestedCd": "(val)",
    "ruleResponsibilityName": "(val)",
    "ruleResponsibilityType": "(val)",
    "approvePolicy": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "responsibilityId": "(val)",
    "ruleBaseValuesId": "(val)",
    "priority": "(val)",
    "actionRequestedCd": "(val)",
    "ruleResponsibilityName": "(val)",
    "ruleResponsibilityType": "(val)",
    "approvePolicy": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Person Rule Responsibilities by Key
DELETE/research-sys/api/v1/person-rule-responsibilities/(key)

Example URI

DELETE /research-sys/api/v1/person-rule-responsibilities/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Person Rule Responsibilities
DELETE/research-sys/api/v1/person-rule-responsibilities/

Example URI

DELETE /research-sys/api/v1/person-rule-responsibilities/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Person Rule Responsibilities with Matching
DELETE/research-sys/api/v1/person-rule-responsibilities/

Example URI

DELETE /research-sys/api/v1/person-rule-responsibilities/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 
responsibilityId
string (optional) 
ruleBaseValuesId
string (optional) 
priority
string (optional) 

Priority. Maximum length is 30.

actionRequestedCd
string (optional) 

Action Request. Maximum length is 30.

ruleResponsibilityName
string (optional) 
ruleResponsibilityType
string (optional) 
approvePolicy
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Pessimistic Locks

Get Pessimistic Locks by Key
GET/research-sys/api/v1/pessimistic-locks/(key)

Example URI

GET /research-sys/api/v1/pessimistic-locks/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "ownedByPrincipalIdentifier": "(val)",
  "lockDescriptor": "(val)",
  "generatedTimestamp": "(val)",
  "documentNumber": "(val)",
  "sessionId": "(val)",
  "_primaryKey": "(val)"
}

Get All Pessimistic Locks
GET/research-sys/api/v1/pessimistic-locks/

Example URI

GET /research-sys/api/v1/pessimistic-locks/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "ownedByPrincipalIdentifier": "(val)",
    "lockDescriptor": "(val)",
    "generatedTimestamp": "(val)",
    "documentNumber": "(val)",
    "sessionId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "ownedByPrincipalIdentifier": "(val)",
    "lockDescriptor": "(val)",
    "generatedTimestamp": "(val)",
    "documentNumber": "(val)",
    "sessionId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Pessimistic Locks with Filtering
GET/research-sys/api/v1/pessimistic-locks/

Example URI

GET /research-sys/api/v1/pessimistic-locks/
URI Parameters
HideShow
id
string (optional) 

Pessimistic Lock Description. Maximum length is 10.

ownedByPrincipalIdentifier
string (optional) 

Lock Owner Principal Name. Maximum length is 40.

lockDescriptor
string (optional) 

Lock Descriptor description. Maximum length is 4000.

generatedTimestamp
string (optional) 

This field defines the date and time the lock was created. Maximum length is 21.

documentNumber
string (optional) 

The document id is generated by the workflow environment and is unique to each installation of Kuali… Maximum length is 14.

sessionId
string (optional) 

Session Id.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "ownedByPrincipalIdentifier": "(val)",
    "lockDescriptor": "(val)",
    "generatedTimestamp": "(val)",
    "documentNumber": "(val)",
    "sessionId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "ownedByPrincipalIdentifier": "(val)",
    "lockDescriptor": "(val)",
    "generatedTimestamp": "(val)",
    "documentNumber": "(val)",
    "sessionId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Pessimistic Locks
GET/research-sys/api/v1/pessimistic-locks/

Example URI

GET /research-sys/api/v1/pessimistic-locks/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "ownedByPrincipalIdentifier",
    "lockDescriptor",
    "generatedTimestamp",
    "documentNumber",
    "sessionId"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Pessimistic Locks
GET/research-sys/api/v1/pessimistic-locks/

Example URI

GET /research-sys/api/v1/pessimistic-locks/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Pessimistic Locks.md"
transfer-encoding: chunked

Update Pessimistic Locks
PUT/research-sys/api/v1/pessimistic-locks/(key)

Example URI

PUT /research-sys/api/v1/pessimistic-locks/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "ownedByPrincipalIdentifier": "(val)",
  "lockDescriptor": "(val)",
  "generatedTimestamp": "(val)",
  "documentNumber": "(val)",
  "sessionId": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Pessimistic Locks
PUT/research-sys/api/v1/pessimistic-locks/

Example URI

PUT /research-sys/api/v1/pessimistic-locks/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "ownedByPrincipalIdentifier": "(val)",
    "lockDescriptor": "(val)",
    "generatedTimestamp": "(val)",
    "documentNumber": "(val)",
    "sessionId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "ownedByPrincipalIdentifier": "(val)",
    "lockDescriptor": "(val)",
    "generatedTimestamp": "(val)",
    "documentNumber": "(val)",
    "sessionId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Pessimistic Locks
PATCH/research-sys/api/v1/pessimistic-locks/(key)

Example URI

PATCH /research-sys/api/v1/pessimistic-locks/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "ownedByPrincipalIdentifier": "(val)",
  "lockDescriptor": "(val)",
  "generatedTimestamp": "(val)",
  "documentNumber": "(val)",
  "sessionId": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "ownedByPrincipalIdentifier": "(val)",
  "lockDescriptor": "(val)",
  "generatedTimestamp": "(val)",
  "documentNumber": "(val)",
  "sessionId": "(val)",
  "_primaryKey": "(val)"
}

Insert Pessimistic Locks
POST/research-sys/api/v1/pessimistic-locks/

Example URI

POST /research-sys/api/v1/pessimistic-locks/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "ownedByPrincipalIdentifier": "(val)",
  "lockDescriptor": "(val)",
  "generatedTimestamp": "(val)",
  "documentNumber": "(val)",
  "sessionId": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "ownedByPrincipalIdentifier": "(val)",
  "lockDescriptor": "(val)",
  "generatedTimestamp": "(val)",
  "documentNumber": "(val)",
  "sessionId": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Pessimistic Locks
POST/research-sys/api/v1/pessimistic-locks/

Example URI

POST /research-sys/api/v1/pessimistic-locks/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "ownedByPrincipalIdentifier": "(val)",
    "lockDescriptor": "(val)",
    "generatedTimestamp": "(val)",
    "documentNumber": "(val)",
    "sessionId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "ownedByPrincipalIdentifier": "(val)",
    "lockDescriptor": "(val)",
    "generatedTimestamp": "(val)",
    "documentNumber": "(val)",
    "sessionId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "ownedByPrincipalIdentifier": "(val)",
    "lockDescriptor": "(val)",
    "generatedTimestamp": "(val)",
    "documentNumber": "(val)",
    "sessionId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "ownedByPrincipalIdentifier": "(val)",
    "lockDescriptor": "(val)",
    "generatedTimestamp": "(val)",
    "documentNumber": "(val)",
    "sessionId": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Pessimistic Locks by Key
DELETE/research-sys/api/v1/pessimistic-locks/(key)

Example URI

DELETE /research-sys/api/v1/pessimistic-locks/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Pessimistic Locks
DELETE/research-sys/api/v1/pessimistic-locks/

Example URI

DELETE /research-sys/api/v1/pessimistic-locks/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Pessimistic Locks with Matching
DELETE/research-sys/api/v1/pessimistic-locks/

Example URI

DELETE /research-sys/api/v1/pessimistic-locks/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 

Pessimistic Lock Description. Maximum length is 10.

ownedByPrincipalIdentifier
string (optional) 

Lock Owner Principal Name. Maximum length is 40.

lockDescriptor
string (optional) 

Lock Descriptor description. Maximum length is 4000.

generatedTimestamp
string (optional) 

This field defines the date and time the lock was created. Maximum length is 21.

documentNumber
string (optional) 

The document id is generated by the workflow environment and is unique to each installation of Kuali… Maximum length is 14.

sessionId
string (optional) 

Session Id.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Postal Codes

Get Postal Codes by Key
GET/research-sys/api/v1/postal-codes/(key)

Example URI

GET /research-sys/api/v1/postal-codes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "code": "(val)",
  "countryCode": "(val)",
  "cityName": "(val)",
  "stateCode": "(val)",
  "countyCode": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Get All Postal Codes
GET/research-sys/api/v1/postal-codes/

Example URI

GET /research-sys/api/v1/postal-codes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "code": "(val)",
    "countryCode": "(val)",
    "cityName": "(val)",
    "stateCode": "(val)",
    "countyCode": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "code": "(val)",
    "countryCode": "(val)",
    "cityName": "(val)",
    "stateCode": "(val)",
    "countyCode": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Postal Codes with Filtering
GET/research-sys/api/v1/postal-codes/

Example URI

GET /research-sys/api/v1/postal-codes/
URI Parameters
HideShow
code
string (optional) 

Postal Code either in 5-4 format or just 5 digits. Maximum length is 20.

countryCode
string (optional) 

The code uniquely identify a country. Maximum length is 2.

cityName
string (optional) 

City Name. Maximum length is 30.

stateCode
string (optional) 

Postal State Code. Maximum length is 2.

countyCode
string (optional) 

County Code. Maximum length is 10.

active
string (optional) 

This attribute is used to describe whether the associated object is active or inactive. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "code": "(val)",
    "countryCode": "(val)",
    "cityName": "(val)",
    "stateCode": "(val)",
    "countyCode": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "code": "(val)",
    "countryCode": "(val)",
    "cityName": "(val)",
    "stateCode": "(val)",
    "countyCode": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Postal Codes
GET/research-sys/api/v1/postal-codes/

Example URI

GET /research-sys/api/v1/postal-codes/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "code",
    "countryCode",
    "cityName",
    "stateCode",
    "countyCode",
    "active"
  ],
  "primaryKey": "code:countryCode"
}

Get Blueprint API specification for Postal Codes
GET/research-sys/api/v1/postal-codes/

Example URI

GET /research-sys/api/v1/postal-codes/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Postal Codes.md"
transfer-encoding: chunked

Update Postal Codes
PUT/research-sys/api/v1/postal-codes/(key)

Example URI

PUT /research-sys/api/v1/postal-codes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "code": "(val)",
  "countryCode": "(val)",
  "cityName": "(val)",
  "stateCode": "(val)",
  "countyCode": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Postal Codes
PUT/research-sys/api/v1/postal-codes/

Example URI

PUT /research-sys/api/v1/postal-codes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "code": "(val)",
    "countryCode": "(val)",
    "cityName": "(val)",
    "stateCode": "(val)",
    "countyCode": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "code": "(val)",
    "countryCode": "(val)",
    "cityName": "(val)",
    "stateCode": "(val)",
    "countyCode": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Postal Codes
PATCH/research-sys/api/v1/postal-codes/(key)

Example URI

PATCH /research-sys/api/v1/postal-codes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "code": "(val)",
  "countryCode": "(val)",
  "cityName": "(val)",
  "stateCode": "(val)",
  "countyCode": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "code": "(val)",
  "countryCode": "(val)",
  "cityName": "(val)",
  "stateCode": "(val)",
  "countyCode": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Postal Codes
POST/research-sys/api/v1/postal-codes/

Example URI

POST /research-sys/api/v1/postal-codes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "code": "(val)",
  "countryCode": "(val)",
  "cityName": "(val)",
  "stateCode": "(val)",
  "countyCode": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "code": "(val)",
  "countryCode": "(val)",
  "cityName": "(val)",
  "stateCode": "(val)",
  "countyCode": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Postal Codes
POST/research-sys/api/v1/postal-codes/

Example URI

POST /research-sys/api/v1/postal-codes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "code": "(val)",
    "countryCode": "(val)",
    "cityName": "(val)",
    "stateCode": "(val)",
    "countyCode": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "code": "(val)",
    "countryCode": "(val)",
    "cityName": "(val)",
    "stateCode": "(val)",
    "countyCode": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "code": "(val)",
    "countryCode": "(val)",
    "cityName": "(val)",
    "stateCode": "(val)",
    "countyCode": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "code": "(val)",
    "countryCode": "(val)",
    "cityName": "(val)",
    "stateCode": "(val)",
    "countyCode": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Postal Codes by Key
DELETE/research-sys/api/v1/postal-codes/(key)

Example URI

DELETE /research-sys/api/v1/postal-codes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Postal Codes
DELETE/research-sys/api/v1/postal-codes/

Example URI

DELETE /research-sys/api/v1/postal-codes/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Postal Codes with Matching
DELETE/research-sys/api/v1/postal-codes/

Example URI

DELETE /research-sys/api/v1/postal-codes/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

code
string (optional) 

Postal Code either in 5-4 format or just 5 digits. Maximum length is 20.

countryCode
string (optional) 

The code uniquely identify a country. Maximum length is 2.

cityName
string (optional) 

City Name. Maximum length is 30.

stateCode
string (optional) 

Postal State Code. Maximum length is 2.

countyCode
string (optional) 

County Code. Maximum length is 10.

active
string (optional) 

This attribute is used to describe whether the associated object is active or inactive. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Principals

Get Principals by Key
GET/research-sys/api/v1/principals/(key)

Example URI

GET /research-sys/api/v1/principals/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "principalId": "(val)",
  "principalName": "(val)",
  "entityId": "(val)",
  "password": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Get All Principals
GET/research-sys/api/v1/principals/

Example URI

GET /research-sys/api/v1/principals/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "principalId": "(val)",
    "principalName": "(val)",
    "entityId": "(val)",
    "password": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "principalId": "(val)",
    "principalName": "(val)",
    "entityId": "(val)",
    "password": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Principals with Filtering
GET/research-sys/api/v1/principals/

Example URI

GET /research-sys/api/v1/principals/
URI Parameters
HideShow
principalId
string (optional) 
principalName
string (optional) 
entityId
string (optional) 
password
string (optional) 
active
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "principalId": "(val)",
    "principalName": "(val)",
    "entityId": "(val)",
    "password": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "principalId": "(val)",
    "principalName": "(val)",
    "entityId": "(val)",
    "password": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Principals
GET/research-sys/api/v1/principals/

Example URI

GET /research-sys/api/v1/principals/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "principalId",
    "principalName",
    "entityId",
    "password",
    "active"
  ],
  "primaryKey": "principalId"
}

Get Blueprint API specification for Principals
GET/research-sys/api/v1/principals/

Example URI

GET /research-sys/api/v1/principals/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Principals.md"
transfer-encoding: chunked

Update Principals
PUT/research-sys/api/v1/principals/(key)

Example URI

PUT /research-sys/api/v1/principals/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "principalId": "(val)",
  "principalName": "(val)",
  "entityId": "(val)",
  "password": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Principals
PUT/research-sys/api/v1/principals/

Example URI

PUT /research-sys/api/v1/principals/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "principalId": "(val)",
    "principalName": "(val)",
    "entityId": "(val)",
    "password": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "principalId": "(val)",
    "principalName": "(val)",
    "entityId": "(val)",
    "password": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Principals
PATCH/research-sys/api/v1/principals/(key)

Example URI

PATCH /research-sys/api/v1/principals/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "principalId": "(val)",
  "principalName": "(val)",
  "entityId": "(val)",
  "password": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "principalId": "(val)",
  "principalName": "(val)",
  "entityId": "(val)",
  "password": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Principals
POST/research-sys/api/v1/principals/

Example URI

POST /research-sys/api/v1/principals/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "principalId": "(val)",
  "principalName": "(val)",
  "entityId": "(val)",
  "password": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "principalId": "(val)",
  "principalName": "(val)",
  "entityId": "(val)",
  "password": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Principals
POST/research-sys/api/v1/principals/

Example URI

POST /research-sys/api/v1/principals/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "principalId": "(val)",
    "principalName": "(val)",
    "entityId": "(val)",
    "password": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "principalId": "(val)",
    "principalName": "(val)",
    "entityId": "(val)",
    "password": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "principalId": "(val)",
    "principalName": "(val)",
    "entityId": "(val)",
    "password": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "principalId": "(val)",
    "principalName": "(val)",
    "entityId": "(val)",
    "password": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Principals by Key
DELETE/research-sys/api/v1/principals/(key)

Example URI

DELETE /research-sys/api/v1/principals/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Principals
DELETE/research-sys/api/v1/principals/

Example URI

DELETE /research-sys/api/v1/principals/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Principals with Matching
DELETE/research-sys/api/v1/principals/

Example URI

DELETE /research-sys/api/v1/principals/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

principalId
string (optional) 
principalName
string (optional) 
entityId
string (optional) 
password
string (optional) 
active
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Proposition Parameters

Get Proposition Parameters by Key
GET/research-sys/api/v1/proposition-parameters/(key)

Example URI

GET /research-sys/api/v1/proposition-parameters/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "value": "(val)",
  "parameterType": "(val)",
  "sequenceNumber": "(val)",
  "_primaryKey": "(val)"
}

Get All Proposition Parameters
GET/research-sys/api/v1/proposition-parameters/

Example URI

GET /research-sys/api/v1/proposition-parameters/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "value": "(val)",
    "parameterType": "(val)",
    "sequenceNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "value": "(val)",
    "parameterType": "(val)",
    "sequenceNumber": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Proposition Parameters with Filtering
GET/research-sys/api/v1/proposition-parameters/

Example URI

GET /research-sys/api/v1/proposition-parameters/
URI Parameters
HideShow
id
string (optional) 

Proposition Parameter Id.

value
string (optional) 

Value.

parameterType
string (optional) 

Parameter Type Code.

sequenceNumber
string (optional) 

Sequence Number.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "value": "(val)",
    "parameterType": "(val)",
    "sequenceNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "value": "(val)",
    "parameterType": "(val)",
    "sequenceNumber": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Proposition Parameters
GET/research-sys/api/v1/proposition-parameters/

Example URI

GET /research-sys/api/v1/proposition-parameters/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "value",
    "parameterType",
    "sequenceNumber"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Proposition Parameters
GET/research-sys/api/v1/proposition-parameters/

Example URI

GET /research-sys/api/v1/proposition-parameters/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Proposition Parameters.md"
transfer-encoding: chunked

Update Proposition Parameters
PUT/research-sys/api/v1/proposition-parameters/(key)

Example URI

PUT /research-sys/api/v1/proposition-parameters/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "value": "(val)",
  "parameterType": "(val)",
  "sequenceNumber": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Proposition Parameters
PUT/research-sys/api/v1/proposition-parameters/

Example URI

PUT /research-sys/api/v1/proposition-parameters/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "value": "(val)",
    "parameterType": "(val)",
    "sequenceNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "value": "(val)",
    "parameterType": "(val)",
    "sequenceNumber": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Proposition Parameters
PATCH/research-sys/api/v1/proposition-parameters/(key)

Example URI

PATCH /research-sys/api/v1/proposition-parameters/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "value": "(val)",
  "parameterType": "(val)",
  "sequenceNumber": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "value": "(val)",
  "parameterType": "(val)",
  "sequenceNumber": "(val)",
  "_primaryKey": "(val)"
}

Insert Proposition Parameters
POST/research-sys/api/v1/proposition-parameters/

Example URI

POST /research-sys/api/v1/proposition-parameters/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "value": "(val)",
  "parameterType": "(val)",
  "sequenceNumber": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "value": "(val)",
  "parameterType": "(val)",
  "sequenceNumber": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Proposition Parameters
POST/research-sys/api/v1/proposition-parameters/

Example URI

POST /research-sys/api/v1/proposition-parameters/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "value": "(val)",
    "parameterType": "(val)",
    "sequenceNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "value": "(val)",
    "parameterType": "(val)",
    "sequenceNumber": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "value": "(val)",
    "parameterType": "(val)",
    "sequenceNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "value": "(val)",
    "parameterType": "(val)",
    "sequenceNumber": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Proposition Parameters by Key
DELETE/research-sys/api/v1/proposition-parameters/(key)

Example URI

DELETE /research-sys/api/v1/proposition-parameters/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Proposition Parameters
DELETE/research-sys/api/v1/proposition-parameters/

Example URI

DELETE /research-sys/api/v1/proposition-parameters/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Proposition Parameters with Matching
DELETE/research-sys/api/v1/proposition-parameters/

Example URI

DELETE /research-sys/api/v1/proposition-parameters/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 

Proposition Parameter Id.

value
string (optional) 

Value.

parameterType
string (optional) 

Parameter Type Code.

sequenceNumber
string (optional) 

Sequence Number.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Propositions

Get Propositions by Key
GET/research-sys/api/v1/propositions/(key)

Example URI

GET /research-sys/api/v1/propositions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "description": "(val)",
  "ruleId": "(val)",
  "typeId": "(val)",
  "propositionTypeCode": "(val)",
  "compoundOpCode": "(val)",
  "compoundSequenceNumber": "(val)",
  "_primaryKey": "(val)"
}

Get All Propositions
GET/research-sys/api/v1/propositions/

Example URI

GET /research-sys/api/v1/propositions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "description": "(val)",
    "ruleId": "(val)",
    "typeId": "(val)",
    "propositionTypeCode": "(val)",
    "compoundOpCode": "(val)",
    "compoundSequenceNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "description": "(val)",
    "ruleId": "(val)",
    "typeId": "(val)",
    "propositionTypeCode": "(val)",
    "compoundOpCode": "(val)",
    "compoundSequenceNumber": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Propositions with Filtering
GET/research-sys/api/v1/propositions/

Example URI

GET /research-sys/api/v1/propositions/
URI Parameters
HideShow
id
string (optional) 

Proposition Id.

description
string (optional) 

Description.

ruleId
string (optional) 

Rule Id.

typeId
string (optional) 

Proposition Type Id.

propositionTypeCode
string (optional) 

Proposition Type Code.

compoundOpCode
string (optional) 

Compound Op Code.

compoundSequenceNumber
string (optional) 

Compound Sequence Number.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "description": "(val)",
    "ruleId": "(val)",
    "typeId": "(val)",
    "propositionTypeCode": "(val)",
    "compoundOpCode": "(val)",
    "compoundSequenceNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "description": "(val)",
    "ruleId": "(val)",
    "typeId": "(val)",
    "propositionTypeCode": "(val)",
    "compoundOpCode": "(val)",
    "compoundSequenceNumber": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Propositions
GET/research-sys/api/v1/propositions/

Example URI

GET /research-sys/api/v1/propositions/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "description",
    "ruleId",
    "typeId",
    "propositionTypeCode",
    "compoundOpCode",
    "compoundSequenceNumber"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Propositions
GET/research-sys/api/v1/propositions/

Example URI

GET /research-sys/api/v1/propositions/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Propositions.md"
transfer-encoding: chunked

Update Propositions
PUT/research-sys/api/v1/propositions/(key)

Example URI

PUT /research-sys/api/v1/propositions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "description": "(val)",
  "ruleId": "(val)",
  "typeId": "(val)",
  "propositionTypeCode": "(val)",
  "compoundOpCode": "(val)",
  "compoundSequenceNumber": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Propositions
PUT/research-sys/api/v1/propositions/

Example URI

PUT /research-sys/api/v1/propositions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "description": "(val)",
    "ruleId": "(val)",
    "typeId": "(val)",
    "propositionTypeCode": "(val)",
    "compoundOpCode": "(val)",
    "compoundSequenceNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "description": "(val)",
    "ruleId": "(val)",
    "typeId": "(val)",
    "propositionTypeCode": "(val)",
    "compoundOpCode": "(val)",
    "compoundSequenceNumber": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Propositions
PATCH/research-sys/api/v1/propositions/(key)

Example URI

PATCH /research-sys/api/v1/propositions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "description": "(val)",
  "ruleId": "(val)",
  "typeId": "(val)",
  "propositionTypeCode": "(val)",
  "compoundOpCode": "(val)",
  "compoundSequenceNumber": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "description": "(val)",
  "ruleId": "(val)",
  "typeId": "(val)",
  "propositionTypeCode": "(val)",
  "compoundOpCode": "(val)",
  "compoundSequenceNumber": "(val)",
  "_primaryKey": "(val)"
}

Insert Propositions
POST/research-sys/api/v1/propositions/

Example URI

POST /research-sys/api/v1/propositions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "description": "(val)",
  "ruleId": "(val)",
  "typeId": "(val)",
  "propositionTypeCode": "(val)",
  "compoundOpCode": "(val)",
  "compoundSequenceNumber": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "description": "(val)",
  "ruleId": "(val)",
  "typeId": "(val)",
  "propositionTypeCode": "(val)",
  "compoundOpCode": "(val)",
  "compoundSequenceNumber": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Propositions
POST/research-sys/api/v1/propositions/

Example URI

POST /research-sys/api/v1/propositions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "description": "(val)",
    "ruleId": "(val)",
    "typeId": "(val)",
    "propositionTypeCode": "(val)",
    "compoundOpCode": "(val)",
    "compoundSequenceNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "description": "(val)",
    "ruleId": "(val)",
    "typeId": "(val)",
    "propositionTypeCode": "(val)",
    "compoundOpCode": "(val)",
    "compoundSequenceNumber": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "description": "(val)",
    "ruleId": "(val)",
    "typeId": "(val)",
    "propositionTypeCode": "(val)",
    "compoundOpCode": "(val)",
    "compoundSequenceNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "description": "(val)",
    "ruleId": "(val)",
    "typeId": "(val)",
    "propositionTypeCode": "(val)",
    "compoundOpCode": "(val)",
    "compoundSequenceNumber": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Propositions by Key
DELETE/research-sys/api/v1/propositions/(key)

Example URI

DELETE /research-sys/api/v1/propositions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Propositions
DELETE/research-sys/api/v1/propositions/

Example URI

DELETE /research-sys/api/v1/propositions/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Propositions with Matching
DELETE/research-sys/api/v1/propositions/

Example URI

DELETE /research-sys/api/v1/propositions/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 

Proposition Id.

description
string (optional) 

Description.

ruleId
string (optional) 

Rule Id.

typeId
string (optional) 

Proposition Type Id.

propositionTypeCode
string (optional) 

Proposition Type Code.

compoundOpCode
string (optional) 

Compound Op Code.

compoundSequenceNumber
string (optional) 

Compound Sequence Number.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Recipient Deliverer Configs

Get Recipient Deliverer Configs by Key
GET/research-sys/api/v1/recipient-deliverer-configs/(key)

Example URI

GET /research-sys/api/v1/recipient-deliverer-configs/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "recipientId": "(val)",
  "delivererName": "(val)",
  "channel": "(val)",
  "lockVerNbr": "(val)",
  "_primaryKey": "(val)"
}

Get All Recipient Deliverer Configs
GET/research-sys/api/v1/recipient-deliverer-configs/

Example URI

GET /research-sys/api/v1/recipient-deliverer-configs/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "recipientId": "(val)",
    "delivererName": "(val)",
    "channel": "(val)",
    "lockVerNbr": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "recipientId": "(val)",
    "delivererName": "(val)",
    "channel": "(val)",
    "lockVerNbr": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Recipient Deliverer Configs with Filtering
GET/research-sys/api/v1/recipient-deliverer-configs/

Example URI

GET /research-sys/api/v1/recipient-deliverer-configs/
URI Parameters
HideShow
id
string (optional) 
recipientId
string (optional) 
delivererName
string (optional) 
channel
string (optional) 
lockVerNbr
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "recipientId": "(val)",
    "delivererName": "(val)",
    "channel": "(val)",
    "lockVerNbr": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "recipientId": "(val)",
    "delivererName": "(val)",
    "channel": "(val)",
    "lockVerNbr": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Recipient Deliverer Configs
GET/research-sys/api/v1/recipient-deliverer-configs/

Example URI

GET /research-sys/api/v1/recipient-deliverer-configs/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "recipientId",
    "delivererName",
    "channel",
    "lockVerNbr"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Recipient Deliverer Configs
GET/research-sys/api/v1/recipient-deliverer-configs/

Example URI

GET /research-sys/api/v1/recipient-deliverer-configs/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Recipient Deliverer Configs.md"
transfer-encoding: chunked

Update Recipient Deliverer Configs
PUT/research-sys/api/v1/recipient-deliverer-configs/(key)

Example URI

PUT /research-sys/api/v1/recipient-deliverer-configs/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "recipientId": "(val)",
  "delivererName": "(val)",
  "channel": "(val)",
  "lockVerNbr": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Recipient Deliverer Configs
PUT/research-sys/api/v1/recipient-deliverer-configs/

Example URI

PUT /research-sys/api/v1/recipient-deliverer-configs/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "recipientId": "(val)",
    "delivererName": "(val)",
    "channel": "(val)",
    "lockVerNbr": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "recipientId": "(val)",
    "delivererName": "(val)",
    "channel": "(val)",
    "lockVerNbr": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Recipient Deliverer Configs
PATCH/research-sys/api/v1/recipient-deliverer-configs/(key)

Example URI

PATCH /research-sys/api/v1/recipient-deliverer-configs/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "recipientId": "(val)",
  "delivererName": "(val)",
  "channel": "(val)",
  "lockVerNbr": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "recipientId": "(val)",
  "delivererName": "(val)",
  "channel": "(val)",
  "lockVerNbr": "(val)",
  "_primaryKey": "(val)"
}

Insert Recipient Deliverer Configs
POST/research-sys/api/v1/recipient-deliverer-configs/

Example URI

POST /research-sys/api/v1/recipient-deliverer-configs/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "recipientId": "(val)",
  "delivererName": "(val)",
  "channel": "(val)",
  "lockVerNbr": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "recipientId": "(val)",
  "delivererName": "(val)",
  "channel": "(val)",
  "lockVerNbr": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Recipient Deliverer Configs
POST/research-sys/api/v1/recipient-deliverer-configs/

Example URI

POST /research-sys/api/v1/recipient-deliverer-configs/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "recipientId": "(val)",
    "delivererName": "(val)",
    "channel": "(val)",
    "lockVerNbr": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "recipientId": "(val)",
    "delivererName": "(val)",
    "channel": "(val)",
    "lockVerNbr": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "recipientId": "(val)",
    "delivererName": "(val)",
    "channel": "(val)",
    "lockVerNbr": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "recipientId": "(val)",
    "delivererName": "(val)",
    "channel": "(val)",
    "lockVerNbr": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Recipient Deliverer Configs by Key
DELETE/research-sys/api/v1/recipient-deliverer-configs/(key)

Example URI

DELETE /research-sys/api/v1/recipient-deliverer-configs/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Recipient Deliverer Configs
DELETE/research-sys/api/v1/recipient-deliverer-configs/

Example URI

DELETE /research-sys/api/v1/recipient-deliverer-configs/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Recipient Deliverer Configs with Matching
DELETE/research-sys/api/v1/recipient-deliverer-configs/

Example URI

DELETE /research-sys/api/v1/recipient-deliverer-configs/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 
recipientId
string (optional) 
delivererName
string (optional) 
channel
string (optional) 
lockVerNbr
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Recipient Preferences

Get Recipient Preferences by Key
GET/research-sys/api/v1/recipient-preferences/(key)

Example URI

GET /research-sys/api/v1/recipient-preferences/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "recipientId": "(val)",
  "property": "(val)",
  "value": "(val)",
  "lockVerNbr": "(val)",
  "_primaryKey": "(val)"
}

Get All Recipient Preferences
GET/research-sys/api/v1/recipient-preferences/

Example URI

GET /research-sys/api/v1/recipient-preferences/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "recipientId": "(val)",
    "property": "(val)",
    "value": "(val)",
    "lockVerNbr": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "recipientId": "(val)",
    "property": "(val)",
    "value": "(val)",
    "lockVerNbr": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Recipient Preferences with Filtering
GET/research-sys/api/v1/recipient-preferences/

Example URI

GET /research-sys/api/v1/recipient-preferences/
URI Parameters
HideShow
id
string (optional) 
recipientId
string (optional) 
property
string (optional) 
value
string (optional) 
lockVerNbr
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "recipientId": "(val)",
    "property": "(val)",
    "value": "(val)",
    "lockVerNbr": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "recipientId": "(val)",
    "property": "(val)",
    "value": "(val)",
    "lockVerNbr": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Recipient Preferences
GET/research-sys/api/v1/recipient-preferences/

Example URI

GET /research-sys/api/v1/recipient-preferences/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "recipientId",
    "property",
    "value",
    "lockVerNbr"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Recipient Preferences
GET/research-sys/api/v1/recipient-preferences/

Example URI

GET /research-sys/api/v1/recipient-preferences/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Recipient Preferences.md"
transfer-encoding: chunked

Update Recipient Preferences
PUT/research-sys/api/v1/recipient-preferences/(key)

Example URI

PUT /research-sys/api/v1/recipient-preferences/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "recipientId": "(val)",
  "property": "(val)",
  "value": "(val)",
  "lockVerNbr": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Recipient Preferences
PUT/research-sys/api/v1/recipient-preferences/

Example URI

PUT /research-sys/api/v1/recipient-preferences/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "recipientId": "(val)",
    "property": "(val)",
    "value": "(val)",
    "lockVerNbr": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "recipientId": "(val)",
    "property": "(val)",
    "value": "(val)",
    "lockVerNbr": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Recipient Preferences
PATCH/research-sys/api/v1/recipient-preferences/(key)

Example URI

PATCH /research-sys/api/v1/recipient-preferences/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "recipientId": "(val)",
  "property": "(val)",
  "value": "(val)",
  "lockVerNbr": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "recipientId": "(val)",
  "property": "(val)",
  "value": "(val)",
  "lockVerNbr": "(val)",
  "_primaryKey": "(val)"
}

Insert Recipient Preferences
POST/research-sys/api/v1/recipient-preferences/

Example URI

POST /research-sys/api/v1/recipient-preferences/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "recipientId": "(val)",
  "property": "(val)",
  "value": "(val)",
  "lockVerNbr": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "recipientId": "(val)",
  "property": "(val)",
  "value": "(val)",
  "lockVerNbr": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Recipient Preferences
POST/research-sys/api/v1/recipient-preferences/

Example URI

POST /research-sys/api/v1/recipient-preferences/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "recipientId": "(val)",
    "property": "(val)",
    "value": "(val)",
    "lockVerNbr": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "recipientId": "(val)",
    "property": "(val)",
    "value": "(val)",
    "lockVerNbr": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "recipientId": "(val)",
    "property": "(val)",
    "value": "(val)",
    "lockVerNbr": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "recipientId": "(val)",
    "property": "(val)",
    "value": "(val)",
    "lockVerNbr": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Recipient Preferences by Key
DELETE/research-sys/api/v1/recipient-preferences/(key)

Example URI

DELETE /research-sys/api/v1/recipient-preferences/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Recipient Preferences
DELETE/research-sys/api/v1/recipient-preferences/

Example URI

DELETE /research-sys/api/v1/recipient-preferences/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Recipient Preferences with Matching
DELETE/research-sys/api/v1/recipient-preferences/

Example URI

DELETE /research-sys/api/v1/recipient-preferences/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 
recipientId
string (optional) 
property
string (optional) 
value
string (optional) 
lockVerNbr
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Responsibilities

Get Responsibilities by Key
GET/research-sys/api/v1/responsibilities/(key)

Example URI

GET /research-sys/api/v1/responsibilities/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "namespaceCode": "(val)",
  "name": "(val)",
  "description": "(val)",
  "templateId": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Get All Responsibilities
GET/research-sys/api/v1/responsibilities/

Example URI

GET /research-sys/api/v1/responsibilities/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "namespaceCode": "(val)",
    "name": "(val)",
    "description": "(val)",
    "templateId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "namespaceCode": "(val)",
    "name": "(val)",
    "description": "(val)",
    "templateId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Responsibilities with Filtering
GET/research-sys/api/v1/responsibilities/

Example URI

GET /research-sys/api/v1/responsibilities/
URI Parameters
HideShow
id
string (optional) 

Responsibility Identifier. Maximum length is 40.

namespaceCode
string (optional) 

This value is used to categorize parameters by namespace. Maximum length is 20.

name
string (optional) 

Nm. Maximum length is 100.

description
string (optional) 

Description.

templateId
string (optional) 

Template Id. Maximum length is 40.

active
string (optional) 

This attribute is used to describe whether the associated object is active or inactive. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "namespaceCode": "(val)",
    "name": "(val)",
    "description": "(val)",
    "templateId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "namespaceCode": "(val)",
    "name": "(val)",
    "description": "(val)",
    "templateId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Responsibilities
GET/research-sys/api/v1/responsibilities/

Example URI

GET /research-sys/api/v1/responsibilities/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "namespaceCode",
    "name",
    "description",
    "templateId",
    "active"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Responsibilities
GET/research-sys/api/v1/responsibilities/

Example URI

GET /research-sys/api/v1/responsibilities/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Responsibilities.md"
transfer-encoding: chunked

Update Responsibilities
PUT/research-sys/api/v1/responsibilities/(key)

Example URI

PUT /research-sys/api/v1/responsibilities/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "namespaceCode": "(val)",
  "name": "(val)",
  "description": "(val)",
  "templateId": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Responsibilities
PUT/research-sys/api/v1/responsibilities/

Example URI

PUT /research-sys/api/v1/responsibilities/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "namespaceCode": "(val)",
    "name": "(val)",
    "description": "(val)",
    "templateId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "namespaceCode": "(val)",
    "name": "(val)",
    "description": "(val)",
    "templateId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Responsibilities
PATCH/research-sys/api/v1/responsibilities/(key)

Example URI

PATCH /research-sys/api/v1/responsibilities/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "namespaceCode": "(val)",
  "name": "(val)",
  "description": "(val)",
  "templateId": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "namespaceCode": "(val)",
  "name": "(val)",
  "description": "(val)",
  "templateId": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Responsibilities
POST/research-sys/api/v1/responsibilities/

Example URI

POST /research-sys/api/v1/responsibilities/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "namespaceCode": "(val)",
  "name": "(val)",
  "description": "(val)",
  "templateId": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "namespaceCode": "(val)",
  "name": "(val)",
  "description": "(val)",
  "templateId": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Responsibilities
POST/research-sys/api/v1/responsibilities/

Example URI

POST /research-sys/api/v1/responsibilities/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "namespaceCode": "(val)",
    "name": "(val)",
    "description": "(val)",
    "templateId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "namespaceCode": "(val)",
    "name": "(val)",
    "description": "(val)",
    "templateId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "namespaceCode": "(val)",
    "name": "(val)",
    "description": "(val)",
    "templateId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "namespaceCode": "(val)",
    "name": "(val)",
    "description": "(val)",
    "templateId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Responsibilities by Key
DELETE/research-sys/api/v1/responsibilities/(key)

Example URI

DELETE /research-sys/api/v1/responsibilities/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Responsibilities
DELETE/research-sys/api/v1/responsibilities/

Example URI

DELETE /research-sys/api/v1/responsibilities/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Responsibilities with Matching
DELETE/research-sys/api/v1/responsibilities/

Example URI

DELETE /research-sys/api/v1/responsibilities/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 

Responsibility Identifier. Maximum length is 40.

namespaceCode
string (optional) 

This value is used to categorize parameters by namespace. Maximum length is 20.

name
string (optional) 

Nm. Maximum length is 100.

description
string (optional) 

Description.

templateId
string (optional) 

Template Id. Maximum length is 40.

active
string (optional) 

This attribute is used to describe whether the associated object is active or inactive. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Responsibility Attributes

Get Responsibility Attributes by Key
GET/research-sys/api/v1/responsibility-attributes/(key)

Example URI

GET /research-sys/api/v1/responsibility-attributes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "assignedToId": "(val)",
  "attributeValue": "(val)",
  "kimTypeId": "(val)",
  "kimAttributeId": "(val)",
  "_primaryKey": "(val)"
}

Get All Responsibility Attributes
GET/research-sys/api/v1/responsibility-attributes/

Example URI

GET /research-sys/api/v1/responsibility-attributes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "assignedToId": "(val)",
    "attributeValue": "(val)",
    "kimTypeId": "(val)",
    "kimAttributeId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "assignedToId": "(val)",
    "attributeValue": "(val)",
    "kimTypeId": "(val)",
    "kimAttributeId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Responsibility Attributes with Filtering
GET/research-sys/api/v1/responsibility-attributes/

Example URI

GET /research-sys/api/v1/responsibility-attributes/
URI Parameters
HideShow
id
string (optional) 

Id.

assignedToId
string (optional) 

Assigned To Id.

attributeValue
string (optional) 

Attribute Value. Maximum length is 40.

kimTypeId
string (optional) 

Kim Type Id.

kimAttributeId
string (optional) 

Attribute Id. Maximum length is 40.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "assignedToId": "(val)",
    "attributeValue": "(val)",
    "kimTypeId": "(val)",
    "kimAttributeId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "assignedToId": "(val)",
    "attributeValue": "(val)",
    "kimTypeId": "(val)",
    "kimAttributeId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Responsibility Attributes
GET/research-sys/api/v1/responsibility-attributes/

Example URI

GET /research-sys/api/v1/responsibility-attributes/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "assignedToId",
    "attributeValue",
    "kimTypeId",
    "kimAttributeId"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Responsibility Attributes
GET/research-sys/api/v1/responsibility-attributes/

Example URI

GET /research-sys/api/v1/responsibility-attributes/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Responsibility Attributes.md"
transfer-encoding: chunked

Update Responsibility Attributes
PUT/research-sys/api/v1/responsibility-attributes/(key)

Example URI

PUT /research-sys/api/v1/responsibility-attributes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "assignedToId": "(val)",
  "attributeValue": "(val)",
  "kimTypeId": "(val)",
  "kimAttributeId": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Responsibility Attributes
PUT/research-sys/api/v1/responsibility-attributes/

Example URI

PUT /research-sys/api/v1/responsibility-attributes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "assignedToId": "(val)",
    "attributeValue": "(val)",
    "kimTypeId": "(val)",
    "kimAttributeId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "assignedToId": "(val)",
    "attributeValue": "(val)",
    "kimTypeId": "(val)",
    "kimAttributeId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Responsibility Attributes
PATCH/research-sys/api/v1/responsibility-attributes/(key)

Example URI

PATCH /research-sys/api/v1/responsibility-attributes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "assignedToId": "(val)",
  "attributeValue": "(val)",
  "kimTypeId": "(val)",
  "kimAttributeId": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "assignedToId": "(val)",
  "attributeValue": "(val)",
  "kimTypeId": "(val)",
  "kimAttributeId": "(val)",
  "_primaryKey": "(val)"
}

Insert Responsibility Attributes
POST/research-sys/api/v1/responsibility-attributes/

Example URI

POST /research-sys/api/v1/responsibility-attributes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "assignedToId": "(val)",
  "attributeValue": "(val)",
  "kimTypeId": "(val)",
  "kimAttributeId": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "assignedToId": "(val)",
  "attributeValue": "(val)",
  "kimTypeId": "(val)",
  "kimAttributeId": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Responsibility Attributes
POST/research-sys/api/v1/responsibility-attributes/

Example URI

POST /research-sys/api/v1/responsibility-attributes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "assignedToId": "(val)",
    "attributeValue": "(val)",
    "kimTypeId": "(val)",
    "kimAttributeId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "assignedToId": "(val)",
    "attributeValue": "(val)",
    "kimTypeId": "(val)",
    "kimAttributeId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "assignedToId": "(val)",
    "attributeValue": "(val)",
    "kimTypeId": "(val)",
    "kimAttributeId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "assignedToId": "(val)",
    "attributeValue": "(val)",
    "kimTypeId": "(val)",
    "kimAttributeId": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Responsibility Attributes by Key
DELETE/research-sys/api/v1/responsibility-attributes/(key)

Example URI

DELETE /research-sys/api/v1/responsibility-attributes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Responsibility Attributes
DELETE/research-sys/api/v1/responsibility-attributes/

Example URI

DELETE /research-sys/api/v1/responsibility-attributes/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Responsibility Attributes with Matching
DELETE/research-sys/api/v1/responsibility-attributes/

Example URI

DELETE /research-sys/api/v1/responsibility-attributes/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 

Id.

assignedToId
string (optional) 

Assigned To Id.

attributeValue
string (optional) 

Attribute Value. Maximum length is 40.

kimTypeId
string (optional) 

Kim Type Id.

kimAttributeId
string (optional) 

Attribute Id. Maximum length is 40.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Responsibility Templates

Get Responsibility Templates by Key
GET/research-sys/api/v1/responsibility-templates/(key)

Example URI

GET /research-sys/api/v1/responsibility-templates/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "kimTypeId": "(val)",
  "name": "(val)",
  "active": "(val)",
  "description": "(val)",
  "namespaceCode": "(val)",
  "_primaryKey": "(val)"
}

Get All Responsibility Templates
GET/research-sys/api/v1/responsibility-templates/

Example URI

GET /research-sys/api/v1/responsibility-templates/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "kimTypeId": "(val)",
    "name": "(val)",
    "active": "(val)",
    "description": "(val)",
    "namespaceCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "kimTypeId": "(val)",
    "name": "(val)",
    "active": "(val)",
    "description": "(val)",
    "namespaceCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Responsibility Templates with Filtering
GET/research-sys/api/v1/responsibility-templates/

Example URI

GET /research-sys/api/v1/responsibility-templates/
URI Parameters
HideShow
id
string (optional) 

Template Id. Maximum length is 40.

kimTypeId
string (optional) 

Kim Type Id.

name
string (optional) 

Template Name. Maximum length is 40.

active
string (optional) 

Active.

description
string (optional) 

Responsibility Template Description. Maximum length is 40.

namespaceCode
string (optional) 

Nmspc Cd. Maximum length is 40.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "kimTypeId": "(val)",
    "name": "(val)",
    "active": "(val)",
    "description": "(val)",
    "namespaceCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "kimTypeId": "(val)",
    "name": "(val)",
    "active": "(val)",
    "description": "(val)",
    "namespaceCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Responsibility Templates
GET/research-sys/api/v1/responsibility-templates/

Example URI

GET /research-sys/api/v1/responsibility-templates/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "kimTypeId",
    "name",
    "active",
    "description",
    "namespaceCode"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Responsibility Templates
GET/research-sys/api/v1/responsibility-templates/

Example URI

GET /research-sys/api/v1/responsibility-templates/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Responsibility Templates.md"
transfer-encoding: chunked

Update Responsibility Templates
PUT/research-sys/api/v1/responsibility-templates/(key)

Example URI

PUT /research-sys/api/v1/responsibility-templates/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "kimTypeId": "(val)",
  "name": "(val)",
  "active": "(val)",
  "description": "(val)",
  "namespaceCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Responsibility Templates
PUT/research-sys/api/v1/responsibility-templates/

Example URI

PUT /research-sys/api/v1/responsibility-templates/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "kimTypeId": "(val)",
    "name": "(val)",
    "active": "(val)",
    "description": "(val)",
    "namespaceCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "kimTypeId": "(val)",
    "name": "(val)",
    "active": "(val)",
    "description": "(val)",
    "namespaceCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Responsibility Templates
PATCH/research-sys/api/v1/responsibility-templates/(key)

Example URI

PATCH /research-sys/api/v1/responsibility-templates/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "kimTypeId": "(val)",
  "name": "(val)",
  "active": "(val)",
  "description": "(val)",
  "namespaceCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "kimTypeId": "(val)",
  "name": "(val)",
  "active": "(val)",
  "description": "(val)",
  "namespaceCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Responsibility Templates
POST/research-sys/api/v1/responsibility-templates/

Example URI

POST /research-sys/api/v1/responsibility-templates/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "kimTypeId": "(val)",
  "name": "(val)",
  "active": "(val)",
  "description": "(val)",
  "namespaceCode": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "kimTypeId": "(val)",
  "name": "(val)",
  "active": "(val)",
  "description": "(val)",
  "namespaceCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Responsibility Templates
POST/research-sys/api/v1/responsibility-templates/

Example URI

POST /research-sys/api/v1/responsibility-templates/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "kimTypeId": "(val)",
    "name": "(val)",
    "active": "(val)",
    "description": "(val)",
    "namespaceCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "kimTypeId": "(val)",
    "name": "(val)",
    "active": "(val)",
    "description": "(val)",
    "namespaceCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "kimTypeId": "(val)",
    "name": "(val)",
    "active": "(val)",
    "description": "(val)",
    "namespaceCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "kimTypeId": "(val)",
    "name": "(val)",
    "active": "(val)",
    "description": "(val)",
    "namespaceCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Responsibility Templates by Key
DELETE/research-sys/api/v1/responsibility-templates/(key)

Example URI

DELETE /research-sys/api/v1/responsibility-templates/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Responsibility Templates
DELETE/research-sys/api/v1/responsibility-templates/

Example URI

DELETE /research-sys/api/v1/responsibility-templates/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Responsibility Templates with Matching
DELETE/research-sys/api/v1/responsibility-templates/

Example URI

DELETE /research-sys/api/v1/responsibility-templates/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 

Template Id. Maximum length is 40.

kimTypeId
string (optional) 

Kim Type Id.

name
string (optional) 

Template Name. Maximum length is 40.

active
string (optional) 

Active.

description
string (optional) 

Responsibility Template Description. Maximum length is 40.

namespaceCode
string (optional) 

Nmspc Cd. Maximum length is 40.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Review Responsibilities

Get Review Responsibilities by Key
GET/research-sys/api/v1/review-responsibilities/(key)

Example URI

GET /research-sys/api/v1/review-responsibilities/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "namespaceCode": "(val)",
  "name": "(val)",
  "description": "(val)",
  "templateId": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Get All Review Responsibilities
GET/research-sys/api/v1/review-responsibilities/

Example URI

GET /research-sys/api/v1/review-responsibilities/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "namespaceCode": "(val)",
    "name": "(val)",
    "description": "(val)",
    "templateId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "namespaceCode": "(val)",
    "name": "(val)",
    "description": "(val)",
    "templateId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Review Responsibilities with Filtering
GET/research-sys/api/v1/review-responsibilities/

Example URI

GET /research-sys/api/v1/review-responsibilities/
URI Parameters
HideShow
id
string (optional) 

Responsibility Identifier. Maximum length is 10.

namespaceCode
string (optional) 

Code identifying the namespace. Maximum length is 20.

name
string (optional) 

Nm. Maximum length is 100.

description
string (optional) 

This attribute should always be overriden on the descriptive elements. Maximum length is 400.

templateId
string (optional) 

Template Id.

active
string (optional) 

This attribute is used to describe whether the associated object is active or inactive. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "namespaceCode": "(val)",
    "name": "(val)",
    "description": "(val)",
    "templateId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "namespaceCode": "(val)",
    "name": "(val)",
    "description": "(val)",
    "templateId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Review Responsibilities
GET/research-sys/api/v1/review-responsibilities/

Example URI

GET /research-sys/api/v1/review-responsibilities/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "namespaceCode",
    "name",
    "description",
    "templateId",
    "active"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Review Responsibilities
GET/research-sys/api/v1/review-responsibilities/

Example URI

GET /research-sys/api/v1/review-responsibilities/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Review Responsibilities.md"
transfer-encoding: chunked

Update Review Responsibilities
PUT/research-sys/api/v1/review-responsibilities/(key)

Example URI

PUT /research-sys/api/v1/review-responsibilities/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "namespaceCode": "(val)",
  "name": "(val)",
  "description": "(val)",
  "templateId": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Review Responsibilities
PUT/research-sys/api/v1/review-responsibilities/

Example URI

PUT /research-sys/api/v1/review-responsibilities/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "namespaceCode": "(val)",
    "name": "(val)",
    "description": "(val)",
    "templateId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "namespaceCode": "(val)",
    "name": "(val)",
    "description": "(val)",
    "templateId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Review Responsibilities
PATCH/research-sys/api/v1/review-responsibilities/(key)

Example URI

PATCH /research-sys/api/v1/review-responsibilities/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "namespaceCode": "(val)",
  "name": "(val)",
  "description": "(val)",
  "templateId": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "namespaceCode": "(val)",
  "name": "(val)",
  "description": "(val)",
  "templateId": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Review Responsibilities
POST/research-sys/api/v1/review-responsibilities/

Example URI

POST /research-sys/api/v1/review-responsibilities/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "namespaceCode": "(val)",
  "name": "(val)",
  "description": "(val)",
  "templateId": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "namespaceCode": "(val)",
  "name": "(val)",
  "description": "(val)",
  "templateId": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Review Responsibilities
POST/research-sys/api/v1/review-responsibilities/

Example URI

POST /research-sys/api/v1/review-responsibilities/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "namespaceCode": "(val)",
    "name": "(val)",
    "description": "(val)",
    "templateId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "namespaceCode": "(val)",
    "name": "(val)",
    "description": "(val)",
    "templateId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "namespaceCode": "(val)",
    "name": "(val)",
    "description": "(val)",
    "templateId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "namespaceCode": "(val)",
    "name": "(val)",
    "description": "(val)",
    "templateId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Review Responsibilities by Key
DELETE/research-sys/api/v1/review-responsibilities/(key)

Example URI

DELETE /research-sys/api/v1/review-responsibilities/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Review Responsibilities
DELETE/research-sys/api/v1/review-responsibilities/

Example URI

DELETE /research-sys/api/v1/review-responsibilities/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Review Responsibilities with Matching
DELETE/research-sys/api/v1/review-responsibilities/

Example URI

DELETE /research-sys/api/v1/review-responsibilities/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 

Responsibility Identifier. Maximum length is 10.

namespaceCode
string (optional) 

Code identifying the namespace. Maximum length is 20.

name
string (optional) 

Nm. Maximum length is 100.

description
string (optional) 

This attribute should always be overriden on the descriptive elements. Maximum length is 400.

templateId
string (optional) 

Template Id.

active
string (optional) 

This attribute is used to describe whether the associated object is active or inactive. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Role Document Delegation Member Qualifiers

Get Role Document Delegation Member Qualifiers by Key
GET/research-sys/api/v1/role-document-delegation-member-qualifiers/(key)

Example URI

GET /research-sys/api/v1/role-document-delegation-member-qualifiers/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "delegationMemberId": "(val)",
  "kimTypId": "(val)",
  "kimAttrDefnId": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "attrVal": "(val)",
  "active": "(val)",
  "attrDataId": "(val)",
  "_primaryKey": "(val)"
}

Get All Role Document Delegation Member Qualifiers
GET/research-sys/api/v1/role-document-delegation-member-qualifiers/

Example URI

GET /research-sys/api/v1/role-document-delegation-member-qualifiers/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "delegationMemberId": "(val)",
    "kimTypId": "(val)",
    "kimAttrDefnId": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "attrVal": "(val)",
    "active": "(val)",
    "attrDataId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "delegationMemberId": "(val)",
    "kimTypId": "(val)",
    "kimAttrDefnId": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "attrVal": "(val)",
    "active": "(val)",
    "attrDataId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Role Document Delegation Member Qualifiers with Filtering
GET/research-sys/api/v1/role-document-delegation-member-qualifiers/

Example URI

GET /research-sys/api/v1/role-document-delegation-member-qualifiers/
URI Parameters
HideShow
delegationMemberId
string (optional) 

Target Primary Key. Maximum length is 40.

kimTypId
string (optional) 

Kim Typ Id. Maximum length is 40.

kimAttrDefnId
string (optional) 

Kim Attr Defn Id. Maximum length is 40.

edit
string (optional) 

Edit.

documentNumber
string (optional) 

Document Number.

attrVal
string (optional) 

Attr Val. Maximum length is 400.

active
string (optional) 

Active.

attrDataId
string (optional) 

Attr Data Id. Maximum length is 40.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "delegationMemberId": "(val)",
    "kimTypId": "(val)",
    "kimAttrDefnId": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "attrVal": "(val)",
    "active": "(val)",
    "attrDataId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "delegationMemberId": "(val)",
    "kimTypId": "(val)",
    "kimAttrDefnId": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "attrVal": "(val)",
    "active": "(val)",
    "attrDataId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Role Document Delegation Member Qualifiers
GET/research-sys/api/v1/role-document-delegation-member-qualifiers/

Example URI

GET /research-sys/api/v1/role-document-delegation-member-qualifiers/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "delegationMemberId",
    "kimTypId",
    "kimAttrDefnId",
    "edit",
    "documentNumber",
    "attrVal",
    "active",
    "attrDataId"
  ],
  "primaryKey": "attrDataId"
}

Get Blueprint API specification for Role Document Delegation Member Qualifiers
GET/research-sys/api/v1/role-document-delegation-member-qualifiers/

Example URI

GET /research-sys/api/v1/role-document-delegation-member-qualifiers/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Role Document Delegation Member Qualifiers.md"
transfer-encoding: chunked

Update Role Document Delegation Member Qualifiers
PUT/research-sys/api/v1/role-document-delegation-member-qualifiers/(key)

Example URI

PUT /research-sys/api/v1/role-document-delegation-member-qualifiers/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "delegationMemberId": "(val)",
  "kimTypId": "(val)",
  "kimAttrDefnId": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "attrVal": "(val)",
  "active": "(val)",
  "attrDataId": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Role Document Delegation Member Qualifiers
PUT/research-sys/api/v1/role-document-delegation-member-qualifiers/

Example URI

PUT /research-sys/api/v1/role-document-delegation-member-qualifiers/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "delegationMemberId": "(val)",
    "kimTypId": "(val)",
    "kimAttrDefnId": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "attrVal": "(val)",
    "active": "(val)",
    "attrDataId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "delegationMemberId": "(val)",
    "kimTypId": "(val)",
    "kimAttrDefnId": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "attrVal": "(val)",
    "active": "(val)",
    "attrDataId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Role Document Delegation Member Qualifiers
PATCH/research-sys/api/v1/role-document-delegation-member-qualifiers/(key)

Example URI

PATCH /research-sys/api/v1/role-document-delegation-member-qualifiers/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "delegationMemberId": "(val)",
  "kimTypId": "(val)",
  "kimAttrDefnId": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "attrVal": "(val)",
  "active": "(val)",
  "attrDataId": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "delegationMemberId": "(val)",
  "kimTypId": "(val)",
  "kimAttrDefnId": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "attrVal": "(val)",
  "active": "(val)",
  "attrDataId": "(val)",
  "_primaryKey": "(val)"
}

Insert Role Document Delegation Member Qualifiers
POST/research-sys/api/v1/role-document-delegation-member-qualifiers/

Example URI

POST /research-sys/api/v1/role-document-delegation-member-qualifiers/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "delegationMemberId": "(val)",
  "kimTypId": "(val)",
  "kimAttrDefnId": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "attrVal": "(val)",
  "active": "(val)",
  "attrDataId": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "delegationMemberId": "(val)",
  "kimTypId": "(val)",
  "kimAttrDefnId": "(val)",
  "edit": "(val)",
  "documentNumber": "(val)",
  "attrVal": "(val)",
  "active": "(val)",
  "attrDataId": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Role Document Delegation Member Qualifiers
POST/research-sys/api/v1/role-document-delegation-member-qualifiers/

Example URI

POST /research-sys/api/v1/role-document-delegation-member-qualifiers/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "delegationMemberId": "(val)",
    "kimTypId": "(val)",
    "kimAttrDefnId": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "attrVal": "(val)",
    "active": "(val)",
    "attrDataId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "delegationMemberId": "(val)",
    "kimTypId": "(val)",
    "kimAttrDefnId": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "attrVal": "(val)",
    "active": "(val)",
    "attrDataId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "delegationMemberId": "(val)",
    "kimTypId": "(val)",
    "kimAttrDefnId": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "attrVal": "(val)",
    "active": "(val)",
    "attrDataId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "delegationMemberId": "(val)",
    "kimTypId": "(val)",
    "kimAttrDefnId": "(val)",
    "edit": "(val)",
    "documentNumber": "(val)",
    "attrVal": "(val)",
    "active": "(val)",
    "attrDataId": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Role Document Delegation Member Qualifiers by Key
DELETE/research-sys/api/v1/role-document-delegation-member-qualifiers/(key)

Example URI

DELETE /research-sys/api/v1/role-document-delegation-member-qualifiers/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Role Document Delegation Member Qualifiers
DELETE/research-sys/api/v1/role-document-delegation-member-qualifiers/

Example URI

DELETE /research-sys/api/v1/role-document-delegation-member-qualifiers/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Role Document Delegation Member Qualifiers with Matching
DELETE/research-sys/api/v1/role-document-delegation-member-qualifiers/

Example URI

DELETE /research-sys/api/v1/role-document-delegation-member-qualifiers/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

delegationMemberId
string (optional) 

Target Primary Key. Maximum length is 40.

kimTypId
string (optional) 

Kim Typ Id. Maximum length is 40.

kimAttrDefnId
string (optional) 

Kim Attr Defn Id. Maximum length is 40.

edit
string (optional) 

Edit.

documentNumber
string (optional) 

Document Number.

attrVal
string (optional) 

Attr Val. Maximum length is 400.

active
string (optional) 

Active.

attrDataId
string (optional) 

Attr Data Id. Maximum length is 40.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Role Document Delegation Members

Get Role Document Delegation Members by Key
GET/research-sys/api/v1/role-document-delegation-members/(key)

Example URI

GET /research-sys/api/v1/role-document-delegation-members/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "delegationMemberId": "(val)",
  "roleMemberId": "(val)",
  "delegationId": "(val)",
  "memberId": "(val)",
  "memberTypeCode": "(val)",
  "memberName": "(val)",
  "activeFromDate": "(val)",
  "activeToDate": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Get All Role Document Delegation Members
GET/research-sys/api/v1/role-document-delegation-members/

Example URI

GET /research-sys/api/v1/role-document-delegation-members/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "delegationMemberId": "(val)",
    "roleMemberId": "(val)",
    "delegationId": "(val)",
    "memberId": "(val)",
    "memberTypeCode": "(val)",
    "memberName": "(val)",
    "activeFromDate": "(val)",
    "activeToDate": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "delegationMemberId": "(val)",
    "roleMemberId": "(val)",
    "delegationId": "(val)",
    "memberId": "(val)",
    "memberTypeCode": "(val)",
    "memberName": "(val)",
    "activeFromDate": "(val)",
    "activeToDate": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Role Document Delegation Members with Filtering
GET/research-sys/api/v1/role-document-delegation-members/

Example URI

GET /research-sys/api/v1/role-document-delegation-members/
URI Parameters
HideShow
delegationMemberId
string (optional) 

Delegation Member Identifier. Maximum length is 40.

roleMemberId
string (optional) 

Role Member. Maximum length is 40.

delegationId
string (optional) 

Delegation Id.

memberId
string (optional) 

Member Identifier. Maximum length is 40.

memberTypeCode
string (optional) 

Member Type Code. Maximum length is 40.

memberName
string (optional) 

Member Name. Maximum length is 40.

activeFromDate
string (optional) 

Start Date. Maximum length is 21.

activeToDate
string (optional) 

End Date. Maximum length is 21.

documentNumber
string (optional) 

Document Number.

active
string (optional) 

Active.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "delegationMemberId": "(val)",
    "roleMemberId": "(val)",
    "delegationId": "(val)",
    "memberId": "(val)",
    "memberTypeCode": "(val)",
    "memberName": "(val)",
    "activeFromDate": "(val)",
    "activeToDate": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "delegationMemberId": "(val)",
    "roleMemberId": "(val)",
    "delegationId": "(val)",
    "memberId": "(val)",
    "memberTypeCode": "(val)",
    "memberName": "(val)",
    "activeFromDate": "(val)",
    "activeToDate": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Role Document Delegation Members
GET/research-sys/api/v1/role-document-delegation-members/

Example URI

GET /research-sys/api/v1/role-document-delegation-members/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "delegationMemberId",
    "roleMemberId",
    "delegationId",
    "memberId",
    "memberTypeCode",
    "memberName",
    "activeFromDate",
    "activeToDate",
    "documentNumber",
    "active"
  ],
  "primaryKey": "delegationMemberId"
}

Get Blueprint API specification for Role Document Delegation Members
GET/research-sys/api/v1/role-document-delegation-members/

Example URI

GET /research-sys/api/v1/role-document-delegation-members/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Role Document Delegation Members.md"
transfer-encoding: chunked

Update Role Document Delegation Members
PUT/research-sys/api/v1/role-document-delegation-members/(key)

Example URI

PUT /research-sys/api/v1/role-document-delegation-members/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "delegationMemberId": "(val)",
  "roleMemberId": "(val)",
  "delegationId": "(val)",
  "memberId": "(val)",
  "memberTypeCode": "(val)",
  "memberName": "(val)",
  "activeFromDate": "(val)",
  "activeToDate": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Role Document Delegation Members
PUT/research-sys/api/v1/role-document-delegation-members/

Example URI

PUT /research-sys/api/v1/role-document-delegation-members/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "delegationMemberId": "(val)",
    "roleMemberId": "(val)",
    "delegationId": "(val)",
    "memberId": "(val)",
    "memberTypeCode": "(val)",
    "memberName": "(val)",
    "activeFromDate": "(val)",
    "activeToDate": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "delegationMemberId": "(val)",
    "roleMemberId": "(val)",
    "delegationId": "(val)",
    "memberId": "(val)",
    "memberTypeCode": "(val)",
    "memberName": "(val)",
    "activeFromDate": "(val)",
    "activeToDate": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Role Document Delegation Members
PATCH/research-sys/api/v1/role-document-delegation-members/(key)

Example URI

PATCH /research-sys/api/v1/role-document-delegation-members/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "delegationMemberId": "(val)",
  "roleMemberId": "(val)",
  "delegationId": "(val)",
  "memberId": "(val)",
  "memberTypeCode": "(val)",
  "memberName": "(val)",
  "activeFromDate": "(val)",
  "activeToDate": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "delegationMemberId": "(val)",
  "roleMemberId": "(val)",
  "delegationId": "(val)",
  "memberId": "(val)",
  "memberTypeCode": "(val)",
  "memberName": "(val)",
  "activeFromDate": "(val)",
  "activeToDate": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Role Document Delegation Members
POST/research-sys/api/v1/role-document-delegation-members/

Example URI

POST /research-sys/api/v1/role-document-delegation-members/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "delegationMemberId": "(val)",
  "roleMemberId": "(val)",
  "delegationId": "(val)",
  "memberId": "(val)",
  "memberTypeCode": "(val)",
  "memberName": "(val)",
  "activeFromDate": "(val)",
  "activeToDate": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "delegationMemberId": "(val)",
  "roleMemberId": "(val)",
  "delegationId": "(val)",
  "memberId": "(val)",
  "memberTypeCode": "(val)",
  "memberName": "(val)",
  "activeFromDate": "(val)",
  "activeToDate": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Role Document Delegation Members
POST/research-sys/api/v1/role-document-delegation-members/

Example URI

POST /research-sys/api/v1/role-document-delegation-members/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "delegationMemberId": "(val)",
    "roleMemberId": "(val)",
    "delegationId": "(val)",
    "memberId": "(val)",
    "memberTypeCode": "(val)",
    "memberName": "(val)",
    "activeFromDate": "(val)",
    "activeToDate": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "delegationMemberId": "(val)",
    "roleMemberId": "(val)",
    "delegationId": "(val)",
    "memberId": "(val)",
    "memberTypeCode": "(val)",
    "memberName": "(val)",
    "activeFromDate": "(val)",
    "activeToDate": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "delegationMemberId": "(val)",
    "roleMemberId": "(val)",
    "delegationId": "(val)",
    "memberId": "(val)",
    "memberTypeCode": "(val)",
    "memberName": "(val)",
    "activeFromDate": "(val)",
    "activeToDate": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "delegationMemberId": "(val)",
    "roleMemberId": "(val)",
    "delegationId": "(val)",
    "memberId": "(val)",
    "memberTypeCode": "(val)",
    "memberName": "(val)",
    "activeFromDate": "(val)",
    "activeToDate": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Role Document Delegation Members by Key
DELETE/research-sys/api/v1/role-document-delegation-members/(key)

Example URI

DELETE /research-sys/api/v1/role-document-delegation-members/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Role Document Delegation Members
DELETE/research-sys/api/v1/role-document-delegation-members/

Example URI

DELETE /research-sys/api/v1/role-document-delegation-members/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Role Document Delegation Members with Matching
DELETE/research-sys/api/v1/role-document-delegation-members/

Example URI

DELETE /research-sys/api/v1/role-document-delegation-members/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

delegationMemberId
string (optional) 

Delegation Member Identifier. Maximum length is 40.

roleMemberId
string (optional) 

Role Member. Maximum length is 40.

delegationId
string (optional) 

Delegation Id.

memberId
string (optional) 

Member Identifier. Maximum length is 40.

memberTypeCode
string (optional) 

Member Type Code. Maximum length is 40.

memberName
string (optional) 

Member Name. Maximum length is 40.

activeFromDate
string (optional) 

Start Date. Maximum length is 21.

activeToDate
string (optional) 

End Date. Maximum length is 21.

documentNumber
string (optional) 

Document Number.

active
string (optional) 

Active.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Role Document Delegations

Get Role Document Delegations by Key
GET/research-sys/api/v1/role-document-delegations/(key)

Example URI

GET /research-sys/api/v1/role-document-delegations/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "delegationId": "(val)",
  "roleId": "(val)",
  "kimTypeId": "(val)",
  "delegationTypeCode": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Get All Role Document Delegations
GET/research-sys/api/v1/role-document-delegations/

Example URI

GET /research-sys/api/v1/role-document-delegations/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "delegationId": "(val)",
    "roleId": "(val)",
    "kimTypeId": "(val)",
    "delegationTypeCode": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "delegationId": "(val)",
    "roleId": "(val)",
    "kimTypeId": "(val)",
    "delegationTypeCode": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Role Document Delegations with Filtering
GET/research-sys/api/v1/role-document-delegations/

Example URI

GET /research-sys/api/v1/role-document-delegations/
URI Parameters
HideShow
delegationId
string (optional) 
roleId
string (optional) 
kimTypeId
string (optional) 
delegationTypeCode
string (optional) 
documentNumber
string (optional) 
active
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "delegationId": "(val)",
    "roleId": "(val)",
    "kimTypeId": "(val)",
    "delegationTypeCode": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "delegationId": "(val)",
    "roleId": "(val)",
    "kimTypeId": "(val)",
    "delegationTypeCode": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Role Document Delegations
GET/research-sys/api/v1/role-document-delegations/

Example URI

GET /research-sys/api/v1/role-document-delegations/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "delegationId",
    "roleId",
    "kimTypeId",
    "delegationTypeCode",
    "documentNumber",
    "active"
  ],
  "primaryKey": "delegationId"
}

Get Blueprint API specification for Role Document Delegations
GET/research-sys/api/v1/role-document-delegations/

Example URI

GET /research-sys/api/v1/role-document-delegations/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Role Document Delegations.md"
transfer-encoding: chunked

Update Role Document Delegations
PUT/research-sys/api/v1/role-document-delegations/(key)

Example URI

PUT /research-sys/api/v1/role-document-delegations/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "delegationId": "(val)",
  "roleId": "(val)",
  "kimTypeId": "(val)",
  "delegationTypeCode": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Role Document Delegations
PUT/research-sys/api/v1/role-document-delegations/

Example URI

PUT /research-sys/api/v1/role-document-delegations/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "delegationId": "(val)",
    "roleId": "(val)",
    "kimTypeId": "(val)",
    "delegationTypeCode": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "delegationId": "(val)",
    "roleId": "(val)",
    "kimTypeId": "(val)",
    "delegationTypeCode": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Role Document Delegations
PATCH/research-sys/api/v1/role-document-delegations/(key)

Example URI

PATCH /research-sys/api/v1/role-document-delegations/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "delegationId": "(val)",
  "roleId": "(val)",
  "kimTypeId": "(val)",
  "delegationTypeCode": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "delegationId": "(val)",
  "roleId": "(val)",
  "kimTypeId": "(val)",
  "delegationTypeCode": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Role Document Delegations
POST/research-sys/api/v1/role-document-delegations/

Example URI

POST /research-sys/api/v1/role-document-delegations/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "delegationId": "(val)",
  "roleId": "(val)",
  "kimTypeId": "(val)",
  "delegationTypeCode": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "delegationId": "(val)",
  "roleId": "(val)",
  "kimTypeId": "(val)",
  "delegationTypeCode": "(val)",
  "documentNumber": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Role Document Delegations
POST/research-sys/api/v1/role-document-delegations/

Example URI

POST /research-sys/api/v1/role-document-delegations/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "delegationId": "(val)",
    "roleId": "(val)",
    "kimTypeId": "(val)",
    "delegationTypeCode": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "delegationId": "(val)",
    "roleId": "(val)",
    "kimTypeId": "(val)",
    "delegationTypeCode": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "delegationId": "(val)",
    "roleId": "(val)",
    "kimTypeId": "(val)",
    "delegationTypeCode": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "delegationId": "(val)",
    "roleId": "(val)",
    "kimTypeId": "(val)",
    "delegationTypeCode": "(val)",
    "documentNumber": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Role Document Delegations by Key
DELETE/research-sys/api/v1/role-document-delegations/(key)

Example URI

DELETE /research-sys/api/v1/role-document-delegations/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Role Document Delegations
DELETE/research-sys/api/v1/role-document-delegations/

Example URI

DELETE /research-sys/api/v1/role-document-delegations/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Role Document Delegations with Matching
DELETE/research-sys/api/v1/role-document-delegations/

Example URI

DELETE /research-sys/api/v1/role-document-delegations/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

delegationId
string (optional) 
roleId
string (optional) 
kimTypeId
string (optional) 
delegationTypeCode
string (optional) 
documentNumber
string (optional) 
active
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Role Member Attribute Data

Get Role Member Attribute Data by Key
GET/research-sys/api/v1/role-member-attribute-data/(key)

Example URI

GET /research-sys/api/v1/role-member-attribute-data/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "assignedToId": "(val)",
  "attributeValue": "(val)",
  "kimTypeId": "(val)",
  "kimAttributeId": "(val)",
  "_primaryKey": "(val)"
}

Get All Role Member Attribute Data
GET/research-sys/api/v1/role-member-attribute-data/

Example URI

GET /research-sys/api/v1/role-member-attribute-data/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "assignedToId": "(val)",
    "attributeValue": "(val)",
    "kimTypeId": "(val)",
    "kimAttributeId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "assignedToId": "(val)",
    "attributeValue": "(val)",
    "kimTypeId": "(val)",
    "kimAttributeId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Role Member Attribute Data with Filtering
GET/research-sys/api/v1/role-member-attribute-data/

Example URI

GET /research-sys/api/v1/role-member-attribute-data/
URI Parameters
HideShow
id
string (optional) 
assignedToId
string (optional) 
attributeValue
string (optional) 
kimTypeId
string (optional) 
kimAttributeId
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "assignedToId": "(val)",
    "attributeValue": "(val)",
    "kimTypeId": "(val)",
    "kimAttributeId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "assignedToId": "(val)",
    "attributeValue": "(val)",
    "kimTypeId": "(val)",
    "kimAttributeId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Role Member Attribute Data
GET/research-sys/api/v1/role-member-attribute-data/

Example URI

GET /research-sys/api/v1/role-member-attribute-data/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "assignedToId",
    "attributeValue",
    "kimTypeId",
    "kimAttributeId"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Role Member Attribute Data
GET/research-sys/api/v1/role-member-attribute-data/

Example URI

GET /research-sys/api/v1/role-member-attribute-data/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Role Member Attribute Data.md"
transfer-encoding: chunked

Update Role Member Attribute Data
PUT/research-sys/api/v1/role-member-attribute-data/(key)

Example URI

PUT /research-sys/api/v1/role-member-attribute-data/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "assignedToId": "(val)",
  "attributeValue": "(val)",
  "kimTypeId": "(val)",
  "kimAttributeId": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Role Member Attribute Data
PUT/research-sys/api/v1/role-member-attribute-data/

Example URI

PUT /research-sys/api/v1/role-member-attribute-data/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "assignedToId": "(val)",
    "attributeValue": "(val)",
    "kimTypeId": "(val)",
    "kimAttributeId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "assignedToId": "(val)",
    "attributeValue": "(val)",
    "kimTypeId": "(val)",
    "kimAttributeId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Role Member Attribute Data
PATCH/research-sys/api/v1/role-member-attribute-data/(key)

Example URI

PATCH /research-sys/api/v1/role-member-attribute-data/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "assignedToId": "(val)",
  "attributeValue": "(val)",
  "kimTypeId": "(val)",
  "kimAttributeId": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "assignedToId": "(val)",
  "attributeValue": "(val)",
  "kimTypeId": "(val)",
  "kimAttributeId": "(val)",
  "_primaryKey": "(val)"
}

Insert Role Member Attribute Data
POST/research-sys/api/v1/role-member-attribute-data/

Example URI

POST /research-sys/api/v1/role-member-attribute-data/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "assignedToId": "(val)",
  "attributeValue": "(val)",
  "kimTypeId": "(val)",
  "kimAttributeId": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "assignedToId": "(val)",
  "attributeValue": "(val)",
  "kimTypeId": "(val)",
  "kimAttributeId": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Role Member Attribute Data
POST/research-sys/api/v1/role-member-attribute-data/

Example URI

POST /research-sys/api/v1/role-member-attribute-data/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "assignedToId": "(val)",
    "attributeValue": "(val)",
    "kimTypeId": "(val)",
    "kimAttributeId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "assignedToId": "(val)",
    "attributeValue": "(val)",
    "kimTypeId": "(val)",
    "kimAttributeId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "assignedToId": "(val)",
    "attributeValue": "(val)",
    "kimTypeId": "(val)",
    "kimAttributeId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "assignedToId": "(val)",
    "attributeValue": "(val)",
    "kimTypeId": "(val)",
    "kimAttributeId": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Role Member Attribute Data by Key
DELETE/research-sys/api/v1/role-member-attribute-data/(key)

Example URI

DELETE /research-sys/api/v1/role-member-attribute-data/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Role Member Attribute Data
DELETE/research-sys/api/v1/role-member-attribute-data/

Example URI

DELETE /research-sys/api/v1/role-member-attribute-data/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Role Member Attribute Data with Matching
DELETE/research-sys/api/v1/role-member-attribute-data/

Example URI

DELETE /research-sys/api/v1/role-member-attribute-data/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 
assignedToId
string (optional) 
attributeValue
string (optional) 
kimTypeId
string (optional) 
kimAttributeId
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Role Members

Get Role Members by Key
GET/research-sys/api/v1/role-members/(key)

Example URI

GET /research-sys/api/v1/role-members/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "roleId": "(val)",
  "activeFromDateValue": "(val)",
  "activeToDateValue": "(val)",
  "memberId": "(val)",
  "typeCode": "(val)",
  "_primaryKey": "(val)"
}

Get All Role Members
GET/research-sys/api/v1/role-members/

Example URI

GET /research-sys/api/v1/role-members/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "roleId": "(val)",
    "activeFromDateValue": "(val)",
    "activeToDateValue": "(val)",
    "memberId": "(val)",
    "typeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "roleId": "(val)",
    "activeFromDateValue": "(val)",
    "activeToDateValue": "(val)",
    "memberId": "(val)",
    "typeCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Role Members with Filtering
GET/research-sys/api/v1/role-members/

Example URI

GET /research-sys/api/v1/role-members/
URI Parameters
HideShow
id
string (optional) 

Role Member Identifier. Maximum length is 40.

roleId
string (optional) 

Role. Maximum length is 40.

activeFromDateValue
string (optional) 

Active From Date Value.

activeToDateValue
string (optional) 

Active To Date Value.

memberId
string (optional) 

Member Identifier. Maximum length is 40.

typeCode
string (optional) 

Member Type Code. Maximum length is 40.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "roleId": "(val)",
    "activeFromDateValue": "(val)",
    "activeToDateValue": "(val)",
    "memberId": "(val)",
    "typeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "roleId": "(val)",
    "activeFromDateValue": "(val)",
    "activeToDateValue": "(val)",
    "memberId": "(val)",
    "typeCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Role Members
GET/research-sys/api/v1/role-members/

Example URI

GET /research-sys/api/v1/role-members/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "roleId",
    "activeFromDateValue",
    "activeToDateValue",
    "memberId",
    "typeCode"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Role Members
GET/research-sys/api/v1/role-members/

Example URI

GET /research-sys/api/v1/role-members/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Role Members.md"
transfer-encoding: chunked

Update Role Members
PUT/research-sys/api/v1/role-members/(key)

Example URI

PUT /research-sys/api/v1/role-members/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "roleId": "(val)",
  "activeFromDateValue": "(val)",
  "activeToDateValue": "(val)",
  "memberId": "(val)",
  "typeCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Role Members
PUT/research-sys/api/v1/role-members/

Example URI

PUT /research-sys/api/v1/role-members/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "roleId": "(val)",
    "activeFromDateValue": "(val)",
    "activeToDateValue": "(val)",
    "memberId": "(val)",
    "typeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "roleId": "(val)",
    "activeFromDateValue": "(val)",
    "activeToDateValue": "(val)",
    "memberId": "(val)",
    "typeCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Role Members
PATCH/research-sys/api/v1/role-members/(key)

Example URI

PATCH /research-sys/api/v1/role-members/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "roleId": "(val)",
  "activeFromDateValue": "(val)",
  "activeToDateValue": "(val)",
  "memberId": "(val)",
  "typeCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "roleId": "(val)",
  "activeFromDateValue": "(val)",
  "activeToDateValue": "(val)",
  "memberId": "(val)",
  "typeCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Role Members
POST/research-sys/api/v1/role-members/

Example URI

POST /research-sys/api/v1/role-members/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "roleId": "(val)",
  "activeFromDateValue": "(val)",
  "activeToDateValue": "(val)",
  "memberId": "(val)",
  "typeCode": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "roleId": "(val)",
  "activeFromDateValue": "(val)",
  "activeToDateValue": "(val)",
  "memberId": "(val)",
  "typeCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Role Members
POST/research-sys/api/v1/role-members/

Example URI

POST /research-sys/api/v1/role-members/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "roleId": "(val)",
    "activeFromDateValue": "(val)",
    "activeToDateValue": "(val)",
    "memberId": "(val)",
    "typeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "roleId": "(val)",
    "activeFromDateValue": "(val)",
    "activeToDateValue": "(val)",
    "memberId": "(val)",
    "typeCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "roleId": "(val)",
    "activeFromDateValue": "(val)",
    "activeToDateValue": "(val)",
    "memberId": "(val)",
    "typeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "roleId": "(val)",
    "activeFromDateValue": "(val)",
    "activeToDateValue": "(val)",
    "memberId": "(val)",
    "typeCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Role Members by Key
DELETE/research-sys/api/v1/role-members/(key)

Example URI

DELETE /research-sys/api/v1/role-members/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Role Members
DELETE/research-sys/api/v1/role-members/

Example URI

DELETE /research-sys/api/v1/role-members/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Role Members with Matching
DELETE/research-sys/api/v1/role-members/

Example URI

DELETE /research-sys/api/v1/role-members/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 

Role Member Identifier. Maximum length is 40.

roleId
string (optional) 

Role. Maximum length is 40.

activeFromDateValue
string (optional) 

Active From Date Value.

activeToDateValue
string (optional) 

Active To Date Value.

memberId
string (optional) 

Member Identifier. Maximum length is 40.

typeCode
string (optional) 

Member Type Code. Maximum length is 40.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Role Permissions

Get Role Permissions by Key
GET/research-sys/api/v1/role-permissions/(key)

Example URI

GET /research-sys/api/v1/role-permissions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "roleId": "(val)",
  "permissionId": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Get All Role Permissions
GET/research-sys/api/v1/role-permissions/

Example URI

GET /research-sys/api/v1/role-permissions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "roleId": "(val)",
    "permissionId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "roleId": "(val)",
    "permissionId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Role Permissions with Filtering
GET/research-sys/api/v1/role-permissions/

Example URI

GET /research-sys/api/v1/role-permissions/
URI Parameters
HideShow
id
string (optional) 
roleId
string (optional) 
permissionId
string (optional) 
active
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "roleId": "(val)",
    "permissionId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "roleId": "(val)",
    "permissionId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Role Permissions
GET/research-sys/api/v1/role-permissions/

Example URI

GET /research-sys/api/v1/role-permissions/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "roleId",
    "permissionId",
    "active"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Role Permissions
GET/research-sys/api/v1/role-permissions/

Example URI

GET /research-sys/api/v1/role-permissions/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Role Permissions.md"
transfer-encoding: chunked

Update Role Permissions
PUT/research-sys/api/v1/role-permissions/(key)

Example URI

PUT /research-sys/api/v1/role-permissions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "roleId": "(val)",
  "permissionId": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Role Permissions
PUT/research-sys/api/v1/role-permissions/

Example URI

PUT /research-sys/api/v1/role-permissions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "roleId": "(val)",
    "permissionId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "roleId": "(val)",
    "permissionId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Role Permissions
PATCH/research-sys/api/v1/role-permissions/(key)

Example URI

PATCH /research-sys/api/v1/role-permissions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "roleId": "(val)",
  "permissionId": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "roleId": "(val)",
  "permissionId": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Role Permissions
POST/research-sys/api/v1/role-permissions/

Example URI

POST /research-sys/api/v1/role-permissions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "roleId": "(val)",
  "permissionId": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "roleId": "(val)",
  "permissionId": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Role Permissions
POST/research-sys/api/v1/role-permissions/

Example URI

POST /research-sys/api/v1/role-permissions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "roleId": "(val)",
    "permissionId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "roleId": "(val)",
    "permissionId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "roleId": "(val)",
    "permissionId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "roleId": "(val)",
    "permissionId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Role Permissions by Key
DELETE/research-sys/api/v1/role-permissions/(key)

Example URI

DELETE /research-sys/api/v1/role-permissions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Role Permissions
DELETE/research-sys/api/v1/role-permissions/

Example URI

DELETE /research-sys/api/v1/role-permissions/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Role Permissions with Matching
DELETE/research-sys/api/v1/role-permissions/

Example URI

DELETE /research-sys/api/v1/role-permissions/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 
roleId
string (optional) 
permissionId
string (optional) 
active
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Role Responsibilities

Get Role Responsibilities by Key
GET/research-sys/api/v1/role-responsibilities/(key)

Example URI

GET /research-sys/api/v1/role-responsibilities/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "roleResponsibilityId": "(val)",
  "roleId": "(val)",
  "responsibilityId": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Get All Role Responsibilities
GET/research-sys/api/v1/role-responsibilities/

Example URI

GET /research-sys/api/v1/role-responsibilities/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "roleResponsibilityId": "(val)",
    "roleId": "(val)",
    "responsibilityId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "roleResponsibilityId": "(val)",
    "roleId": "(val)",
    "responsibilityId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Role Responsibilities with Filtering
GET/research-sys/api/v1/role-responsibilities/

Example URI

GET /research-sys/api/v1/role-responsibilities/
URI Parameters
HideShow
roleResponsibilityId
string (optional) 
roleId
string (optional) 
responsibilityId
string (optional) 
active
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "roleResponsibilityId": "(val)",
    "roleId": "(val)",
    "responsibilityId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "roleResponsibilityId": "(val)",
    "roleId": "(val)",
    "responsibilityId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Role Responsibilities
GET/research-sys/api/v1/role-responsibilities/

Example URI

GET /research-sys/api/v1/role-responsibilities/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "roleResponsibilityId",
    "roleId",
    "responsibilityId",
    "active"
  ],
  "primaryKey": "roleResponsibilityId"
}

Get Blueprint API specification for Role Responsibilities
GET/research-sys/api/v1/role-responsibilities/

Example URI

GET /research-sys/api/v1/role-responsibilities/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Role Responsibilities.md"
transfer-encoding: chunked

Update Role Responsibilities
PUT/research-sys/api/v1/role-responsibilities/(key)

Example URI

PUT /research-sys/api/v1/role-responsibilities/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "roleResponsibilityId": "(val)",
  "roleId": "(val)",
  "responsibilityId": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Role Responsibilities
PUT/research-sys/api/v1/role-responsibilities/

Example URI

PUT /research-sys/api/v1/role-responsibilities/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "roleResponsibilityId": "(val)",
    "roleId": "(val)",
    "responsibilityId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "roleResponsibilityId": "(val)",
    "roleId": "(val)",
    "responsibilityId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Role Responsibilities
PATCH/research-sys/api/v1/role-responsibilities/(key)

Example URI

PATCH /research-sys/api/v1/role-responsibilities/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "roleResponsibilityId": "(val)",
  "roleId": "(val)",
  "responsibilityId": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "roleResponsibilityId": "(val)",
  "roleId": "(val)",
  "responsibilityId": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Role Responsibilities
POST/research-sys/api/v1/role-responsibilities/

Example URI

POST /research-sys/api/v1/role-responsibilities/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "roleResponsibilityId": "(val)",
  "roleId": "(val)",
  "responsibilityId": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "roleResponsibilityId": "(val)",
  "roleId": "(val)",
  "responsibilityId": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Role Responsibilities
POST/research-sys/api/v1/role-responsibilities/

Example URI

POST /research-sys/api/v1/role-responsibilities/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "roleResponsibilityId": "(val)",
    "roleId": "(val)",
    "responsibilityId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "roleResponsibilityId": "(val)",
    "roleId": "(val)",
    "responsibilityId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "roleResponsibilityId": "(val)",
    "roleId": "(val)",
    "responsibilityId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "roleResponsibilityId": "(val)",
    "roleId": "(val)",
    "responsibilityId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Role Responsibilities by Key
DELETE/research-sys/api/v1/role-responsibilities/(key)

Example URI

DELETE /research-sys/api/v1/role-responsibilities/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Role Responsibilities
DELETE/research-sys/api/v1/role-responsibilities/

Example URI

DELETE /research-sys/api/v1/role-responsibilities/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Role Responsibilities with Matching
DELETE/research-sys/api/v1/role-responsibilities/

Example URI

DELETE /research-sys/api/v1/role-responsibilities/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

roleResponsibilityId
string (optional) 
roleId
string (optional) 
responsibilityId
string (optional) 
active
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Role Responsibility Actions

Get Role Responsibility Actions by Key
GET/research-sys/api/v1/role-responsibility-actions/(key)

Example URI

GET /research-sys/api/v1/role-responsibility-actions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "roleResponsibilityId": "(val)",
  "roleMemberId": "(val)",
  "actionTypeCode": "(val)",
  "actionPolicyCode": "(val)",
  "forceAction": "(val)",
  "priorityNumber": "(val)",
  "_primaryKey": "(val)"
}

Get All Role Responsibility Actions
GET/research-sys/api/v1/role-responsibility-actions/

Example URI

GET /research-sys/api/v1/role-responsibility-actions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "roleResponsibilityId": "(val)",
    "roleMemberId": "(val)",
    "actionTypeCode": "(val)",
    "actionPolicyCode": "(val)",
    "forceAction": "(val)",
    "priorityNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "roleResponsibilityId": "(val)",
    "roleMemberId": "(val)",
    "actionTypeCode": "(val)",
    "actionPolicyCode": "(val)",
    "forceAction": "(val)",
    "priorityNumber": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Role Responsibility Actions with Filtering
GET/research-sys/api/v1/role-responsibility-actions/

Example URI

GET /research-sys/api/v1/role-responsibility-actions/
URI Parameters
HideShow
id
string (optional) 
roleResponsibilityId
string (optional) 
roleMemberId
string (optional) 
actionTypeCode
string (optional) 
actionPolicyCode
string (optional) 
forceAction
string (optional) 
priorityNumber
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "roleResponsibilityId": "(val)",
    "roleMemberId": "(val)",
    "actionTypeCode": "(val)",
    "actionPolicyCode": "(val)",
    "forceAction": "(val)",
    "priorityNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "roleResponsibilityId": "(val)",
    "roleMemberId": "(val)",
    "actionTypeCode": "(val)",
    "actionPolicyCode": "(val)",
    "forceAction": "(val)",
    "priorityNumber": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Role Responsibility Actions
GET/research-sys/api/v1/role-responsibility-actions/

Example URI

GET /research-sys/api/v1/role-responsibility-actions/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "roleResponsibilityId",
    "roleMemberId",
    "actionTypeCode",
    "actionPolicyCode",
    "forceAction",
    "priorityNumber"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Role Responsibility Actions
GET/research-sys/api/v1/role-responsibility-actions/

Example URI

GET /research-sys/api/v1/role-responsibility-actions/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Role Responsibility Actions.md"
transfer-encoding: chunked

Update Role Responsibility Actions
PUT/research-sys/api/v1/role-responsibility-actions/(key)

Example URI

PUT /research-sys/api/v1/role-responsibility-actions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "roleResponsibilityId": "(val)",
  "roleMemberId": "(val)",
  "actionTypeCode": "(val)",
  "actionPolicyCode": "(val)",
  "forceAction": "(val)",
  "priorityNumber": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Role Responsibility Actions
PUT/research-sys/api/v1/role-responsibility-actions/

Example URI

PUT /research-sys/api/v1/role-responsibility-actions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "roleResponsibilityId": "(val)",
    "roleMemberId": "(val)",
    "actionTypeCode": "(val)",
    "actionPolicyCode": "(val)",
    "forceAction": "(val)",
    "priorityNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "roleResponsibilityId": "(val)",
    "roleMemberId": "(val)",
    "actionTypeCode": "(val)",
    "actionPolicyCode": "(val)",
    "forceAction": "(val)",
    "priorityNumber": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Role Responsibility Actions
PATCH/research-sys/api/v1/role-responsibility-actions/(key)

Example URI

PATCH /research-sys/api/v1/role-responsibility-actions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "roleResponsibilityId": "(val)",
  "roleMemberId": "(val)",
  "actionTypeCode": "(val)",
  "actionPolicyCode": "(val)",
  "forceAction": "(val)",
  "priorityNumber": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "roleResponsibilityId": "(val)",
  "roleMemberId": "(val)",
  "actionTypeCode": "(val)",
  "actionPolicyCode": "(val)",
  "forceAction": "(val)",
  "priorityNumber": "(val)",
  "_primaryKey": "(val)"
}

Insert Role Responsibility Actions
POST/research-sys/api/v1/role-responsibility-actions/

Example URI

POST /research-sys/api/v1/role-responsibility-actions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "roleResponsibilityId": "(val)",
  "roleMemberId": "(val)",
  "actionTypeCode": "(val)",
  "actionPolicyCode": "(val)",
  "forceAction": "(val)",
  "priorityNumber": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "roleResponsibilityId": "(val)",
  "roleMemberId": "(val)",
  "actionTypeCode": "(val)",
  "actionPolicyCode": "(val)",
  "forceAction": "(val)",
  "priorityNumber": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Role Responsibility Actions
POST/research-sys/api/v1/role-responsibility-actions/

Example URI

POST /research-sys/api/v1/role-responsibility-actions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "roleResponsibilityId": "(val)",
    "roleMemberId": "(val)",
    "actionTypeCode": "(val)",
    "actionPolicyCode": "(val)",
    "forceAction": "(val)",
    "priorityNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "roleResponsibilityId": "(val)",
    "roleMemberId": "(val)",
    "actionTypeCode": "(val)",
    "actionPolicyCode": "(val)",
    "forceAction": "(val)",
    "priorityNumber": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "roleResponsibilityId": "(val)",
    "roleMemberId": "(val)",
    "actionTypeCode": "(val)",
    "actionPolicyCode": "(val)",
    "forceAction": "(val)",
    "priorityNumber": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "roleResponsibilityId": "(val)",
    "roleMemberId": "(val)",
    "actionTypeCode": "(val)",
    "actionPolicyCode": "(val)",
    "forceAction": "(val)",
    "priorityNumber": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Role Responsibility Actions by Key
DELETE/research-sys/api/v1/role-responsibility-actions/(key)

Example URI

DELETE /research-sys/api/v1/role-responsibility-actions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Role Responsibility Actions
DELETE/research-sys/api/v1/role-responsibility-actions/

Example URI

DELETE /research-sys/api/v1/role-responsibility-actions/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Role Responsibility Actions with Matching
DELETE/research-sys/api/v1/role-responsibility-actions/

Example URI

DELETE /research-sys/api/v1/role-responsibility-actions/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 
roleResponsibilityId
string (optional) 
roleMemberId
string (optional) 
actionTypeCode
string (optional) 
actionPolicyCode
string (optional) 
forceAction
string (optional) 
priorityNumber
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Roles

Get Roles by Key
GET/research-sys/api/v1/roles/(key)

Example URI

GET /research-sys/api/v1/roles/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "name": "(val)",
  "description": "(val)",
  "active": "(val)",
  "kimTypeId": "(val)",
  "namespaceCode": "(val)",
  "_primaryKey": "(val)"
}

Get All Roles
GET/research-sys/api/v1/roles/

Example URI

GET /research-sys/api/v1/roles/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "active": "(val)",
    "kimTypeId": "(val)",
    "namespaceCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "active": "(val)",
    "kimTypeId": "(val)",
    "namespaceCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Roles with Filtering
GET/research-sys/api/v1/roles/

Example URI

GET /research-sys/api/v1/roles/
URI Parameters
HideShow
id
string (optional) 

Role. Maximum length is 40.

name
string (optional) 

Role Name. Maximum length is 80.

description
string (optional) 

Description. Maximum length is 400.

active
string (optional) 

This attribute is used to describe whether the associated object is active or inactive. Maximum length is 1.

kimTypeId
string (optional) 

Role Type. Maximum length is 40.

namespaceCode
string (optional) 

Nmspc Cd. Maximum length is 40.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "active": "(val)",
    "kimTypeId": "(val)",
    "namespaceCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "active": "(val)",
    "kimTypeId": "(val)",
    "namespaceCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Roles
GET/research-sys/api/v1/roles/

Example URI

GET /research-sys/api/v1/roles/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "name",
    "description",
    "active",
    "kimTypeId",
    "namespaceCode"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Roles
GET/research-sys/api/v1/roles/

Example URI

GET /research-sys/api/v1/roles/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Roles.md"
transfer-encoding: chunked

Update Roles
PUT/research-sys/api/v1/roles/(key)

Example URI

PUT /research-sys/api/v1/roles/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "name": "(val)",
  "description": "(val)",
  "active": "(val)",
  "kimTypeId": "(val)",
  "namespaceCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Roles
PUT/research-sys/api/v1/roles/

Example URI

PUT /research-sys/api/v1/roles/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "active": "(val)",
    "kimTypeId": "(val)",
    "namespaceCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "active": "(val)",
    "kimTypeId": "(val)",
    "namespaceCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Roles
PATCH/research-sys/api/v1/roles/(key)

Example URI

PATCH /research-sys/api/v1/roles/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "name": "(val)",
  "description": "(val)",
  "active": "(val)",
  "kimTypeId": "(val)",
  "namespaceCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "name": "(val)",
  "description": "(val)",
  "active": "(val)",
  "kimTypeId": "(val)",
  "namespaceCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Roles
POST/research-sys/api/v1/roles/

Example URI

POST /research-sys/api/v1/roles/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "name": "(val)",
  "description": "(val)",
  "active": "(val)",
  "kimTypeId": "(val)",
  "namespaceCode": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "name": "(val)",
  "description": "(val)",
  "active": "(val)",
  "kimTypeId": "(val)",
  "namespaceCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Roles
POST/research-sys/api/v1/roles/

Example URI

POST /research-sys/api/v1/roles/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "active": "(val)",
    "kimTypeId": "(val)",
    "namespaceCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "active": "(val)",
    "kimTypeId": "(val)",
    "namespaceCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "active": "(val)",
    "kimTypeId": "(val)",
    "namespaceCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "active": "(val)",
    "kimTypeId": "(val)",
    "namespaceCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Roles by Key
DELETE/research-sys/api/v1/roles/(key)

Example URI

DELETE /research-sys/api/v1/roles/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Roles
DELETE/research-sys/api/v1/roles/

Example URI

DELETE /research-sys/api/v1/roles/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Roles with Matching
DELETE/research-sys/api/v1/roles/

Example URI

DELETE /research-sys/api/v1/roles/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 

Role. Maximum length is 40.

name
string (optional) 

Role Name. Maximum length is 80.

description
string (optional) 

Description. Maximum length is 400.

active
string (optional) 

This attribute is used to describe whether the associated object is active or inactive. Maximum length is 1.

kimTypeId
string (optional) 

Role Type. Maximum length is 40.

namespaceCode
string (optional) 

Nmspc Cd. Maximum length is 40.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Rule Attributes

Get Rule Attributes by Key
GET/research-sys/api/v1/rule-attributes/(key)

Example URI

GET /research-sys/api/v1/rule-attributes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "value": "(val)",
  "_primaryKey": "(val)"
}

Get All Rule Attributes
GET/research-sys/api/v1/rule-attributes/

Example URI

GET /research-sys/api/v1/rule-attributes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Rule Attributes with Filtering
GET/research-sys/api/v1/rule-attributes/

Example URI

GET /research-sys/api/v1/rule-attributes/
URI Parameters
HideShow
id
string (optional) 

Rule Attribute Id.

value
string (optional) 

Attribute Value.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Rule Attributes
GET/research-sys/api/v1/rule-attributes/

Example URI

GET /research-sys/api/v1/rule-attributes/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "value"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Rule Attributes
GET/research-sys/api/v1/rule-attributes/

Example URI

GET /research-sys/api/v1/rule-attributes/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Rule Attributes.md"
transfer-encoding: chunked

Update Rule Attributes
PUT/research-sys/api/v1/rule-attributes/(key)

Example URI

PUT /research-sys/api/v1/rule-attributes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "value": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Rule Attributes
PUT/research-sys/api/v1/rule-attributes/

Example URI

PUT /research-sys/api/v1/rule-attributes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Rule Attributes
PATCH/research-sys/api/v1/rule-attributes/(key)

Example URI

PATCH /research-sys/api/v1/rule-attributes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "value": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "value": "(val)",
  "_primaryKey": "(val)"
}

Insert Rule Attributes
POST/research-sys/api/v1/rule-attributes/

Example URI

POST /research-sys/api/v1/rule-attributes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "value": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "value": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Rule Attributes
POST/research-sys/api/v1/rule-attributes/

Example URI

POST /research-sys/api/v1/rule-attributes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Rule Attributes by Key
DELETE/research-sys/api/v1/rule-attributes/(key)

Example URI

DELETE /research-sys/api/v1/rule-attributes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Rule Attributes
DELETE/research-sys/api/v1/rule-attributes/

Example URI

DELETE /research-sys/api/v1/rule-attributes/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Rule Attributes with Matching
DELETE/research-sys/api/v1/rule-attributes/

Example URI

DELETE /research-sys/api/v1/rule-attributes/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 

Rule Attribute Id.

value
string (optional) 

Attribute Value.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Rule Base Values

Get Rule Base Values by Key
GET/research-sys/api/v1/rule-base-values/(key)

Example URI

GET /research-sys/api/v1/rule-base-values/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "name": "(val)",
  "ruleTemplateId": "(val)",
  "previousRuleId": "(val)",
  "active": "(val)",
  "description": "(val)",
  "docTypeName": "(val)",
  "documentId": "(val)",
  "fromDateValue": "(val)",
  "toDateValue": "(val)",
  "deactivationDate": "(val)",
  "currentInd": "(val)",
  "versionNbr": "(val)",
  "forceAction": "(val)",
  "activationDate": "(val)",
  "delegateRule": "(val)",
  "templateRuleInd": "(val)",
  "_primaryKey": "(val)"
}

Get All Rule Base Values
GET/research-sys/api/v1/rule-base-values/

Example URI

GET /research-sys/api/v1/rule-base-values/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "ruleTemplateId": "(val)",
    "previousRuleId": "(val)",
    "active": "(val)",
    "description": "(val)",
    "docTypeName": "(val)",
    "documentId": "(val)",
    "fromDateValue": "(val)",
    "toDateValue": "(val)",
    "deactivationDate": "(val)",
    "currentInd": "(val)",
    "versionNbr": "(val)",
    "forceAction": "(val)",
    "activationDate": "(val)",
    "delegateRule": "(val)",
    "templateRuleInd": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "ruleTemplateId": "(val)",
    "previousRuleId": "(val)",
    "active": "(val)",
    "description": "(val)",
    "docTypeName": "(val)",
    "documentId": "(val)",
    "fromDateValue": "(val)",
    "toDateValue": "(val)",
    "deactivationDate": "(val)",
    "currentInd": "(val)",
    "versionNbr": "(val)",
    "forceAction": "(val)",
    "activationDate": "(val)",
    "delegateRule": "(val)",
    "templateRuleInd": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Rule Base Values with Filtering
GET/research-sys/api/v1/rule-base-values/

Example URI

GET /research-sys/api/v1/rule-base-values/
URI Parameters
HideShow
id
string (optional) 

Rule Id. Maximum length is 30.

name
string (optional) 

Name. Maximum length is 256.

ruleTemplateId
string (optional) 

Rule Template Id. Maximum length is 30.

previousRuleId
string (optional) 

Previous Rule. Maximum length is 30.

active
string (optional) 

Active. Maximum length is 1.

description
string (optional) 

Description. Maximum length is 2000.

docTypeName
string (optional) 

Document Type. Maximum length is 256.

documentId
string (optional) 

Document Id. Maximum length is 40.

fromDateValue
string (optional) 

From Date. Maximum length is 10.

toDateValue
string (optional) 

To Date. Maximum length is 10.

deactivationDate
string (optional) 

Deactivation Date.

currentInd
string (optional) 

Current Ind.

versionNbr
string (optional) 

Version Nbr.

forceAction
string (optional) 

Force Action. Maximum length is 1.

activationDate
string (optional) 

Activation Date.

delegateRule
string (optional) 

Delegate Rule. Maximum length is 1.

templateRuleInd
string (optional) 

Template Rule Ind.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "ruleTemplateId": "(val)",
    "previousRuleId": "(val)",
    "active": "(val)",
    "description": "(val)",
    "docTypeName": "(val)",
    "documentId": "(val)",
    "fromDateValue": "(val)",
    "toDateValue": "(val)",
    "deactivationDate": "(val)",
    "currentInd": "(val)",
    "versionNbr": "(val)",
    "forceAction": "(val)",
    "activationDate": "(val)",
    "delegateRule": "(val)",
    "templateRuleInd": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "ruleTemplateId": "(val)",
    "previousRuleId": "(val)",
    "active": "(val)",
    "description": "(val)",
    "docTypeName": "(val)",
    "documentId": "(val)",
    "fromDateValue": "(val)",
    "toDateValue": "(val)",
    "deactivationDate": "(val)",
    "currentInd": "(val)",
    "versionNbr": "(val)",
    "forceAction": "(val)",
    "activationDate": "(val)",
    "delegateRule": "(val)",
    "templateRuleInd": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Rule Base Values
GET/research-sys/api/v1/rule-base-values/

Example URI

GET /research-sys/api/v1/rule-base-values/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "name",
    "ruleTemplateId",
    "previousRuleId",
    "active",
    "description",
    "docTypeName",
    "documentId",
    "fromDateValue",
    "toDateValue",
    "deactivationDate",
    "currentInd",
    "versionNbr",
    "forceAction",
    "activationDate",
    "delegateRule",
    "templateRuleInd"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Rule Base Values
GET/research-sys/api/v1/rule-base-values/

Example URI

GET /research-sys/api/v1/rule-base-values/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Rule Base Values.md"
transfer-encoding: chunked

Update Rule Base Values
PUT/research-sys/api/v1/rule-base-values/(key)

Example URI

PUT /research-sys/api/v1/rule-base-values/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "name": "(val)",
  "ruleTemplateId": "(val)",
  "previousRuleId": "(val)",
  "active": "(val)",
  "description": "(val)",
  "docTypeName": "(val)",
  "documentId": "(val)",
  "fromDateValue": "(val)",
  "toDateValue": "(val)",
  "deactivationDate": "(val)",
  "currentInd": "(val)",
  "versionNbr": "(val)",
  "forceAction": "(val)",
  "activationDate": "(val)",
  "delegateRule": "(val)",
  "templateRuleInd": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Rule Base Values
PUT/research-sys/api/v1/rule-base-values/

Example URI

PUT /research-sys/api/v1/rule-base-values/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "ruleTemplateId": "(val)",
    "previousRuleId": "(val)",
    "active": "(val)",
    "description": "(val)",
    "docTypeName": "(val)",
    "documentId": "(val)",
    "fromDateValue": "(val)",
    "toDateValue": "(val)",
    "deactivationDate": "(val)",
    "currentInd": "(val)",
    "versionNbr": "(val)",
    "forceAction": "(val)",
    "activationDate": "(val)",
    "delegateRule": "(val)",
    "templateRuleInd": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "ruleTemplateId": "(val)",
    "previousRuleId": "(val)",
    "active": "(val)",
    "description": "(val)",
    "docTypeName": "(val)",
    "documentId": "(val)",
    "fromDateValue": "(val)",
    "toDateValue": "(val)",
    "deactivationDate": "(val)",
    "currentInd": "(val)",
    "versionNbr": "(val)",
    "forceAction": "(val)",
    "activationDate": "(val)",
    "delegateRule": "(val)",
    "templateRuleInd": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Rule Base Values
PATCH/research-sys/api/v1/rule-base-values/(key)

Example URI

PATCH /research-sys/api/v1/rule-base-values/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "name": "(val)",
  "ruleTemplateId": "(val)",
  "previousRuleId": "(val)",
  "active": "(val)",
  "description": "(val)",
  "docTypeName": "(val)",
  "documentId": "(val)",
  "fromDateValue": "(val)",
  "toDateValue": "(val)",
  "deactivationDate": "(val)",
  "currentInd": "(val)",
  "versionNbr": "(val)",
  "forceAction": "(val)",
  "activationDate": "(val)",
  "delegateRule": "(val)",
  "templateRuleInd": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "name": "(val)",
  "ruleTemplateId": "(val)",
  "previousRuleId": "(val)",
  "active": "(val)",
  "description": "(val)",
  "docTypeName": "(val)",
  "documentId": "(val)",
  "fromDateValue": "(val)",
  "toDateValue": "(val)",
  "deactivationDate": "(val)",
  "currentInd": "(val)",
  "versionNbr": "(val)",
  "forceAction": "(val)",
  "activationDate": "(val)",
  "delegateRule": "(val)",
  "templateRuleInd": "(val)",
  "_primaryKey": "(val)"
}

Insert Rule Base Values
POST/research-sys/api/v1/rule-base-values/

Example URI

POST /research-sys/api/v1/rule-base-values/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "name": "(val)",
  "ruleTemplateId": "(val)",
  "previousRuleId": "(val)",
  "active": "(val)",
  "description": "(val)",
  "docTypeName": "(val)",
  "documentId": "(val)",
  "fromDateValue": "(val)",
  "toDateValue": "(val)",
  "deactivationDate": "(val)",
  "currentInd": "(val)",
  "versionNbr": "(val)",
  "forceAction": "(val)",
  "activationDate": "(val)",
  "delegateRule": "(val)",
  "templateRuleInd": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "name": "(val)",
  "ruleTemplateId": "(val)",
  "previousRuleId": "(val)",
  "active": "(val)",
  "description": "(val)",
  "docTypeName": "(val)",
  "documentId": "(val)",
  "fromDateValue": "(val)",
  "toDateValue": "(val)",
  "deactivationDate": "(val)",
  "currentInd": "(val)",
  "versionNbr": "(val)",
  "forceAction": "(val)",
  "activationDate": "(val)",
  "delegateRule": "(val)",
  "templateRuleInd": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Rule Base Values
POST/research-sys/api/v1/rule-base-values/

Example URI

POST /research-sys/api/v1/rule-base-values/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "ruleTemplateId": "(val)",
    "previousRuleId": "(val)",
    "active": "(val)",
    "description": "(val)",
    "docTypeName": "(val)",
    "documentId": "(val)",
    "fromDateValue": "(val)",
    "toDateValue": "(val)",
    "deactivationDate": "(val)",
    "currentInd": "(val)",
    "versionNbr": "(val)",
    "forceAction": "(val)",
    "activationDate": "(val)",
    "delegateRule": "(val)",
    "templateRuleInd": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "ruleTemplateId": "(val)",
    "previousRuleId": "(val)",
    "active": "(val)",
    "description": "(val)",
    "docTypeName": "(val)",
    "documentId": "(val)",
    "fromDateValue": "(val)",
    "toDateValue": "(val)",
    "deactivationDate": "(val)",
    "currentInd": "(val)",
    "versionNbr": "(val)",
    "forceAction": "(val)",
    "activationDate": "(val)",
    "delegateRule": "(val)",
    "templateRuleInd": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "ruleTemplateId": "(val)",
    "previousRuleId": "(val)",
    "active": "(val)",
    "description": "(val)",
    "docTypeName": "(val)",
    "documentId": "(val)",
    "fromDateValue": "(val)",
    "toDateValue": "(val)",
    "deactivationDate": "(val)",
    "currentInd": "(val)",
    "versionNbr": "(val)",
    "forceAction": "(val)",
    "activationDate": "(val)",
    "delegateRule": "(val)",
    "templateRuleInd": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "ruleTemplateId": "(val)",
    "previousRuleId": "(val)",
    "active": "(val)",
    "description": "(val)",
    "docTypeName": "(val)",
    "documentId": "(val)",
    "fromDateValue": "(val)",
    "toDateValue": "(val)",
    "deactivationDate": "(val)",
    "currentInd": "(val)",
    "versionNbr": "(val)",
    "forceAction": "(val)",
    "activationDate": "(val)",
    "delegateRule": "(val)",
    "templateRuleInd": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Rule Base Values by Key
DELETE/research-sys/api/v1/rule-base-values/(key)

Example URI

DELETE /research-sys/api/v1/rule-base-values/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Rule Base Values
DELETE/research-sys/api/v1/rule-base-values/

Example URI

DELETE /research-sys/api/v1/rule-base-values/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Rule Base Values with Matching
DELETE/research-sys/api/v1/rule-base-values/

Example URI

DELETE /research-sys/api/v1/rule-base-values/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 

Rule Id. Maximum length is 30.

name
string (optional) 

Name. Maximum length is 256.

ruleTemplateId
string (optional) 

Rule Template Id. Maximum length is 30.

previousRuleId
string (optional) 

Previous Rule. Maximum length is 30.

active
string (optional) 

Active. Maximum length is 1.

description
string (optional) 

Description. Maximum length is 2000.

docTypeName
string (optional) 

Document Type. Maximum length is 256.

documentId
string (optional) 

Document Id. Maximum length is 40.

fromDateValue
string (optional) 

From Date. Maximum length is 10.

toDateValue
string (optional) 

To Date. Maximum length is 10.

deactivationDate
string (optional) 

Deactivation Date.

currentInd
string (optional) 

Current Ind.

versionNbr
string (optional) 

Version Nbr.

forceAction
string (optional) 

Force Action. Maximum length is 1.

activationDate
string (optional) 

Activation Date.

delegateRule
string (optional) 

Delegate Rule. Maximum length is 1.

templateRuleInd
string (optional) 

Template Rule Ind.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Rule Delegations

Get Rule Delegations by Key
GET/research-sys/api/v1/rule-delegations/(key)

Example URI

GET /research-sys/api/v1/rule-delegations/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "ruleDelegationId": "(val)",
  "responsibilityId": "(val)",
  "delegateRuleId": "(val)",
  "delegationTypeCode": "(val)",
  "_primaryKey": "(val)"
}

Get All Rule Delegations
GET/research-sys/api/v1/rule-delegations/

Example URI

GET /research-sys/api/v1/rule-delegations/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "ruleDelegationId": "(val)",
    "responsibilityId": "(val)",
    "delegateRuleId": "(val)",
    "delegationTypeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "ruleDelegationId": "(val)",
    "responsibilityId": "(val)",
    "delegateRuleId": "(val)",
    "delegationTypeCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Rule Delegations with Filtering
GET/research-sys/api/v1/rule-delegations/

Example URI

GET /research-sys/api/v1/rule-delegations/
URI Parameters
HideShow
ruleDelegationId
string (optional) 

Delegation Rule Id. Maximum length is 19.

responsibilityId
string (optional) 

Responsibility Id. Maximum length is 30.

delegateRuleId
string (optional) 

Delegation Rule Base Value Id. Maximum length is 30.

delegationTypeCode
string (optional) 

Delegation Type. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "ruleDelegationId": "(val)",
    "responsibilityId": "(val)",
    "delegateRuleId": "(val)",
    "delegationTypeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "ruleDelegationId": "(val)",
    "responsibilityId": "(val)",
    "delegateRuleId": "(val)",
    "delegationTypeCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Rule Delegations
GET/research-sys/api/v1/rule-delegations/

Example URI

GET /research-sys/api/v1/rule-delegations/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "ruleDelegationId",
    "responsibilityId",
    "delegateRuleId",
    "delegationTypeCode"
  ],
  "primaryKey": "ruleDelegationId"
}

Get Blueprint API specification for Rule Delegations
GET/research-sys/api/v1/rule-delegations/

Example URI

GET /research-sys/api/v1/rule-delegations/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Rule Delegations.md"
transfer-encoding: chunked

Update Rule Delegations
PUT/research-sys/api/v1/rule-delegations/(key)

Example URI

PUT /research-sys/api/v1/rule-delegations/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "ruleDelegationId": "(val)",
  "responsibilityId": "(val)",
  "delegateRuleId": "(val)",
  "delegationTypeCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Rule Delegations
PUT/research-sys/api/v1/rule-delegations/

Example URI

PUT /research-sys/api/v1/rule-delegations/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "ruleDelegationId": "(val)",
    "responsibilityId": "(val)",
    "delegateRuleId": "(val)",
    "delegationTypeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "ruleDelegationId": "(val)",
    "responsibilityId": "(val)",
    "delegateRuleId": "(val)",
    "delegationTypeCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Rule Delegations
PATCH/research-sys/api/v1/rule-delegations/(key)

Example URI

PATCH /research-sys/api/v1/rule-delegations/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "ruleDelegationId": "(val)",
  "responsibilityId": "(val)",
  "delegateRuleId": "(val)",
  "delegationTypeCode": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "ruleDelegationId": "(val)",
  "responsibilityId": "(val)",
  "delegateRuleId": "(val)",
  "delegationTypeCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Rule Delegations
POST/research-sys/api/v1/rule-delegations/

Example URI

POST /research-sys/api/v1/rule-delegations/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "ruleDelegationId": "(val)",
  "responsibilityId": "(val)",
  "delegateRuleId": "(val)",
  "delegationTypeCode": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "ruleDelegationId": "(val)",
  "responsibilityId": "(val)",
  "delegateRuleId": "(val)",
  "delegationTypeCode": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Rule Delegations
POST/research-sys/api/v1/rule-delegations/

Example URI

POST /research-sys/api/v1/rule-delegations/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "ruleDelegationId": "(val)",
    "responsibilityId": "(val)",
    "delegateRuleId": "(val)",
    "delegationTypeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "ruleDelegationId": "(val)",
    "responsibilityId": "(val)",
    "delegateRuleId": "(val)",
    "delegationTypeCode": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "ruleDelegationId": "(val)",
    "responsibilityId": "(val)",
    "delegateRuleId": "(val)",
    "delegationTypeCode": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "ruleDelegationId": "(val)",
    "responsibilityId": "(val)",
    "delegateRuleId": "(val)",
    "delegationTypeCode": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Rule Delegations by Key
DELETE/research-sys/api/v1/rule-delegations/(key)

Example URI

DELETE /research-sys/api/v1/rule-delegations/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Rule Delegations
DELETE/research-sys/api/v1/rule-delegations/

Example URI

DELETE /research-sys/api/v1/rule-delegations/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Rule Delegations with Matching
DELETE/research-sys/api/v1/rule-delegations/

Example URI

DELETE /research-sys/api/v1/rule-delegations/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

ruleDelegationId
string (optional) 

Delegation Rule Id. Maximum length is 19.

responsibilityId
string (optional) 

Responsibility Id. Maximum length is 30.

delegateRuleId
string (optional) 

Delegation Rule Base Value Id. Maximum length is 30.

delegationTypeCode
string (optional) 

Delegation Type. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Rule Extension Values

Get Rule Extension Values by Key
GET/research-sys/api/v1/rule-extension-values/(key)

Example URI

GET /research-sys/api/v1/rule-extension-values/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "ruleExtensionValueId": "(val)",
  "value": "(val)",
  "key": "(val)",
  "lockVerNbr": "(val)",
  "_primaryKey": "(val)"
}

Get All Rule Extension Values
GET/research-sys/api/v1/rule-extension-values/

Example URI

GET /research-sys/api/v1/rule-extension-values/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "ruleExtensionValueId": "(val)",
    "value": "(val)",
    "key": "(val)",
    "lockVerNbr": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "ruleExtensionValueId": "(val)",
    "value": "(val)",
    "key": "(val)",
    "lockVerNbr": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Rule Extension Values with Filtering
GET/research-sys/api/v1/rule-extension-values/

Example URI

GET /research-sys/api/v1/rule-extension-values/
URI Parameters
HideShow
ruleExtensionValueId
string (optional) 
value
string (optional) 
key
string (optional) 
lockVerNbr
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "ruleExtensionValueId": "(val)",
    "value": "(val)",
    "key": "(val)",
    "lockVerNbr": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "ruleExtensionValueId": "(val)",
    "value": "(val)",
    "key": "(val)",
    "lockVerNbr": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Rule Extension Values
GET/research-sys/api/v1/rule-extension-values/

Example URI

GET /research-sys/api/v1/rule-extension-values/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "ruleExtensionValueId",
    "value",
    "key",
    "lockVerNbr"
  ],
  "primaryKey": "ruleExtensionValueId"
}

Get Blueprint API specification for Rule Extension Values
GET/research-sys/api/v1/rule-extension-values/

Example URI

GET /research-sys/api/v1/rule-extension-values/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Rule Extension Values.md"
transfer-encoding: chunked

Update Rule Extension Values
PUT/research-sys/api/v1/rule-extension-values/(key)

Example URI

PUT /research-sys/api/v1/rule-extension-values/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "ruleExtensionValueId": "(val)",
  "value": "(val)",
  "key": "(val)",
  "lockVerNbr": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Rule Extension Values
PUT/research-sys/api/v1/rule-extension-values/

Example URI

PUT /research-sys/api/v1/rule-extension-values/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "ruleExtensionValueId": "(val)",
    "value": "(val)",
    "key": "(val)",
    "lockVerNbr": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "ruleExtensionValueId": "(val)",
    "value": "(val)",
    "key": "(val)",
    "lockVerNbr": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Rule Extension Values
PATCH/research-sys/api/v1/rule-extension-values/(key)

Example URI

PATCH /research-sys/api/v1/rule-extension-values/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "ruleExtensionValueId": "(val)",
  "value": "(val)",
  "key": "(val)",
  "lockVerNbr": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "ruleExtensionValueId": "(val)",
  "value": "(val)",
  "key": "(val)",
  "lockVerNbr": "(val)",
  "_primaryKey": "(val)"
}

Insert Rule Extension Values
POST/research-sys/api/v1/rule-extension-values/

Example URI

POST /research-sys/api/v1/rule-extension-values/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "ruleExtensionValueId": "(val)",
  "value": "(val)",
  "key": "(val)",
  "lockVerNbr": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "ruleExtensionValueId": "(val)",
  "value": "(val)",
  "key": "(val)",
  "lockVerNbr": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Rule Extension Values
POST/research-sys/api/v1/rule-extension-values/

Example URI

POST /research-sys/api/v1/rule-extension-values/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "ruleExtensionValueId": "(val)",
    "value": "(val)",
    "key": "(val)",
    "lockVerNbr": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "ruleExtensionValueId": "(val)",
    "value": "(val)",
    "key": "(val)",
    "lockVerNbr": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "ruleExtensionValueId": "(val)",
    "value": "(val)",
    "key": "(val)",
    "lockVerNbr": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "ruleExtensionValueId": "(val)",
    "value": "(val)",
    "key": "(val)",
    "lockVerNbr": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Rule Extension Values by Key
DELETE/research-sys/api/v1/rule-extension-values/(key)

Example URI

DELETE /research-sys/api/v1/rule-extension-values/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Rule Extension Values
DELETE/research-sys/api/v1/rule-extension-values/

Example URI

DELETE /research-sys/api/v1/rule-extension-values/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Rule Extension Values with Matching
DELETE/research-sys/api/v1/rule-extension-values/

Example URI

DELETE /research-sys/api/v1/rule-extension-values/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

ruleExtensionValueId
string (optional) 
value
string (optional) 
key
string (optional) 
lockVerNbr
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Rule Extensions

Get Rule Extensions by Key
GET/research-sys/api/v1/rule-extensions/(key)

Example URI

GET /research-sys/api/v1/rule-extensions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "ruleExtensionId": "(val)",
  "ruleTemplateAttributeId": "(val)",
  "ruleBaseValuesId": "(val)",
  "_primaryKey": "(val)"
}

Get All Rule Extensions
GET/research-sys/api/v1/rule-extensions/

Example URI

GET /research-sys/api/v1/rule-extensions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "ruleExtensionId": "(val)",
    "ruleTemplateAttributeId": "(val)",
    "ruleBaseValuesId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "ruleExtensionId": "(val)",
    "ruleTemplateAttributeId": "(val)",
    "ruleBaseValuesId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Rule Extensions with Filtering
GET/research-sys/api/v1/rule-extensions/

Example URI

GET /research-sys/api/v1/rule-extensions/
URI Parameters
HideShow
ruleExtensionId
string (optional) 
ruleTemplateAttributeId
string (optional) 
ruleBaseValuesId
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "ruleExtensionId": "(val)",
    "ruleTemplateAttributeId": "(val)",
    "ruleBaseValuesId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "ruleExtensionId": "(val)",
    "ruleTemplateAttributeId": "(val)",
    "ruleBaseValuesId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Rule Extensions
GET/research-sys/api/v1/rule-extensions/

Example URI

GET /research-sys/api/v1/rule-extensions/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "ruleExtensionId",
    "ruleTemplateAttributeId",
    "ruleBaseValuesId"
  ],
  "primaryKey": "ruleExtensionId"
}

Get Blueprint API specification for Rule Extensions
GET/research-sys/api/v1/rule-extensions/

Example URI

GET /research-sys/api/v1/rule-extensions/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Rule Extensions.md"
transfer-encoding: chunked

Update Rule Extensions
PUT/research-sys/api/v1/rule-extensions/(key)

Example URI

PUT /research-sys/api/v1/rule-extensions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "ruleExtensionId": "(val)",
  "ruleTemplateAttributeId": "(val)",
  "ruleBaseValuesId": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Rule Extensions
PUT/research-sys/api/v1/rule-extensions/

Example URI

PUT /research-sys/api/v1/rule-extensions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "ruleExtensionId": "(val)",
    "ruleTemplateAttributeId": "(val)",
    "ruleBaseValuesId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "ruleExtensionId": "(val)",
    "ruleTemplateAttributeId": "(val)",
    "ruleBaseValuesId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Rule Extensions
PATCH/research-sys/api/v1/rule-extensions/(key)

Example URI

PATCH /research-sys/api/v1/rule-extensions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "ruleExtensionId": "(val)",
  "ruleTemplateAttributeId": "(val)",
  "ruleBaseValuesId": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "ruleExtensionId": "(val)",
  "ruleTemplateAttributeId": "(val)",
  "ruleBaseValuesId": "(val)",
  "_primaryKey": "(val)"
}

Insert Rule Extensions
POST/research-sys/api/v1/rule-extensions/

Example URI

POST /research-sys/api/v1/rule-extensions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "ruleExtensionId": "(val)",
  "ruleTemplateAttributeId": "(val)",
  "ruleBaseValuesId": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "ruleExtensionId": "(val)",
  "ruleTemplateAttributeId": "(val)",
  "ruleBaseValuesId": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Rule Extensions
POST/research-sys/api/v1/rule-extensions/

Example URI

POST /research-sys/api/v1/rule-extensions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "ruleExtensionId": "(val)",
    "ruleTemplateAttributeId": "(val)",
    "ruleBaseValuesId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "ruleExtensionId": "(val)",
    "ruleTemplateAttributeId": "(val)",
    "ruleBaseValuesId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "ruleExtensionId": "(val)",
    "ruleTemplateAttributeId": "(val)",
    "ruleBaseValuesId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "ruleExtensionId": "(val)",
    "ruleTemplateAttributeId": "(val)",
    "ruleBaseValuesId": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Rule Extensions by Key
DELETE/research-sys/api/v1/rule-extensions/(key)

Example URI

DELETE /research-sys/api/v1/rule-extensions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Rule Extensions
DELETE/research-sys/api/v1/rule-extensions/

Example URI

DELETE /research-sys/api/v1/rule-extensions/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Rule Extensions with Matching
DELETE/research-sys/api/v1/rule-extensions/

Example URI

DELETE /research-sys/api/v1/rule-extensions/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

ruleExtensionId
string (optional) 
ruleTemplateAttributeId
string (optional) 
ruleBaseValuesId
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Rule Responsibilities

Get Rule Responsibilities by Key
GET/research-sys/api/v1/rule-responsibilities/(key)

Example URI

GET /research-sys/api/v1/rule-responsibilities/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "responsibilityId": "(val)",
  "ruleBaseValuesId": "(val)",
  "actionRequestedCd": "(val)",
  "ruleResponsibilityName": "(val)",
  "ruleResponsibilityType": "(val)",
  "priority": "(val)",
  "approvePolicy": "(val)",
  "_primaryKey": "(val)"
}

Get All Rule Responsibilities
GET/research-sys/api/v1/rule-responsibilities/

Example URI

GET /research-sys/api/v1/rule-responsibilities/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "responsibilityId": "(val)",
    "ruleBaseValuesId": "(val)",
    "actionRequestedCd": "(val)",
    "ruleResponsibilityName": "(val)",
    "ruleResponsibilityType": "(val)",
    "priority": "(val)",
    "approvePolicy": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "responsibilityId": "(val)",
    "ruleBaseValuesId": "(val)",
    "actionRequestedCd": "(val)",
    "ruleResponsibilityName": "(val)",
    "ruleResponsibilityType": "(val)",
    "priority": "(val)",
    "approvePolicy": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Rule Responsibilities with Filtering
GET/research-sys/api/v1/rule-responsibilities/

Example URI

GET /research-sys/api/v1/rule-responsibilities/
URI Parameters
HideShow
id
string (optional) 
responsibilityId
string (optional) 
ruleBaseValuesId
string (optional) 
actionRequestedCd
string (optional) 
ruleResponsibilityName
string (optional) 
ruleResponsibilityType
string (optional) 
priority
string (optional) 
approvePolicy
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "responsibilityId": "(val)",
    "ruleBaseValuesId": "(val)",
    "actionRequestedCd": "(val)",
    "ruleResponsibilityName": "(val)",
    "ruleResponsibilityType": "(val)",
    "priority": "(val)",
    "approvePolicy": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "responsibilityId": "(val)",
    "ruleBaseValuesId": "(val)",
    "actionRequestedCd": "(val)",
    "ruleResponsibilityName": "(val)",
    "ruleResponsibilityType": "(val)",
    "priority": "(val)",
    "approvePolicy": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Rule Responsibilities
GET/research-sys/api/v1/rule-responsibilities/

Example URI

GET /research-sys/api/v1/rule-responsibilities/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "responsibilityId",
    "ruleBaseValuesId",
    "actionRequestedCd",
    "ruleResponsibilityName",
    "ruleResponsibilityType",
    "priority",
    "approvePolicy"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Rule Responsibilities
GET/research-sys/api/v1/rule-responsibilities/

Example URI

GET /research-sys/api/v1/rule-responsibilities/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Rule Responsibilities.md"
transfer-encoding: chunked

Update Rule Responsibilities
PUT/research-sys/api/v1/rule-responsibilities/(key)

Example URI

PUT /research-sys/api/v1/rule-responsibilities/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "responsibilityId": "(val)",
  "ruleBaseValuesId": "(val)",
  "actionRequestedCd": "(val)",
  "ruleResponsibilityName": "(val)",
  "ruleResponsibilityType": "(val)",
  "priority": "(val)",
  "approvePolicy": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Rule Responsibilities
PUT/research-sys/api/v1/rule-responsibilities/

Example URI

PUT /research-sys/api/v1/rule-responsibilities/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "responsibilityId": "(val)",
    "ruleBaseValuesId": "(val)",
    "actionRequestedCd": "(val)",
    "ruleResponsibilityName": "(val)",
    "ruleResponsibilityType": "(val)",
    "priority": "(val)",
    "approvePolicy": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "responsibilityId": "(val)",
    "ruleBaseValuesId": "(val)",
    "actionRequestedCd": "(val)",
    "ruleResponsibilityName": "(val)",
    "ruleResponsibilityType": "(val)",
    "priority": "(val)",
    "approvePolicy": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Rule Responsibilities
PATCH/research-sys/api/v1/rule-responsibilities/(key)

Example URI

PATCH /research-sys/api/v1/rule-responsibilities/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "responsibilityId": "(val)",
  "ruleBaseValuesId": "(val)",
  "actionRequestedCd": "(val)",
  "ruleResponsibilityName": "(val)",
  "ruleResponsibilityType": "(val)",
  "priority": "(val)",
  "approvePolicy": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "responsibilityId": "(val)",
  "ruleBaseValuesId": "(val)",
  "actionRequestedCd": "(val)",
  "ruleResponsibilityName": "(val)",
  "ruleResponsibilityType": "(val)",
  "priority": "(val)",
  "approvePolicy": "(val)",
  "_primaryKey": "(val)"
}

Insert Rule Responsibilities
POST/research-sys/api/v1/rule-responsibilities/

Example URI

POST /research-sys/api/v1/rule-responsibilities/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "responsibilityId": "(val)",
  "ruleBaseValuesId": "(val)",
  "actionRequestedCd": "(val)",
  "ruleResponsibilityName": "(val)",
  "ruleResponsibilityType": "(val)",
  "priority": "(val)",
  "approvePolicy": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "responsibilityId": "(val)",
  "ruleBaseValuesId": "(val)",
  "actionRequestedCd": "(val)",
  "ruleResponsibilityName": "(val)",
  "ruleResponsibilityType": "(val)",
  "priority": "(val)",
  "approvePolicy": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Rule Responsibilities
POST/research-sys/api/v1/rule-responsibilities/

Example URI

POST /research-sys/api/v1/rule-responsibilities/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "responsibilityId": "(val)",
    "ruleBaseValuesId": "(val)",
    "actionRequestedCd": "(val)",
    "ruleResponsibilityName": "(val)",
    "ruleResponsibilityType": "(val)",
    "priority": "(val)",
    "approvePolicy": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "responsibilityId": "(val)",
    "ruleBaseValuesId": "(val)",
    "actionRequestedCd": "(val)",
    "ruleResponsibilityName": "(val)",
    "ruleResponsibilityType": "(val)",
    "priority": "(val)",
    "approvePolicy": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "responsibilityId": "(val)",
    "ruleBaseValuesId": "(val)",
    "actionRequestedCd": "(val)",
    "ruleResponsibilityName": "(val)",
    "ruleResponsibilityType": "(val)",
    "priority": "(val)",
    "approvePolicy": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "responsibilityId": "(val)",
    "ruleBaseValuesId": "(val)",
    "actionRequestedCd": "(val)",
    "ruleResponsibilityName": "(val)",
    "ruleResponsibilityType": "(val)",
    "priority": "(val)",
    "approvePolicy": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Rule Responsibilities by Key
DELETE/research-sys/api/v1/rule-responsibilities/(key)

Example URI

DELETE /research-sys/api/v1/rule-responsibilities/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Rule Responsibilities
DELETE/research-sys/api/v1/rule-responsibilities/

Example URI

DELETE /research-sys/api/v1/rule-responsibilities/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Rule Responsibilities with Matching
DELETE/research-sys/api/v1/rule-responsibilities/

Example URI

DELETE /research-sys/api/v1/rule-responsibilities/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 
responsibilityId
string (optional) 
ruleBaseValuesId
string (optional) 
actionRequestedCd
string (optional) 
ruleResponsibilityName
string (optional) 
ruleResponsibilityType
string (optional) 
priority
string (optional) 
approvePolicy
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Rule Template Attributes

Get Rule Template Attributes by Key
GET/research-sys/api/v1/rule-template-attributes/(key)

Example URI

GET /research-sys/api/v1/rule-template-attributes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "ruleAttributeId": "(val)",
  "required": "(val)",
  "active": "(val)",
  "displayOrder": "(val)",
  "defaultValue": "(val)",
  "_primaryKey": "(val)"
}

Get All Rule Template Attributes
GET/research-sys/api/v1/rule-template-attributes/

Example URI

GET /research-sys/api/v1/rule-template-attributes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "ruleAttributeId": "(val)",
    "required": "(val)",
    "active": "(val)",
    "displayOrder": "(val)",
    "defaultValue": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "ruleAttributeId": "(val)",
    "required": "(val)",
    "active": "(val)",
    "displayOrder": "(val)",
    "defaultValue": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Rule Template Attributes with Filtering
GET/research-sys/api/v1/rule-template-attributes/

Example URI

GET /research-sys/api/v1/rule-template-attributes/
URI Parameters
HideShow
id
string (optional) 

Id. Maximum length is 30.

ruleAttributeId
string (optional) 

Rule Attribute Id.

required
string (optional) 

Required. Maximum length is 1.

active
string (optional) 

Active Indicator. Maximum length is 1.

displayOrder
string (optional) 

Display Order.

defaultValue
string (optional) 

Default Value.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "ruleAttributeId": "(val)",
    "required": "(val)",
    "active": "(val)",
    "displayOrder": "(val)",
    "defaultValue": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "ruleAttributeId": "(val)",
    "required": "(val)",
    "active": "(val)",
    "displayOrder": "(val)",
    "defaultValue": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Rule Template Attributes
GET/research-sys/api/v1/rule-template-attributes/

Example URI

GET /research-sys/api/v1/rule-template-attributes/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "ruleAttributeId",
    "required",
    "active",
    "displayOrder",
    "defaultValue"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Rule Template Attributes
GET/research-sys/api/v1/rule-template-attributes/

Example URI

GET /research-sys/api/v1/rule-template-attributes/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Rule Template Attributes.md"
transfer-encoding: chunked

Update Rule Template Attributes
PUT/research-sys/api/v1/rule-template-attributes/(key)

Example URI

PUT /research-sys/api/v1/rule-template-attributes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "ruleAttributeId": "(val)",
  "required": "(val)",
  "active": "(val)",
  "displayOrder": "(val)",
  "defaultValue": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Rule Template Attributes
PUT/research-sys/api/v1/rule-template-attributes/

Example URI

PUT /research-sys/api/v1/rule-template-attributes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "ruleAttributeId": "(val)",
    "required": "(val)",
    "active": "(val)",
    "displayOrder": "(val)",
    "defaultValue": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "ruleAttributeId": "(val)",
    "required": "(val)",
    "active": "(val)",
    "displayOrder": "(val)",
    "defaultValue": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Rule Template Attributes
PATCH/research-sys/api/v1/rule-template-attributes/(key)

Example URI

PATCH /research-sys/api/v1/rule-template-attributes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "ruleAttributeId": "(val)",
  "required": "(val)",
  "active": "(val)",
  "displayOrder": "(val)",
  "defaultValue": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "ruleAttributeId": "(val)",
  "required": "(val)",
  "active": "(val)",
  "displayOrder": "(val)",
  "defaultValue": "(val)",
  "_primaryKey": "(val)"
}

Insert Rule Template Attributes
POST/research-sys/api/v1/rule-template-attributes/

Example URI

POST /research-sys/api/v1/rule-template-attributes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "ruleAttributeId": "(val)",
  "required": "(val)",
  "active": "(val)",
  "displayOrder": "(val)",
  "defaultValue": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "ruleAttributeId": "(val)",
  "required": "(val)",
  "active": "(val)",
  "displayOrder": "(val)",
  "defaultValue": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Rule Template Attributes
POST/research-sys/api/v1/rule-template-attributes/

Example URI

POST /research-sys/api/v1/rule-template-attributes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "ruleAttributeId": "(val)",
    "required": "(val)",
    "active": "(val)",
    "displayOrder": "(val)",
    "defaultValue": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "ruleAttributeId": "(val)",
    "required": "(val)",
    "active": "(val)",
    "displayOrder": "(val)",
    "defaultValue": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "ruleAttributeId": "(val)",
    "required": "(val)",
    "active": "(val)",
    "displayOrder": "(val)",
    "defaultValue": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "ruleAttributeId": "(val)",
    "required": "(val)",
    "active": "(val)",
    "displayOrder": "(val)",
    "defaultValue": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Rule Template Attributes by Key
DELETE/research-sys/api/v1/rule-template-attributes/(key)

Example URI

DELETE /research-sys/api/v1/rule-template-attributes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Rule Template Attributes
DELETE/research-sys/api/v1/rule-template-attributes/

Example URI

DELETE /research-sys/api/v1/rule-template-attributes/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Rule Template Attributes with Matching
DELETE/research-sys/api/v1/rule-template-attributes/

Example URI

DELETE /research-sys/api/v1/rule-template-attributes/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 

Id. Maximum length is 30.

ruleAttributeId
string (optional) 

Rule Attribute Id.

required
string (optional) 

Required. Maximum length is 1.

active
string (optional) 

Active Indicator. Maximum length is 1.

displayOrder
string (optional) 

Display Order.

defaultValue
string (optional) 

Default Value.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Rule Template Options

Get Rule Template Options by Key
GET/research-sys/api/v1/rule-template-options/(key)

Example URI

GET /research-sys/api/v1/rule-template-options/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "code": "(val)",
  "value": "(val)",
  "_primaryKey": "(val)"
}

Get All Rule Template Options
GET/research-sys/api/v1/rule-template-options/

Example URI

GET /research-sys/api/v1/rule-template-options/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "code": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "code": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Rule Template Options with Filtering
GET/research-sys/api/v1/rule-template-options/

Example URI

GET /research-sys/api/v1/rule-template-options/
URI Parameters
HideShow
id
string (optional) 
code
string (optional) 
value
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "code": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "code": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Rule Template Options
GET/research-sys/api/v1/rule-template-options/

Example URI

GET /research-sys/api/v1/rule-template-options/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "code",
    "value"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Rule Template Options
GET/research-sys/api/v1/rule-template-options/

Example URI

GET /research-sys/api/v1/rule-template-options/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Rule Template Options.md"
transfer-encoding: chunked

Update Rule Template Options
PUT/research-sys/api/v1/rule-template-options/(key)

Example URI

PUT /research-sys/api/v1/rule-template-options/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "code": "(val)",
  "value": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Rule Template Options
PUT/research-sys/api/v1/rule-template-options/

Example URI

PUT /research-sys/api/v1/rule-template-options/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "code": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "code": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Rule Template Options
PATCH/research-sys/api/v1/rule-template-options/(key)

Example URI

PATCH /research-sys/api/v1/rule-template-options/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "code": "(val)",
  "value": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "code": "(val)",
  "value": "(val)",
  "_primaryKey": "(val)"
}

Insert Rule Template Options
POST/research-sys/api/v1/rule-template-options/

Example URI

POST /research-sys/api/v1/rule-template-options/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "code": "(val)",
  "value": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "code": "(val)",
  "value": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Rule Template Options
POST/research-sys/api/v1/rule-template-options/

Example URI

POST /research-sys/api/v1/rule-template-options/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "code": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "code": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "code": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "code": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Rule Template Options by Key
DELETE/research-sys/api/v1/rule-template-options/(key)

Example URI

DELETE /research-sys/api/v1/rule-template-options/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Rule Template Options
DELETE/research-sys/api/v1/rule-template-options/

Example URI

DELETE /research-sys/api/v1/rule-template-options/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Rule Template Options with Matching
DELETE/research-sys/api/v1/rule-template-options/

Example URI

DELETE /research-sys/api/v1/rule-template-options/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 
code
string (optional) 
value
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Rule Templates

Get Rule Templates by Key
GET/research-sys/api/v1/rule-templates/(key)

Example URI

GET /research-sys/api/v1/rule-templates/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "name": "(val)",
  "description": "(val)",
  "delegationTemplateId": "(val)",
  "_primaryKey": "(val)"
}

Get All Rule Templates
GET/research-sys/api/v1/rule-templates/

Example URI

GET /research-sys/api/v1/rule-templates/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "delegationTemplateId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "delegationTemplateId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Rule Templates with Filtering
GET/research-sys/api/v1/rule-templates/

Example URI

GET /research-sys/api/v1/rule-templates/
URI Parameters
HideShow
id
string (optional) 

Id. Maximum length is 30.

name
string (optional) 

Name. Maximum length is 250.

description
string (optional) 

Description. Maximum length is 2000.

delegationTemplateId
string (optional) 

Delegation Template Id.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "delegationTemplateId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "delegationTemplateId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Rule Templates
GET/research-sys/api/v1/rule-templates/

Example URI

GET /research-sys/api/v1/rule-templates/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "name",
    "description",
    "delegationTemplateId"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Rule Templates
GET/research-sys/api/v1/rule-templates/

Example URI

GET /research-sys/api/v1/rule-templates/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Rule Templates.md"
transfer-encoding: chunked

Update Rule Templates
PUT/research-sys/api/v1/rule-templates/(key)

Example URI

PUT /research-sys/api/v1/rule-templates/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "name": "(val)",
  "description": "(val)",
  "delegationTemplateId": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Rule Templates
PUT/research-sys/api/v1/rule-templates/

Example URI

PUT /research-sys/api/v1/rule-templates/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "delegationTemplateId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "delegationTemplateId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Rule Templates
PATCH/research-sys/api/v1/rule-templates/(key)

Example URI

PATCH /research-sys/api/v1/rule-templates/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "name": "(val)",
  "description": "(val)",
  "delegationTemplateId": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "name": "(val)",
  "description": "(val)",
  "delegationTemplateId": "(val)",
  "_primaryKey": "(val)"
}

Insert Rule Templates
POST/research-sys/api/v1/rule-templates/

Example URI

POST /research-sys/api/v1/rule-templates/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "name": "(val)",
  "description": "(val)",
  "delegationTemplateId": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "name": "(val)",
  "description": "(val)",
  "delegationTemplateId": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Rule Templates
POST/research-sys/api/v1/rule-templates/

Example URI

POST /research-sys/api/v1/rule-templates/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "delegationTemplateId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "delegationTemplateId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "delegationTemplateId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "description": "(val)",
    "delegationTemplateId": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Rule Templates by Key
DELETE/research-sys/api/v1/rule-templates/(key)

Example URI

DELETE /research-sys/api/v1/rule-templates/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Rule Templates
DELETE/research-sys/api/v1/rule-templates/

Example URI

DELETE /research-sys/api/v1/rule-templates/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Rule Templates with Matching
DELETE/research-sys/api/v1/rule-templates/

Example URI

DELETE /research-sys/api/v1/rule-templates/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 

Id. Maximum length is 30.

name
string (optional) 

Name. Maximum length is 250.

description
string (optional) 

Description. Maximum length is 2000.

delegationTemplateId
string (optional) 

Delegation Template Id.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Rules

Get Rules by Key
GET/research-sys/api/v1/rules/(key)

Example URI

GET /research-sys/api/v1/rules/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "namespace": "(val)",
  "description": "(val)",
  "name": "(val)",
  "typeId": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Get All Rules
GET/research-sys/api/v1/rules/

Example URI

GET /research-sys/api/v1/rules/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "namespace": "(val)",
    "description": "(val)",
    "name": "(val)",
    "typeId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "namespace": "(val)",
    "description": "(val)",
    "name": "(val)",
    "typeId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Rules with Filtering
GET/research-sys/api/v1/rules/

Example URI

GET /research-sys/api/v1/rules/
URI Parameters
HideShow
id
string (optional) 

Rule Id.

namespace
string (optional) 

Namespace.

description
string (optional) 

Description.

name
string (optional) 

Name.

typeId
string (optional) 

Type Id.

active
string (optional) 

This attribute is used to describe whether the associated object is active or inactive. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "namespace": "(val)",
    "description": "(val)",
    "name": "(val)",
    "typeId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "namespace": "(val)",
    "description": "(val)",
    "name": "(val)",
    "typeId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Rules
GET/research-sys/api/v1/rules/

Example URI

GET /research-sys/api/v1/rules/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "namespace",
    "description",
    "name",
    "typeId",
    "active"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Rules
GET/research-sys/api/v1/rules/

Example URI

GET /research-sys/api/v1/rules/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Rules.md"
transfer-encoding: chunked

Update Rules
PUT/research-sys/api/v1/rules/(key)

Example URI

PUT /research-sys/api/v1/rules/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "namespace": "(val)",
  "description": "(val)",
  "name": "(val)",
  "typeId": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Rules
PUT/research-sys/api/v1/rules/

Example URI

PUT /research-sys/api/v1/rules/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "namespace": "(val)",
    "description": "(val)",
    "name": "(val)",
    "typeId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "namespace": "(val)",
    "description": "(val)",
    "name": "(val)",
    "typeId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Rules
PATCH/research-sys/api/v1/rules/(key)

Example URI

PATCH /research-sys/api/v1/rules/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "namespace": "(val)",
  "description": "(val)",
  "name": "(val)",
  "typeId": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "namespace": "(val)",
  "description": "(val)",
  "name": "(val)",
  "typeId": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Rules
POST/research-sys/api/v1/rules/

Example URI

POST /research-sys/api/v1/rules/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "namespace": "(val)",
  "description": "(val)",
  "name": "(val)",
  "typeId": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "namespace": "(val)",
  "description": "(val)",
  "name": "(val)",
  "typeId": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Rules
POST/research-sys/api/v1/rules/

Example URI

POST /research-sys/api/v1/rules/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "namespace": "(val)",
    "description": "(val)",
    "name": "(val)",
    "typeId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "namespace": "(val)",
    "description": "(val)",
    "name": "(val)",
    "typeId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "namespace": "(val)",
    "description": "(val)",
    "name": "(val)",
    "typeId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "namespace": "(val)",
    "description": "(val)",
    "name": "(val)",
    "typeId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Rules by Key
DELETE/research-sys/api/v1/rules/(key)

Example URI

DELETE /research-sys/api/v1/rules/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Rules
DELETE/research-sys/api/v1/rules/

Example URI

DELETE /research-sys/api/v1/rules/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Rules with Matching
DELETE/research-sys/api/v1/rules/

Example URI

DELETE /research-sys/api/v1/rules/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 

Rule Id.

namespace
string (optional) 

Namespace.

description
string (optional) 

Description.

name
string (optional) 

Name.

typeId
string (optional) 

Type Id.

active
string (optional) 

This attribute is used to describe whether the associated object is active or inactive. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Session Documents

Get Session Documents by Key
GET/research-sys/api/v1/session-documents/(key)

Example URI

GET /research-sys/api/v1/session-documents/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "sessionId": "(val)",
  "documentNumber": "(val)",
  "principalId": "(val)",
  "ipAddress": "(val)",
  "lastUpdatedDate": "(val)",
  "serializedDocumentForm": "(val)",
  "encrypted": "(val)",
  "_primaryKey": "(val)"
}

Get All Session Documents
GET/research-sys/api/v1/session-documents/

Example URI

GET /research-sys/api/v1/session-documents/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "sessionId": "(val)",
    "documentNumber": "(val)",
    "principalId": "(val)",
    "ipAddress": "(val)",
    "lastUpdatedDate": "(val)",
    "serializedDocumentForm": "(val)",
    "encrypted": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "sessionId": "(val)",
    "documentNumber": "(val)",
    "principalId": "(val)",
    "ipAddress": "(val)",
    "lastUpdatedDate": "(val)",
    "serializedDocumentForm": "(val)",
    "encrypted": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Session Documents with Filtering
GET/research-sys/api/v1/session-documents/

Example URI

GET /research-sys/api/v1/session-documents/
URI Parameters
HideShow
sessionId
string (optional) 
documentNumber
string (optional) 
principalId
string (optional) 
ipAddress
string (optional) 
lastUpdatedDate
string (optional) 
serializedDocumentForm
string (optional) 
encrypted
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "sessionId": "(val)",
    "documentNumber": "(val)",
    "principalId": "(val)",
    "ipAddress": "(val)",
    "lastUpdatedDate": "(val)",
    "serializedDocumentForm": "(val)",
    "encrypted": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "sessionId": "(val)",
    "documentNumber": "(val)",
    "principalId": "(val)",
    "ipAddress": "(val)",
    "lastUpdatedDate": "(val)",
    "serializedDocumentForm": "(val)",
    "encrypted": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Session Documents
GET/research-sys/api/v1/session-documents/

Example URI

GET /research-sys/api/v1/session-documents/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "sessionId",
    "documentNumber",
    "principalId",
    "ipAddress",
    "lastUpdatedDate",
    "serializedDocumentForm",
    "encrypted"
  ],
  "primaryKey": "documentNumber:ipAddress:principalId:sessionId"
}

Get Blueprint API specification for Session Documents
GET/research-sys/api/v1/session-documents/

Example URI

GET /research-sys/api/v1/session-documents/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Session Documents.md"
transfer-encoding: chunked

Update Session Documents
PUT/research-sys/api/v1/session-documents/(key)

Example URI

PUT /research-sys/api/v1/session-documents/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "sessionId": "(val)",
  "documentNumber": "(val)",
  "principalId": "(val)",
  "ipAddress": "(val)",
  "lastUpdatedDate": "(val)",
  "serializedDocumentForm": "(val)",
  "encrypted": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Session Documents
PUT/research-sys/api/v1/session-documents/

Example URI

PUT /research-sys/api/v1/session-documents/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "sessionId": "(val)",
    "documentNumber": "(val)",
    "principalId": "(val)",
    "ipAddress": "(val)",
    "lastUpdatedDate": "(val)",
    "serializedDocumentForm": "(val)",
    "encrypted": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "sessionId": "(val)",
    "documentNumber": "(val)",
    "principalId": "(val)",
    "ipAddress": "(val)",
    "lastUpdatedDate": "(val)",
    "serializedDocumentForm": "(val)",
    "encrypted": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Session Documents
PATCH/research-sys/api/v1/session-documents/(key)

Example URI

PATCH /research-sys/api/v1/session-documents/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "sessionId": "(val)",
  "documentNumber": "(val)",
  "principalId": "(val)",
  "ipAddress": "(val)",
  "lastUpdatedDate": "(val)",
  "serializedDocumentForm": "(val)",
  "encrypted": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "sessionId": "(val)",
  "documentNumber": "(val)",
  "principalId": "(val)",
  "ipAddress": "(val)",
  "lastUpdatedDate": "(val)",
  "serializedDocumentForm": "(val)",
  "encrypted": "(val)",
  "_primaryKey": "(val)"
}

Insert Session Documents
POST/research-sys/api/v1/session-documents/

Example URI

POST /research-sys/api/v1/session-documents/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "sessionId": "(val)",
  "documentNumber": "(val)",
  "principalId": "(val)",
  "ipAddress": "(val)",
  "lastUpdatedDate": "(val)",
  "serializedDocumentForm": "(val)",
  "encrypted": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "sessionId": "(val)",
  "documentNumber": "(val)",
  "principalId": "(val)",
  "ipAddress": "(val)",
  "lastUpdatedDate": "(val)",
  "serializedDocumentForm": "(val)",
  "encrypted": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Session Documents
POST/research-sys/api/v1/session-documents/

Example URI

POST /research-sys/api/v1/session-documents/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "sessionId": "(val)",
    "documentNumber": "(val)",
    "principalId": "(val)",
    "ipAddress": "(val)",
    "lastUpdatedDate": "(val)",
    "serializedDocumentForm": "(val)",
    "encrypted": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "sessionId": "(val)",
    "documentNumber": "(val)",
    "principalId": "(val)",
    "ipAddress": "(val)",
    "lastUpdatedDate": "(val)",
    "serializedDocumentForm": "(val)",
    "encrypted": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "sessionId": "(val)",
    "documentNumber": "(val)",
    "principalId": "(val)",
    "ipAddress": "(val)",
    "lastUpdatedDate": "(val)",
    "serializedDocumentForm": "(val)",
    "encrypted": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "sessionId": "(val)",
    "documentNumber": "(val)",
    "principalId": "(val)",
    "ipAddress": "(val)",
    "lastUpdatedDate": "(val)",
    "serializedDocumentForm": "(val)",
    "encrypted": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Session Documents by Key
DELETE/research-sys/api/v1/session-documents/(key)

Example URI

DELETE /research-sys/api/v1/session-documents/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Session Documents
DELETE/research-sys/api/v1/session-documents/

Example URI

DELETE /research-sys/api/v1/session-documents/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Session Documents with Matching
DELETE/research-sys/api/v1/session-documents/

Example URI

DELETE /research-sys/api/v1/session-documents/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

sessionId
string (optional) 
documentNumber
string (optional) 
principalId
string (optional) 
ipAddress
string (optional) 
lastUpdatedDate
string (optional) 
serializedDocumentForm
string (optional) 
encrypted
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

States

Get States by Key
GET/research-sys/api/v1/states/(key)

Example URI

GET /research-sys/api/v1/states/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "code": "(val)",
  "countryCode": "(val)",
  "name": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Get All States
GET/research-sys/api/v1/states/

Example URI

GET /research-sys/api/v1/states/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "code": "(val)",
    "countryCode": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "code": "(val)",
    "countryCode": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All States with Filtering
GET/research-sys/api/v1/states/

Example URI

GET /research-sys/api/v1/states/
URI Parameters
HideShow
code
string (optional) 

The two digit code for a state. Maximum length is 2.

countryCode
string (optional) 

The code uniquely identify a country. Maximum length is 2.

name
string (optional) 

The name assigned to this state. Maximum length is 40.

active
string (optional) 

This attribute is used to describe whether the associated object is active or inactive. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "code": "(val)",
    "countryCode": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "code": "(val)",
    "countryCode": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for States
GET/research-sys/api/v1/states/

Example URI

GET /research-sys/api/v1/states/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "code",
    "countryCode",
    "name",
    "active"
  ],
  "primaryKey": "code:countryCode"
}

Get Blueprint API specification for States
GET/research-sys/api/v1/states/

Example URI

GET /research-sys/api/v1/states/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="States.md"
transfer-encoding: chunked

Update States
PUT/research-sys/api/v1/states/(key)

Example URI

PUT /research-sys/api/v1/states/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "code": "(val)",
  "countryCode": "(val)",
  "name": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple States
PUT/research-sys/api/v1/states/

Example URI

PUT /research-sys/api/v1/states/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "code": "(val)",
    "countryCode": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "code": "(val)",
    "countryCode": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes States
PATCH/research-sys/api/v1/states/(key)

Example URI

PATCH /research-sys/api/v1/states/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "code": "(val)",
  "countryCode": "(val)",
  "name": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "code": "(val)",
  "countryCode": "(val)",
  "name": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert States
POST/research-sys/api/v1/states/

Example URI

POST /research-sys/api/v1/states/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "code": "(val)",
  "countryCode": "(val)",
  "name": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "code": "(val)",
  "countryCode": "(val)",
  "name": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple States
POST/research-sys/api/v1/states/

Example URI

POST /research-sys/api/v1/states/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "code": "(val)",
    "countryCode": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "code": "(val)",
    "countryCode": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "code": "(val)",
    "countryCode": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "code": "(val)",
    "countryCode": "(val)",
    "name": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete States by Key
DELETE/research-sys/api/v1/states/(key)

Example URI

DELETE /research-sys/api/v1/states/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All States
DELETE/research-sys/api/v1/states/

Example URI

DELETE /research-sys/api/v1/states/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All States with Matching
DELETE/research-sys/api/v1/states/

Example URI

DELETE /research-sys/api/v1/states/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

code
string (optional) 

The two digit code for a state. Maximum length is 2.

countryCode
string (optional) 

The code uniquely identify a country. Maximum length is 2.

name
string (optional) 

The name assigned to this state. Maximum length is 40.

active
string (optional) 

This attribute is used to describe whether the associated object is active or inactive. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Styles

Get Styles by Key
GET/research-sys/api/v1/styles/(key)

Example URI

GET /research-sys/api/v1/styles/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "name": "(val)",
  "xmlContent": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Get All Styles
GET/research-sys/api/v1/styles/

Example URI

GET /research-sys/api/v1/styles/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "xmlContent": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "xmlContent": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Styles with Filtering
GET/research-sys/api/v1/styles/

Example URI

GET /research-sys/api/v1/styles/
URI Parameters
HideShow
id
string (optional) 

Id. Maximum length is 30.

name
string (optional) 

Style Name. Maximum length is 2000.

xmlContent
string (optional) 

XML Content. Maximum length is 250.

active
string (optional) 

active. Maximum length is 50.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "xmlContent": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "xmlContent": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Styles
GET/research-sys/api/v1/styles/

Example URI

GET /research-sys/api/v1/styles/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "name",
    "xmlContent",
    "active"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Styles
GET/research-sys/api/v1/styles/

Example URI

GET /research-sys/api/v1/styles/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Styles.md"
transfer-encoding: chunked

Update Styles
PUT/research-sys/api/v1/styles/(key)

Example URI

PUT /research-sys/api/v1/styles/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "name": "(val)",
  "xmlContent": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Styles
PUT/research-sys/api/v1/styles/

Example URI

PUT /research-sys/api/v1/styles/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "xmlContent": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "xmlContent": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Styles
PATCH/research-sys/api/v1/styles/(key)

Example URI

PATCH /research-sys/api/v1/styles/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "name": "(val)",
  "xmlContent": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "name": "(val)",
  "xmlContent": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Styles
POST/research-sys/api/v1/styles/

Example URI

POST /research-sys/api/v1/styles/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "name": "(val)",
  "xmlContent": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "name": "(val)",
  "xmlContent": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Styles
POST/research-sys/api/v1/styles/

Example URI

POST /research-sys/api/v1/styles/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "xmlContent": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "xmlContent": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "xmlContent": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "xmlContent": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Styles by Key
DELETE/research-sys/api/v1/styles/(key)

Example URI

DELETE /research-sys/api/v1/styles/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Styles
DELETE/research-sys/api/v1/styles/

Example URI

DELETE /research-sys/api/v1/styles/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Styles with Matching
DELETE/research-sys/api/v1/styles/

Example URI

DELETE /research-sys/api/v1/styles/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 

Id. Maximum length is 30.

name
string (optional) 

Style Name. Maximum length is 2000.

xmlContent
string (optional) 

XML Content. Maximum length is 250.

active
string (optional) 

active. Maximum length is 50.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Term Parameters

Get Term Parameters by Key
GET/research-sys/api/v1/term-parameters/(key)

Example URI

GET /research-sys/api/v1/term-parameters/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "name": "(val)",
  "value": "(val)",
  "_primaryKey": "(val)"
}

Get All Term Parameters
GET/research-sys/api/v1/term-parameters/

Example URI

GET /research-sys/api/v1/term-parameters/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Term Parameters with Filtering
GET/research-sys/api/v1/term-parameters/

Example URI

GET /research-sys/api/v1/term-parameters/
URI Parameters
HideShow
id
string (optional) 

Term Parameter Id.

name
string (optional) 

Term Parameter Name.

value
string (optional) 

Term Parameter Value.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Term Parameters
GET/research-sys/api/v1/term-parameters/

Example URI

GET /research-sys/api/v1/term-parameters/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "name",
    "value"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Term Parameters
GET/research-sys/api/v1/term-parameters/

Example URI

GET /research-sys/api/v1/term-parameters/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Term Parameters.md"
transfer-encoding: chunked

Update Term Parameters
PUT/research-sys/api/v1/term-parameters/(key)

Example URI

PUT /research-sys/api/v1/term-parameters/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "name": "(val)",
  "value": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Term Parameters
PUT/research-sys/api/v1/term-parameters/

Example URI

PUT /research-sys/api/v1/term-parameters/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Term Parameters
PATCH/research-sys/api/v1/term-parameters/(key)

Example URI

PATCH /research-sys/api/v1/term-parameters/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "name": "(val)",
  "value": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "name": "(val)",
  "value": "(val)",
  "_primaryKey": "(val)"
}

Insert Term Parameters
POST/research-sys/api/v1/term-parameters/

Example URI

POST /research-sys/api/v1/term-parameters/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "name": "(val)",
  "value": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "name": "(val)",
  "value": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Term Parameters
POST/research-sys/api/v1/term-parameters/

Example URI

POST /research-sys/api/v1/term-parameters/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Term Parameters by Key
DELETE/research-sys/api/v1/term-parameters/(key)

Example URI

DELETE /research-sys/api/v1/term-parameters/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Term Parameters
DELETE/research-sys/api/v1/term-parameters/

Example URI

DELETE /research-sys/api/v1/term-parameters/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Term Parameters with Matching
DELETE/research-sys/api/v1/term-parameters/

Example URI

DELETE /research-sys/api/v1/term-parameters/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 

Term Parameter Id.

name
string (optional) 

Term Parameter Name.

value
string (optional) 

Term Parameter Value.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Term Resolver Attributes

Get Term Resolver Attributes by Key
GET/research-sys/api/v1/term-resolver-attributes/(key)

Example URI

GET /research-sys/api/v1/term-resolver-attributes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "termResolverId": "(val)",
  "value": "(val)",
  "_primaryKey": "(val)"
}

Get All Term Resolver Attributes
GET/research-sys/api/v1/term-resolver-attributes/

Example URI

GET /research-sys/api/v1/term-resolver-attributes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "termResolverId": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "termResolverId": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Term Resolver Attributes with Filtering
GET/research-sys/api/v1/term-resolver-attributes/

Example URI

GET /research-sys/api/v1/term-resolver-attributes/
URI Parameters
HideShow
id
string (optional) 
termResolverId
string (optional) 
value
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "termResolverId": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "termResolverId": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Term Resolver Attributes
GET/research-sys/api/v1/term-resolver-attributes/

Example URI

GET /research-sys/api/v1/term-resolver-attributes/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "termResolverId",
    "value"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Term Resolver Attributes
GET/research-sys/api/v1/term-resolver-attributes/

Example URI

GET /research-sys/api/v1/term-resolver-attributes/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Term Resolver Attributes.md"
transfer-encoding: chunked

Update Term Resolver Attributes
PUT/research-sys/api/v1/term-resolver-attributes/(key)

Example URI

PUT /research-sys/api/v1/term-resolver-attributes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "termResolverId": "(val)",
  "value": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Term Resolver Attributes
PUT/research-sys/api/v1/term-resolver-attributes/

Example URI

PUT /research-sys/api/v1/term-resolver-attributes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "termResolverId": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "termResolverId": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Term Resolver Attributes
PATCH/research-sys/api/v1/term-resolver-attributes/(key)

Example URI

PATCH /research-sys/api/v1/term-resolver-attributes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "termResolverId": "(val)",
  "value": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "termResolverId": "(val)",
  "value": "(val)",
  "_primaryKey": "(val)"
}

Insert Term Resolver Attributes
POST/research-sys/api/v1/term-resolver-attributes/

Example URI

POST /research-sys/api/v1/term-resolver-attributes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "termResolverId": "(val)",
  "value": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "termResolverId": "(val)",
  "value": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Term Resolver Attributes
POST/research-sys/api/v1/term-resolver-attributes/

Example URI

POST /research-sys/api/v1/term-resolver-attributes/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "termResolverId": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "termResolverId": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "termResolverId": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "termResolverId": "(val)",
    "value": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Term Resolver Attributes by Key
DELETE/research-sys/api/v1/term-resolver-attributes/(key)

Example URI

DELETE /research-sys/api/v1/term-resolver-attributes/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Term Resolver Attributes
DELETE/research-sys/api/v1/term-resolver-attributes/

Example URI

DELETE /research-sys/api/v1/term-resolver-attributes/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Term Resolver Attributes with Matching
DELETE/research-sys/api/v1/term-resolver-attributes/

Example URI

DELETE /research-sys/api/v1/term-resolver-attributes/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 
termResolverId
string (optional) 
value
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Term Resolver Parameter Specifications

Get Term Resolver Parameter Specifications by Key
GET/research-sys/api/v1/term-resolver-parameter-specifications/(key)

Example URI

GET /research-sys/api/v1/term-resolver-parameter-specifications/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "name": "(val)",
  "_primaryKey": "(val)"
}

Get All Term Resolver Parameter Specifications
GET/research-sys/api/v1/term-resolver-parameter-specifications/

Example URI

GET /research-sys/api/v1/term-resolver-parameter-specifications/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Term Resolver Parameter Specifications with Filtering
GET/research-sys/api/v1/term-resolver-parameter-specifications/

Example URI

GET /research-sys/api/v1/term-resolver-parameter-specifications/
URI Parameters
HideShow
id
string (optional) 
name
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Term Resolver Parameter Specifications
GET/research-sys/api/v1/term-resolver-parameter-specifications/

Example URI

GET /research-sys/api/v1/term-resolver-parameter-specifications/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "name"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Term Resolver Parameter Specifications
GET/research-sys/api/v1/term-resolver-parameter-specifications/

Example URI

GET /research-sys/api/v1/term-resolver-parameter-specifications/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Term Resolver Parameter Specifications.md"
transfer-encoding: chunked

Update Term Resolver Parameter Specifications
PUT/research-sys/api/v1/term-resolver-parameter-specifications/(key)

Example URI

PUT /research-sys/api/v1/term-resolver-parameter-specifications/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "name": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Term Resolver Parameter Specifications
PUT/research-sys/api/v1/term-resolver-parameter-specifications/

Example URI

PUT /research-sys/api/v1/term-resolver-parameter-specifications/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Term Resolver Parameter Specifications
PATCH/research-sys/api/v1/term-resolver-parameter-specifications/(key)

Example URI

PATCH /research-sys/api/v1/term-resolver-parameter-specifications/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "name": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "name": "(val)",
  "_primaryKey": "(val)"
}

Insert Term Resolver Parameter Specifications
POST/research-sys/api/v1/term-resolver-parameter-specifications/

Example URI

POST /research-sys/api/v1/term-resolver-parameter-specifications/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "name": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "name": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Term Resolver Parameter Specifications
POST/research-sys/api/v1/term-resolver-parameter-specifications/

Example URI

POST /research-sys/api/v1/term-resolver-parameter-specifications/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Term Resolver Parameter Specifications by Key
DELETE/research-sys/api/v1/term-resolver-parameter-specifications/(key)

Example URI

DELETE /research-sys/api/v1/term-resolver-parameter-specifications/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Term Resolver Parameter Specifications
DELETE/research-sys/api/v1/term-resolver-parameter-specifications/

Example URI

DELETE /research-sys/api/v1/term-resolver-parameter-specifications/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Term Resolver Parameter Specifications with Matching
DELETE/research-sys/api/v1/term-resolver-parameter-specifications/

Example URI

DELETE /research-sys/api/v1/term-resolver-parameter-specifications/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 
name
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Term Resolvers

Get Term Resolvers by Key
GET/research-sys/api/v1/term-resolvers/(key)

Example URI

GET /research-sys/api/v1/term-resolvers/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "namespace": "(val)",
  "name": "(val)",
  "typeId": "(val)",
  "outputId": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Get All Term Resolvers
GET/research-sys/api/v1/term-resolvers/

Example URI

GET /research-sys/api/v1/term-resolvers/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "namespace": "(val)",
    "name": "(val)",
    "typeId": "(val)",
    "outputId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "namespace": "(val)",
    "name": "(val)",
    "typeId": "(val)",
    "outputId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Term Resolvers with Filtering
GET/research-sys/api/v1/term-resolvers/

Example URI

GET /research-sys/api/v1/term-resolvers/
URI Parameters
HideShow
id
string (optional) 
namespace
string (optional) 
name
string (optional) 
typeId
string (optional) 
outputId
string (optional) 
active
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "namespace": "(val)",
    "name": "(val)",
    "typeId": "(val)",
    "outputId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "namespace": "(val)",
    "name": "(val)",
    "typeId": "(val)",
    "outputId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Term Resolvers
GET/research-sys/api/v1/term-resolvers/

Example URI

GET /research-sys/api/v1/term-resolvers/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "namespace",
    "name",
    "typeId",
    "outputId",
    "active"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Term Resolvers
GET/research-sys/api/v1/term-resolvers/

Example URI

GET /research-sys/api/v1/term-resolvers/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Term Resolvers.md"
transfer-encoding: chunked

Update Term Resolvers
PUT/research-sys/api/v1/term-resolvers/(key)

Example URI

PUT /research-sys/api/v1/term-resolvers/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "namespace": "(val)",
  "name": "(val)",
  "typeId": "(val)",
  "outputId": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Term Resolvers
PUT/research-sys/api/v1/term-resolvers/

Example URI

PUT /research-sys/api/v1/term-resolvers/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "namespace": "(val)",
    "name": "(val)",
    "typeId": "(val)",
    "outputId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "namespace": "(val)",
    "name": "(val)",
    "typeId": "(val)",
    "outputId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Term Resolvers
PATCH/research-sys/api/v1/term-resolvers/(key)

Example URI

PATCH /research-sys/api/v1/term-resolvers/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "namespace": "(val)",
  "name": "(val)",
  "typeId": "(val)",
  "outputId": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "namespace": "(val)",
  "name": "(val)",
  "typeId": "(val)",
  "outputId": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Term Resolvers
POST/research-sys/api/v1/term-resolvers/

Example URI

POST /research-sys/api/v1/term-resolvers/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "namespace": "(val)",
  "name": "(val)",
  "typeId": "(val)",
  "outputId": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "namespace": "(val)",
  "name": "(val)",
  "typeId": "(val)",
  "outputId": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Term Resolvers
POST/research-sys/api/v1/term-resolvers/

Example URI

POST /research-sys/api/v1/term-resolvers/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "namespace": "(val)",
    "name": "(val)",
    "typeId": "(val)",
    "outputId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "namespace": "(val)",
    "name": "(val)",
    "typeId": "(val)",
    "outputId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "namespace": "(val)",
    "name": "(val)",
    "typeId": "(val)",
    "outputId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "namespace": "(val)",
    "name": "(val)",
    "typeId": "(val)",
    "outputId": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Term Resolvers by Key
DELETE/research-sys/api/v1/term-resolvers/(key)

Example URI

DELETE /research-sys/api/v1/term-resolvers/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Term Resolvers
DELETE/research-sys/api/v1/term-resolvers/

Example URI

DELETE /research-sys/api/v1/term-resolvers/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Term Resolvers with Matching
DELETE/research-sys/api/v1/term-resolvers/

Example URI

DELETE /research-sys/api/v1/term-resolvers/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 
namespace
string (optional) 
name
string (optional) 
typeId
string (optional) 
outputId
string (optional) 
active
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Term Specifications

Get Term Specifications by Key
GET/research-sys/api/v1/term-specifications/(key)

Example URI

GET /research-sys/api/v1/term-specifications/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "name": "(val)",
  "namespace": "(val)",
  "type": "(val)",
  "description": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Get All Term Specifications
GET/research-sys/api/v1/term-specifications/

Example URI

GET /research-sys/api/v1/term-specifications/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "type": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "type": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Term Specifications with Filtering
GET/research-sys/api/v1/term-specifications/

Example URI

GET /research-sys/api/v1/term-specifications/
URI Parameters
HideShow
id
string (optional) 

ID.

name
string (optional) 

Name.

namespace
string (optional) 

Namespace.

type
string (optional) 

Data Type.

description
string (optional) 

Description.

active
string (optional) 

This attribute is used to describe whether the associated object is active or inactive. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "type": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "type": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Term Specifications
GET/research-sys/api/v1/term-specifications/

Example URI

GET /research-sys/api/v1/term-specifications/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "name",
    "namespace",
    "type",
    "description",
    "active"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Term Specifications
GET/research-sys/api/v1/term-specifications/

Example URI

GET /research-sys/api/v1/term-specifications/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Term Specifications.md"
transfer-encoding: chunked

Update Term Specifications
PUT/research-sys/api/v1/term-specifications/(key)

Example URI

PUT /research-sys/api/v1/term-specifications/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "name": "(val)",
  "namespace": "(val)",
  "type": "(val)",
  "description": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Term Specifications
PUT/research-sys/api/v1/term-specifications/

Example URI

PUT /research-sys/api/v1/term-specifications/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "type": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "type": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Term Specifications
PATCH/research-sys/api/v1/term-specifications/(key)

Example URI

PATCH /research-sys/api/v1/term-specifications/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "name": "(val)",
  "namespace": "(val)",
  "type": "(val)",
  "description": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "name": "(val)",
  "namespace": "(val)",
  "type": "(val)",
  "description": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Term Specifications
POST/research-sys/api/v1/term-specifications/

Example URI

POST /research-sys/api/v1/term-specifications/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "name": "(val)",
  "namespace": "(val)",
  "type": "(val)",
  "description": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "name": "(val)",
  "namespace": "(val)",
  "type": "(val)",
  "description": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Term Specifications
POST/research-sys/api/v1/term-specifications/

Example URI

POST /research-sys/api/v1/term-specifications/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "type": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "type": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "type": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "name": "(val)",
    "namespace": "(val)",
    "type": "(val)",
    "description": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Term Specifications by Key
DELETE/research-sys/api/v1/term-specifications/(key)

Example URI

DELETE /research-sys/api/v1/term-specifications/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Term Specifications
DELETE/research-sys/api/v1/term-specifications/

Example URI

DELETE /research-sys/api/v1/term-specifications/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Term Specifications with Matching
DELETE/research-sys/api/v1/term-specifications/

Example URI

DELETE /research-sys/api/v1/term-specifications/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 

ID.

name
string (optional) 

Name.

namespace
string (optional) 

Namespace.

type
string (optional) 

Data Type.

description
string (optional) 

Description.

active
string (optional) 

This attribute is used to describe whether the associated object is active or inactive. Maximum length is 1.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Terms

Get Terms by Key
GET/research-sys/api/v1/terms/(key)

Example URI

GET /research-sys/api/v1/terms/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "specificationId": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Get All Terms
GET/research-sys/api/v1/terms/

Example URI

GET /research-sys/api/v1/terms/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "specificationId": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "specificationId": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Terms with Filtering
GET/research-sys/api/v1/terms/

Example URI

GET /research-sys/api/v1/terms/
URI Parameters
HideShow
id
string (optional) 

ID.

specificationId
string (optional) 

Specification Id.

description
string (optional) 

Description.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "specificationId": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "specificationId": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Terms
GET/research-sys/api/v1/terms/

Example URI

GET /research-sys/api/v1/terms/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "specificationId",
    "description"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Terms
GET/research-sys/api/v1/terms/

Example URI

GET /research-sys/api/v1/terms/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Terms.md"
transfer-encoding: chunked

Update Terms
PUT/research-sys/api/v1/terms/(key)

Example URI

PUT /research-sys/api/v1/terms/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "specificationId": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Terms
PUT/research-sys/api/v1/terms/

Example URI

PUT /research-sys/api/v1/terms/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "specificationId": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "specificationId": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Terms
PATCH/research-sys/api/v1/terms/(key)

Example URI

PATCH /research-sys/api/v1/terms/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "specificationId": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "specificationId": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Terms
POST/research-sys/api/v1/terms/

Example URI

POST /research-sys/api/v1/terms/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "specificationId": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "specificationId": "(val)",
  "description": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Terms
POST/research-sys/api/v1/terms/

Example URI

POST /research-sys/api/v1/terms/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "specificationId": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "specificationId": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "specificationId": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "specificationId": "(val)",
    "description": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Terms by Key
DELETE/research-sys/api/v1/terms/(key)

Example URI

DELETE /research-sys/api/v1/terms/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Terms
DELETE/research-sys/api/v1/terms/

Example URI

DELETE /research-sys/api/v1/terms/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Terms with Matching
DELETE/research-sys/api/v1/terms/

Example URI

DELETE /research-sys/api/v1/terms/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 

ID.

specificationId
string (optional) 

Specification Id.

description
string (optional) 

Description.

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Type Type Relations

Get Type Type Relations by Key
GET/research-sys/api/v1/type-type-relations/(key)

Example URI

GET /research-sys/api/v1/type-type-relations/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "fromTypeId": "(val)",
  "toTypeId": "(val)",
  "relationshipType": "(val)",
  "sequenceNumber": "(val)",
  "id": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Get All Type Type Relations
GET/research-sys/api/v1/type-type-relations/

Example URI

GET /research-sys/api/v1/type-type-relations/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "fromTypeId": "(val)",
    "toTypeId": "(val)",
    "relationshipType": "(val)",
    "sequenceNumber": "(val)",
    "id": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "fromTypeId": "(val)",
    "toTypeId": "(val)",
    "relationshipType": "(val)",
    "sequenceNumber": "(val)",
    "id": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All Type Type Relations with Filtering
GET/research-sys/api/v1/type-type-relations/

Example URI

GET /research-sys/api/v1/type-type-relations/
URI Parameters
HideShow
fromTypeId
string (optional) 
toTypeId
string (optional) 
relationshipType
string (optional) 
sequenceNumber
string (optional) 
id
string (optional) 
active
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "fromTypeId": "(val)",
    "toTypeId": "(val)",
    "relationshipType": "(val)",
    "sequenceNumber": "(val)",
    "id": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "fromTypeId": "(val)",
    "toTypeId": "(val)",
    "relationshipType": "(val)",
    "sequenceNumber": "(val)",
    "id": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for Type Type Relations
GET/research-sys/api/v1/type-type-relations/

Example URI

GET /research-sys/api/v1/type-type-relations/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "fromTypeId",
    "toTypeId",
    "relationshipType",
    "sequenceNumber",
    "id",
    "active"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for Type Type Relations
GET/research-sys/api/v1/type-type-relations/

Example URI

GET /research-sys/api/v1/type-type-relations/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="Type Type Relations.md"
transfer-encoding: chunked

Update Type Type Relations
PUT/research-sys/api/v1/type-type-relations/(key)

Example URI

PUT /research-sys/api/v1/type-type-relations/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "fromTypeId": "(val)",
  "toTypeId": "(val)",
  "relationshipType": "(val)",
  "sequenceNumber": "(val)",
  "id": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple Type Type Relations
PUT/research-sys/api/v1/type-type-relations/

Example URI

PUT /research-sys/api/v1/type-type-relations/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "fromTypeId": "(val)",
    "toTypeId": "(val)",
    "relationshipType": "(val)",
    "sequenceNumber": "(val)",
    "id": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "fromTypeId": "(val)",
    "toTypeId": "(val)",
    "relationshipType": "(val)",
    "sequenceNumber": "(val)",
    "id": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes Type Type Relations
PATCH/research-sys/api/v1/type-type-relations/(key)

Example URI

PATCH /research-sys/api/v1/type-type-relations/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "fromTypeId": "(val)",
  "toTypeId": "(val)",
  "relationshipType": "(val)",
  "sequenceNumber": "(val)",
  "id": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "fromTypeId": "(val)",
  "toTypeId": "(val)",
  "relationshipType": "(val)",
  "sequenceNumber": "(val)",
  "id": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Type Type Relations
POST/research-sys/api/v1/type-type-relations/

Example URI

POST /research-sys/api/v1/type-type-relations/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "fromTypeId": "(val)",
  "toTypeId": "(val)",
  "relationshipType": "(val)",
  "sequenceNumber": "(val)",
  "id": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "fromTypeId": "(val)",
  "toTypeId": "(val)",
  "relationshipType": "(val)",
  "sequenceNumber": "(val)",
  "id": "(val)",
  "active": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple Type Type Relations
POST/research-sys/api/v1/type-type-relations/

Example URI

POST /research-sys/api/v1/type-type-relations/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "fromTypeId": "(val)",
    "toTypeId": "(val)",
    "relationshipType": "(val)",
    "sequenceNumber": "(val)",
    "id": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "fromTypeId": "(val)",
    "toTypeId": "(val)",
    "relationshipType": "(val)",
    "sequenceNumber": "(val)",
    "id": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "fromTypeId": "(val)",
    "toTypeId": "(val)",
    "relationshipType": "(val)",
    "sequenceNumber": "(val)",
    "id": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "fromTypeId": "(val)",
    "toTypeId": "(val)",
    "relationshipType": "(val)",
    "sequenceNumber": "(val)",
    "id": "(val)",
    "active": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete Type Type Relations by Key
DELETE/research-sys/api/v1/type-type-relations/(key)

Example URI

DELETE /research-sys/api/v1/type-type-relations/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Type Type Relations
DELETE/research-sys/api/v1/type-type-relations/

Example URI

DELETE /research-sys/api/v1/type-type-relations/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All Type Type Relations with Matching
DELETE/research-sys/api/v1/type-type-relations/

Example URI

DELETE /research-sys/api/v1/type-type-relations/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

fromTypeId
string (optional) 
toTypeId
string (optional) 
relationshipType
string (optional) 
sequenceNumber
string (optional) 
id
string (optional) 
active
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

User Channel Subscriptions

Get User Channel Subscriptions by Key
GET/research-sys/api/v1/user-channel-subscriptions/(key)

Example URI

GET /research-sys/api/v1/user-channel-subscriptions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "id": "(val)",
  "userId": "(val)",
  "_primaryKey": "(val)"
}

Get All User Channel Subscriptions
GET/research-sys/api/v1/user-channel-subscriptions/

Example URI

GET /research-sys/api/v1/user-channel-subscriptions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "userId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "userId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All User Channel Subscriptions with Filtering
GET/research-sys/api/v1/user-channel-subscriptions/

Example URI

GET /research-sys/api/v1/user-channel-subscriptions/
URI Parameters
HideShow
id
string (optional) 
userId
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "id": "(val)",
    "userId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "userId": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for User Channel Subscriptions
GET/research-sys/api/v1/user-channel-subscriptions/

Example URI

GET /research-sys/api/v1/user-channel-subscriptions/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "id",
    "userId"
  ],
  "primaryKey": "id"
}

Get Blueprint API specification for User Channel Subscriptions
GET/research-sys/api/v1/user-channel-subscriptions/

Example URI

GET /research-sys/api/v1/user-channel-subscriptions/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="User Channel Subscriptions.md"
transfer-encoding: chunked

Update User Channel Subscriptions
PUT/research-sys/api/v1/user-channel-subscriptions/(key)

Example URI

PUT /research-sys/api/v1/user-channel-subscriptions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "userId": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple User Channel Subscriptions
PUT/research-sys/api/v1/user-channel-subscriptions/

Example URI

PUT /research-sys/api/v1/user-channel-subscriptions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "userId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "userId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes User Channel Subscriptions
PATCH/research-sys/api/v1/user-channel-subscriptions/(key)

Example URI

PATCH /research-sys/api/v1/user-channel-subscriptions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "userId": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "id": "(val)",
  "userId": "(val)",
  "_primaryKey": "(val)"
}

Insert User Channel Subscriptions
POST/research-sys/api/v1/user-channel-subscriptions/

Example URI

POST /research-sys/api/v1/user-channel-subscriptions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "id": "(val)",
  "userId": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "id": "(val)",
  "userId": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple User Channel Subscriptions
POST/research-sys/api/v1/user-channel-subscriptions/

Example URI

POST /research-sys/api/v1/user-channel-subscriptions/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "id": "(val)",
    "userId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "userId": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "id": "(val)",
    "userId": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "id": "(val)",
    "userId": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete User Channel Subscriptions by Key
DELETE/research-sys/api/v1/user-channel-subscriptions/(key)

Example URI

DELETE /research-sys/api/v1/user-channel-subscriptions/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All User Channel Subscriptions
DELETE/research-sys/api/v1/user-channel-subscriptions/

Example URI

DELETE /research-sys/api/v1/user-channel-subscriptions/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All User Channel Subscriptions with Matching
DELETE/research-sys/api/v1/user-channel-subscriptions/

Example URI

DELETE /research-sys/api/v1/user-channel-subscriptions/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

id
string (optional) 
userId
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

User Options

Get User Options by Key
GET/research-sys/api/v1/user-options/(key)

Example URI

GET /research-sys/api/v1/user-options/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "workflowId": "(val)",
  "optionId": "(val)",
  "optionVal": "(val)",
  "lockVerNbr": "(val)",
  "_primaryKey": "(val)"
}

Get All User Options
GET/research-sys/api/v1/user-options/

Example URI

GET /research-sys/api/v1/user-options/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "workflowId": "(val)",
    "optionId": "(val)",
    "optionVal": "(val)",
    "lockVerNbr": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "workflowId": "(val)",
    "optionId": "(val)",
    "optionVal": "(val)",
    "lockVerNbr": "(val)",
    "_primaryKey": "(val)"
  }
]

Get All User Options with Filtering
GET/research-sys/api/v1/user-options/

Example URI

GET /research-sys/api/v1/user-options/
URI Parameters
HideShow
workflowId
string (optional) 
optionId
string (optional) 
optionVal
string (optional) 
lockVerNbr
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
[
  {
    "workflowId": "(val)",
    "optionId": "(val)",
    "optionVal": "(val)",
    "lockVerNbr": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "workflowId": "(val)",
    "optionId": "(val)",
    "optionVal": "(val)",
    "lockVerNbr": "(val)",
    "_primaryKey": "(val)"
  }
]

Get Schema for User Options
GET/research-sys/api/v1/user-options/

Example URI

GET /research-sys/api/v1/user-options/
URI Parameters
HideShow
_schema
string (required) 

will instruct the endpoint to return a schema data structure for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json;charset=UTF-8
Body
{
  "columns": [
    "workflowId",
    "optionId",
    "optionVal",
    "lockVerNbr"
  ],
  "primaryKey": "optionId:workflowId"
}

Get Blueprint API specification for User Options
GET/research-sys/api/v1/user-options/

Example URI

GET /research-sys/api/v1/user-options/
URI Parameters
HideShow
_blueprint
string (required) 

will instruct the endpoint to return an api blueprint markdown file for the resource

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: text/markdown
Response  200
HideShow
Headers
Content-Type: text/markdown;charset=UTF-8
Content-Disposition: attachment; filename="User Options.md"
transfer-encoding: chunked

Update User Options
PUT/research-sys/api/v1/user-options/(key)

Example URI

PUT /research-sys/api/v1/user-options/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "workflowId": "(val)",
  "optionId": "(val)",
  "optionVal": "(val)",
  "lockVerNbr": "(val)",
  "_primaryKey": "(val)"
}
Response  204

Update Multiple User Options
PUT/research-sys/api/v1/user-options/

Example URI

PUT /research-sys/api/v1/user-options/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "workflowId": "(val)",
    "optionId": "(val)",
    "optionVal": "(val)",
    "lockVerNbr": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "workflowId": "(val)",
    "optionId": "(val)",
    "optionVal": "(val)",
    "lockVerNbr": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  204

Update Specific Attributes User Options
PATCH/research-sys/api/v1/user-options/(key)

Example URI

PATCH /research-sys/api/v1/user-options/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "workflowId": "(val)",
  "optionId": "(val)",
  "optionVal": "(val)",
  "lockVerNbr": "(val)",
  "_primaryKey": "(val)"
}
Response  204
HideShow
Body
{
  "workflowId": "(val)",
  "optionId": "(val)",
  "optionVal": "(val)",
  "lockVerNbr": "(val)",
  "_primaryKey": "(val)"
}

Insert User Options
POST/research-sys/api/v1/user-options/

Example URI

POST /research-sys/api/v1/user-options/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
{
  "workflowId": "(val)",
  "optionId": "(val)",
  "optionVal": "(val)",
  "lockVerNbr": "(val)",
  "_primaryKey": "(val)"
}
Response  201
HideShow
Body
{
  "workflowId": "(val)",
  "optionId": "(val)",
  "optionVal": "(val)",
  "lockVerNbr": "(val)",
  "_primaryKey": "(val)"
}

Insert Multiple User Options
POST/research-sys/api/v1/user-options/

Example URI

POST /research-sys/api/v1/user-options/
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Body
[
  {
    "workflowId": "(val)",
    "optionId": "(val)",
    "optionVal": "(val)",
    "lockVerNbr": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "workflowId": "(val)",
    "optionId": "(val)",
    "optionVal": "(val)",
    "lockVerNbr": "(val)",
    "_primaryKey": "(val)"
  }
]
Response  201
HideShow
Body
[
  {
    "workflowId": "(val)",
    "optionId": "(val)",
    "optionVal": "(val)",
    "lockVerNbr": "(val)",
    "_primaryKey": "(val)"
  },
  {
    "workflowId": "(val)",
    "optionId": "(val)",
    "optionVal": "(val)",
    "lockVerNbr": "(val)",
    "_primaryKey": "(val)"
  }
]

Delete User Options by Key
DELETE/research-sys/api/v1/user-options/(key)

Example URI

DELETE /research-sys/api/v1/user-options/(key)
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All User Options
DELETE/research-sys/api/v1/user-options/

Example URI

DELETE /research-sys/api/v1/user-options/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Delete All User Options with Matching
DELETE/research-sys/api/v1/user-options/

Example URI

DELETE /research-sys/api/v1/user-options/
URI Parameters
HideShow
_allowMulti
boolean (required) 

flag to allow multiple resources to be deleted in one operation

workflowId
string (optional) 
optionId
string (optional) 
optionVal
string (optional) 
lockVerNbr
string (optional) 
Request
HideShow
Headers
Authorization: Bearer {api-key}
Content-Type: application/json
Response  204

Generated by aglio on 31 Oct 2019