Back to top

PeopleSpheres API

Main (core) API for interaction with form, fields and other core things

Authorization

Most part of endpoints protected with authorization mechanism. To authenticate your request you need to obtain authentication token in SSO service. We are using KeyCloak as SSO server. Read motre about aouthorization in KeyCloak docs. This token should be passed with Authorization header.

Authentication header example: Authorization: Bearer KeyCloakTokenString

Please note - endpoints that requires authorization marked with small locker icon

API Versioning:

All API endpoints supports API versioning. To specify it you need to pass Accept header Example: Accept: application/vnd.monportail.v1+json

Supported versions:

  • v1

Detailed info about versions and difference between them will be specified for each API endpoint

Client Versioning

In order to not support outdated and legacy API endpoint for a long time every client must send specific header. This header need to know what is the app version. API will use it to figure out if it can handle this app or not

Header: X-Application-Version: <client-name>/<version>

  • client-name - one of ios or android

  • version - client version. It must be semantic version

Examples:

  • X-Application-Version: ios/1.0.0

  • X-Application-Version: android/4.67.15

Request

Different APIs requires different request. Each request described in related API section. Definition for each request object we use can be found in Models section (bottom of the page)

Includes

In order to improve performance and give more control on response to cliend side Most part of GET requests supports include option. It is optional and can be specified with as a query part of URL. It may has comaseparated list of relations that need to be presented in response. Each API has their own set of relations that will be listed for each API individually. Includes supports kind of inheritanse. For example if you need to get in response fields relation with type for all items it can be done as include=fields,fields.type

Examples: /fields?include=items,category /form/123?include=fields,fields.items,fields.category

Response

Each response (no matter if it single item or a list of items) wrapped with data node.

Each response comes with successful http code:

  • 200 - means request completed successfully. Usually contains data in body

  • 201 - means new entity created successfully. Usually contains id of created entity in body

  • 202 - means entity was successfully updated. Usually contains no data in body

  • 204 - means there are no data to return. Usually happens for completed DELETE requests Definition for each response object we use can be found in Models section (bottom of the page)

Example : Response with single object

{
    'data': {
        //...
    }
}

Response with list of objects

{
    'data': [
        {
            //...
        },
        {
            //...
        },
        ...
    ]
}

Data representation (mapping)

  • integer - number

  • float|double - number

  • string - string

  • date - string, always formatted as YYYY-MM-DD HH:mm:ss. No timezone specified. Timezone always UTC.

Pagination

To increase performance most part of lists supports pagination. It means that response will contain only limited number of items and special meta node (same level data node located) with pagination info. Example structure

{
   'data': [...],
   'meta': {
       'pagination': {
           'total': 238,
           'count': 25,
           'per_page': 25,
           'current_page': 2,
           'total_pages': 10,
           'links': {
               'previous': 'http://example.com/api/users?page=1'
               'next': 'http://example.com/api/users?page=3'
           }
       }
   }
}

Please note that this meta node optional and appears ONLY if endpoint supports pagination. Also links for next and previous pages depends on current_page and total_pages. So, for example, previous link will be omitted when results for 1st page returned, same for next - will be omitted when last page reached.

Please note - you may skip pagination and get the whole list of items. To do it you need to pass no-pagination query option with positive value. Example: GET /api/resources/data-types?no-pagination=1

Also it is possible to pass per-page query option to change default value (25). Example: GET /api/resources/data-types?per-page=5

Errors

There are few type of errors that can happens:

  • validation

  • authentication

  • authentication

  • not found

  • application/business logic

  • server/unexpected

Validation Error

Happens when data you submit fails against validation rules. Such response will have 400 (Bad Request) http status code and contain error related information in body.

{
    'message': '400 Bad Request',
    'errors': [
        'field_with_bad_data': [
            'Reason of failed validation',
            'Another reason of failed validation',
            ...
        ],
        'another_field_with_bad_data': [
            ...
        ],
        ...
    ],
   'status_code': 400
}

Please note that errors contains ONLY fields that fails against validation rules. Each field can has MANY error messages, all of them listed in array

Authenticatio Error

Happens when protected API endpoint requested without (or with bad or expired) specified token.

{
    'message': 'Short description of error reason',
    'status_code': 401
}

Authorization Error

Happens if authenticated user has no access to specified endpoint.

{
    'message': 'Short description of error reason',
    'status_code': 403
}

Not Found Error

Happens if client trying to access not existing API endpoint or not existing entity identifier specified

{
    'message': 'Short description of error reason',
    'status_code': 404
}

Not Acceptable Error

In most cases the reason - client version is too old and not supported The main use case for it - restrict usage of old mobile application (in order to not maintain legacy API endpoints). See more details in section about versions

{
    'message': 'Short description of error reason',
    'status_code': 406
}

Application Errors

Happens when something went wrong from Business Logic point of view. Such response will have 422 (Unprocessable Entity) http status code

{
    'message': 'Descriptive error message',
    'status_code': 422
}

Server Errors

There are small chance to get such error. In most cases it means that the server or a part of it down and have to be maintained as soon as possible. Such response will have 500 (Internal Error) http status code

{
    'message': 'Internal Error',
    'status_code': 500
}

Translations

To get all available translation for key use param with_translation=1 in path.

For example:

  • /resources/field-permissions?with_translations=1:
{
   'data': [
       {
           'id': 3,
           'alias': 'edit',
           'name': {
               'en': 'Edit',
               'fr': 'Modifier'
           }
       },
       //....
   ]
}
  • /resources/field-permissions:
{
   'data': [
       {
           'id': 3,
           'alias': 'edit',
           'name': 'Edit',
       },
       //....
   ]
}

Status

In Progress.

Action Groups

Action group list

Action group list
GET/action-groups{?status,category,sort-by,sort-direction,search-term}

Example URI

GET https://rest.monportailrh.com/action-groups?status=in_progress,complete&category=form,link&sort-by=name&sort-direction=asc&search-term=some-text
URI Parameters
HideShow
status
string (optional) Example: in_progress,complete

  • not_start

  • in_progress

  • complete

category
string (optional) Example: form,link

  • validation

  • link

  • form

  • todo

  • schedule

sort-by
string (optional) Example: name

  • status

  • name

sort-direction
string (optional) Example: asc

  • asc

  • desc

search-term
string (optional) Example: some-text
Request
HideShow
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": 123,
      "alias": "action_group_alias",
      "title": "Action group name",
      "status": "complete",
      "expires_at": "2021-01-01",
      "due_date": "2021-01-01",
      "users_amount": 18,
      "category": {
        "id": 1,
        "alias": "category_alias",
        "name": "Category name"
      }
    }
  ],
  "meta": {
    "pagination": {
      "total": 238,
      "count": 25,
      "per_page": 25,
      "current_page": 2,
      "total_pages": 10,
      "links": {
        "previous": "http://example.com/api/<endpoint>?page=1",
        "next": "http://example.com/api/<endpoint>?page=3"
      }
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number"
          },
          "alias": {
            "type": "string"
          },
          "title": {
            "type": "string"
          },
          "status": {
            "type": "string",
            "enum": [
              "not_start",
              "in_progress",
              "complete"
            ]
          },
          "expires_at": {
            "type": "string"
          },
          "due_date": {
            "type": "string"
          },
          "users_amount": {
            "type": "number"
          },
          "category": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number"
              },
              "alias": {
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "alias",
              "name"
            ]
          }
        },
        "required": [
          "id",
          "alias",
          "title",
          "status",
          "expires_at",
          "due_date",
          "users_amount"
        ]
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number"
            },
            "count": {
              "type": "number"
            },
            "per_page": {
              "type": "number"
            },
            "current_page": {
              "type": "number"
            },
            "total_pages": {
              "type": "number"
            },
            "links": {
              "type": "object",
              "properties": {
                "previous": {
                  "type": "string"
                },
                "next": {
                  "type": "string"
                }
              },
              "required": [
                "previous",
                "next"
              ]
            }
          },
          "required": [
            "total",
            "count",
            "per_page",
            "current_page",
            "total_pages",
            "links"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "pagination"
      ]
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Action group info

Action group info
GET/action-groups/{action_groups_id}

Get action group info with stats of progress

Example URI

GET https://rest.monportailrh.com/action-groups/123
URI Parameters
HideShow
action_groups_id
number (required) Example: 123

ID of the action group

Request
HideShow
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "title": "Action group name",
      "actions_count": 3,
      "completed_percentage": 66,
      "statuses": {
        "active": 3,
        "approved": 4,
        "pending": 6,
        "failed": 10,
        "rejected": 16,
        "canceled": 24,
        "outdated": 34,
        "done": 3
      },
      "expires_at": "2021-01-01",
      "due_date": "2021-01-01",
      "users_amount": 18
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "title": {
            "type": "string"
          },
          "actions_count": {
            "type": "number"
          },
          "completed_percentage": {
            "type": "number"
          },
          "statuses": {
            "type": "object",
            "properties": {
              "active": {
                "type": "number"
              },
              "approved": {
                "type": "number"
              },
              "pending": {
                "type": "number"
              },
              "failed": {
                "type": "number"
              },
              "rejected": {
                "type": "number"
              },
              "canceled": {
                "type": "number"
              },
              "outdated": {
                "type": "number"
              },
              "done": {
                "type": "number"
              }
            }
          },
          "expires_at": {
            "type": "string"
          },
          "due_date": {
            "type": "string"
          },
          "users_amount": {
            "type": "number"
          }
        },
        "required": [
          "title",
          "actions_count",
          "completed_percentage",
          "expires_at",
          "due_date",
          "users_amount"
        ]
      }
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

User list by action group

User list by action group
GET/action-groups/{action_groups_id}/actions{?status,sort-by,sort-direction,search-term}

Example URI

GET https://rest.monportailrh.com/action-groups/123/actions?status=in_progress,complete&sort-by=name&sort-direction=asc&search-term=some-text
URI Parameters
HideShow
action_groups_id
number (required) Example: 123

ID of the action group

status
string (optional) Example: in_progress,complete

  • not_start

  • in_progress

  • complete

sort-by
string (optional) Example: name

  • status

  • name

sort-direction
string (optional) Example: asc

  • asc

  • desc

search-term
string (optional) Example: some-text
Request
HideShow
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "action_group_id": 123,
      "owner": {
        "id": 1,
        "external_id": 1,
        "first_name": "John",
        "last_name": "Snow",
        "username": "john_snow",
        "professional_email": "jsnow@example.com",
        "professional_mobile_phone": "00 33 1 40 00 00 00",
        "professional_phone": "00 33 1 40 00 00 00",
        "role": [
          "bastard",
          "king"
        ],
        "is_active": true,
        "status": "remote",
        "settings": [
          "[]"
        ],
        "user_photo": "http://example.com/images/1.jpg"
      },
      "status": "complete",
      "expires_at": "2021-01-01",
      "due_date": "2021-01-01",
      "workflow": [
        {
          "step": 1,
          "relation": "manager",
          "relation_name": "Manager",
          "expires_at": "2021-01-01",
          "due_date": "2021-01-01",
          "status": "done",
          "assigned_users": [
            {
              "id": 1,
              "external_id": 1,
              "first_name": "John",
              "last_name": "Snow",
              "username": "john_snow",
              "professional_email": "jsnow@example.com",
              "professional_mobile_phone": "00 33 1 40 00 00 00",
              "professional_phone": "00 33 1 40 00 00 00",
              "role": [
                "bastard",
                "king"
              ],
              "is_active": true,
              "status": "remote",
              "settings": [
                "[]"
              ],
              "user_photo": "http://example.com/images/1.jpg"
            }
          ],
          "delegated_from": [
            {
              "id": 1,
              "external_id": 1,
              "first_name": "John",
              "last_name": "Snow",
              "username": "john_snow",
              "professional_email": "jsnow@example.com",
              "professional_mobile_phone": "00 33 1 40 00 00 00",
              "professional_phone": "00 33 1 40 00 00 00",
              "role": [
                "bastard",
                "king"
              ],
              "is_active": true,
              "status": "remote",
              "settings": [
                "[]"
              ],
              "user_photo": "http://example.com/images/1.jpg"
            }
          ]
        }
      ]
    }
  ],
  "meta": {
    "pagination": {
      "total": 238,
      "count": 25,
      "per_page": 25,
      "current_page": 2,
      "total_pages": 10,
      "links": {
        "previous": "http://example.com/api/<endpoint>?page=1",
        "next": "http://example.com/api/<endpoint>?page=3"
      }
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "action_group_id": {
            "type": "number"
          },
          "owner": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number"
              },
              "external_id": {
                "type": "number"
              },
              "first_name": {
                "type": "string"
              },
              "last_name": {
                "type": "string"
              },
              "username": {
                "type": "string"
              },
              "professional_email": {
                "type": "string"
              },
              "professional_mobile_phone": {
                "type": "string"
              },
              "professional_phone": {
                "type": "string"
              },
              "role": {
                "type": "array"
              },
              "is_active": {
                "type": "boolean"
              },
              "status": {
                "type": "string"
              },
              "settings": {
                "type": "array"
              },
              "user_photo": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "external_id",
              "first_name",
              "last_name",
              "username",
              "professional_email",
              "professional_mobile_phone",
              "professional_phone",
              "role",
              "is_active",
              "status",
              "settings",
              "user_photo"
            ]
          },
          "status": {
            "type": "string",
            "enum": [
              "not_start",
              "in_progress",
              "complete",
              "refused"
            ]
          },
          "expires_at": {
            "type": "string"
          },
          "due_date": {
            "type": "string"
          },
          "workflow": {
            "type": "array"
          }
        },
        "required": [
          "action_group_id",
          "owner",
          "status",
          "expires_at",
          "due_date",
          "workflow"
        ]
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number"
            },
            "count": {
              "type": "number"
            },
            "per_page": {
              "type": "number"
            },
            "current_page": {
              "type": "number"
            },
            "total_pages": {
              "type": "number"
            },
            "links": {
              "type": "object",
              "properties": {
                "previous": {
                  "type": "string"
                },
                "next": {
                  "type": "string"
                }
              },
              "required": [
                "previous",
                "next"
              ]
            }
          },
          "required": [
            "total",
            "count",
            "per_page",
            "current_page",
            "total_pages",
            "links"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "pagination"
      ]
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

User list

User list
GET/action-groups/users{?pso-type,sort-by,sort-direction,search-term}

List of user with statistic by action statuses

Example URI

GET https://rest.monportailrh.com/action-groups/users?pso-type=usr&sort-by=name&sort-direction=asc&search-term=some-text
URI Parameters
HideShow
pso-type
string (optional) Example: usr
sort-by
string (optional) Example: name
sort-direction
string (optional) Example: asc

  • asc

  • desc

search-term
string (optional) Example: some-text
Request
HideShow
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "user": {
        "id": 1,
        "external_id": 1,
        "first_name": "John",
        "last_name": "Snow",
        "username": "john_snow",
        "professional_email": "jsnow@example.com",
        "professional_mobile_phone": "00 33 1 40 00 00 00",
        "professional_phone": "00 33 1 40 00 00 00",
        "role": [
          "bastard",
          "king"
        ],
        "is_active": true,
        "status": "remote",
        "settings": [
          "[]"
        ],
        "user_photo": "http://example.com/images/1.jpg"
      },
      "action_statistic": {
        "total": 5,
        "completed": 1,
        "in_progress": 3,
        "not_started": 2
      }
    }
  ],
  "meta": {
    "pagination": {
      "total": 238,
      "count": 25,
      "per_page": 25,
      "current_page": 2,
      "total_pages": 10,
      "links": {
        "previous": "http://example.com/api/<endpoint>?page=1",
        "next": "http://example.com/api/<endpoint>?page=3"
      }
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "user": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number"
              },
              "external_id": {
                "type": "number"
              },
              "first_name": {
                "type": "string"
              },
              "last_name": {
                "type": "string"
              },
              "username": {
                "type": "string"
              },
              "professional_email": {
                "type": "string"
              },
              "professional_mobile_phone": {
                "type": "string"
              },
              "professional_phone": {
                "type": "string"
              },
              "role": {
                "type": "array"
              },
              "is_active": {
                "type": "boolean"
              },
              "status": {
                "type": "string"
              },
              "settings": {
                "type": "array"
              },
              "user_photo": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "external_id",
              "first_name",
              "last_name",
              "username",
              "professional_email",
              "professional_mobile_phone",
              "professional_phone",
              "role",
              "is_active",
              "status",
              "settings",
              "user_photo"
            ]
          },
          "action_statistic": {
            "type": "object",
            "properties": {
              "total": {
                "type": "number"
              },
              "completed": {
                "type": "number"
              },
              "in_progress": {
                "type": "number"
              },
              "not_started": {
                "type": "number"
              }
            },
            "required": [
              "total",
              "completed",
              "in_progress",
              "not_started"
            ]
          }
        },
        "required": [
          "user"
        ]
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number"
            },
            "count": {
              "type": "number"
            },
            "per_page": {
              "type": "number"
            },
            "current_page": {
              "type": "number"
            },
            "total_pages": {
              "type": "number"
            },
            "links": {
              "type": "object",
              "properties": {
                "previous": {
                  "type": "string"
                },
                "next": {
                  "type": "string"
                }
              },
              "required": [
                "previous",
                "next"
              ]
            }
          },
          "required": [
            "total",
            "count",
            "per_page",
            "current_page",
            "total_pages",
            "links"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "pagination"
      ]
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Action list by user

Action list by user
GET/action-groups/users/{user_id}{?category,status,sort-by,sort-direction,search-term}

Example URI

GET https://rest.monportailrh.com/action-groups/users/123?category=form,link&status=in_progress,complete&sort-by=name&sort-direction=asc&search-term=some-text
URI Parameters
HideShow
user_id
number (required) Example: 123

ID of the user

category
string (optional) Example: form,link

  • validation

  • link

  • form

  • todo

  • schedule

status
string (optional) Example: in_progress,complete

  • not_start

  • in_progress

  • complete

sort-by
string (optional) Example: name

  • status

  • name

sort-direction
string (optional) Example: asc

  • asc

  • desc

search-term
string (optional) Example: some-text
Request
HideShow
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": 123,
      "alias": "action_group_alias",
      "title": "Action group name",
      "status": "complete",
      "expires_at": "2021-01-01",
      "due_date": "2021-01-01",
      "users_amount": 18,
      "category": {
        "id": 1,
        "alias": "category_alias",
        "name": "Category name"
      },
      "workflow": [
        {
          "step": 1,
          "relation": "manager",
          "relation_name": "Manager",
          "expires_at": "2021-01-01",
          "due_date": "2021-01-01",
          "status": "done",
          "assigned_users": [
            {
              "id": 1,
              "external_id": 1,
              "first_name": "John",
              "last_name": "Snow",
              "username": "john_snow",
              "professional_email": "jsnow@example.com",
              "professional_mobile_phone": "00 33 1 40 00 00 00",
              "professional_phone": "00 33 1 40 00 00 00",
              "role": [
                "bastard",
                "king"
              ],
              "is_active": true,
              "status": "remote",
              "settings": [
                "[]"
              ],
              "user_photo": "http://example.com/images/1.jpg"
            }
          ],
          "delegated_from": [
            {
              "id": 1,
              "external_id": 1,
              "first_name": "John",
              "last_name": "Snow",
              "username": "john_snow",
              "professional_email": "jsnow@example.com",
              "professional_mobile_phone": "00 33 1 40 00 00 00",
              "professional_phone": "00 33 1 40 00 00 00",
              "role": [
                "bastard",
                "king"
              ],
              "is_active": true,
              "status": "remote",
              "settings": [
                "[]"
              ],
              "user_photo": "http://example.com/images/1.jpg"
            }
          ]
        }
      ]
    }
  ],
  "meta": {
    "pagination": {
      "total": 238,
      "count": 25,
      "per_page": 25,
      "current_page": 2,
      "total_pages": 10,
      "links": {
        "previous": "http://example.com/api/<endpoint>?page=1",
        "next": "http://example.com/api/<endpoint>?page=3"
      }
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number"
          },
          "alias": {
            "type": "string"
          },
          "title": {
            "type": "string"
          },
          "status": {
            "type": "string",
            "enum": [
              "not_start",
              "in_progress",
              "complete"
            ]
          },
          "expires_at": {
            "type": "string"
          },
          "due_date": {
            "type": "string"
          },
          "users_amount": {
            "type": "number"
          },
          "category": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number"
              },
              "alias": {
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "alias",
              "name"
            ]
          },
          "workflow": {
            "type": "array"
          }
        },
        "required": [
          "id",
          "alias",
          "title",
          "status",
          "expires_at",
          "due_date",
          "users_amount",
          "workflow"
        ]
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number"
            },
            "count": {
              "type": "number"
            },
            "per_page": {
              "type": "number"
            },
            "current_page": {
              "type": "number"
            },
            "total_pages": {
              "type": "number"
            },
            "links": {
              "type": "object",
              "properties": {
                "previous": {
                  "type": "string"
                },
                "next": {
                  "type": "string"
                }
              },
              "required": [
                "previous",
                "next"
              ]
            }
          },
          "required": [
            "total",
            "count",
            "per_page",
            "current_page",
            "total_pages",
            "links"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "pagination"
      ]
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Actions

Actions it is a way to interact with users and provide them tasks that need to be completed.

Actions

Action categories

See GET /resources/action-types API

Every action has a type. Action types also grouped by categories. So we may apply specific processing to actions based on categories and types.

For now we have following categories:

  • form. Types are: form_assignment

  • validation. Types are: expense, recruiting, leave

  • link. Types are: link

  • todo. Types are: todo, certificate

  • schedule. Types are: schedule

Action types

  • form_assignment Kind of reminder to fill specific assignment. Will have assignment details in payload property.

  • link Action with a link to external URL (resource). No specific processing

  • todo, schedule Kind of task that user need to complete. Applies specific handling

  • certificate, expense, recruiting Kind of reminder. No specific processing

  • leave Validation action that applies specific processing

Action Processing

form_assignment

Should be used to give user a way to complete assignment. Payload will provide additional details to perform an API call to get form assignment

Payload structure:

  • user_id integer, required. ID of user that assignment originally assigned to. It can be different from action user because of workflow. The user from payload always points on user form originally assigned to

  • form_instance_id integer, required. ID of form assignment that user need to complete

  • mass_edit - boolean, required. Shows if the assignment supports mass edit feature or not

  • step string, required. The current workflow step that need to be complete

No specific processing

todo, schedule

Allows to mark it as done or rejected. If rejected user need to put a comment. See PATCH /actions API

certificate,expense, recruiting

No specific processing

leave

Validation action that applies specific processing and used to syncronize leave requests with external tool.

Payload structure:

  • external_id string. Action ID from external tool. Used during synchronization to match the action in external tool

  • provider_name string. Used during synchronization

  • company_name string. Used during synchronization

  • approver_id string. Used during synchronization. Represents the person that need to confirm the leave request

Actions created by system

In some cases to organize the process and to help users to interact with system it can create and assign actions automatically (based on internal rules and state)

New Form Assignment created

When new assignment created it will create an action with assignment target user as action assignee. Assignment creator will be used as action author. Form name will be used as action title. Hardcoded message will be used as subtitle. Lifetime will be 100 years (almost eternity)

Form Assignment progressed to next user in workflow

When assignment has workflow and the current step completed (data was submitted). It will create an action for the user that need to handle next step. Old actions will be completed (closed) It wIll create create an action with assignment target user as target. Assignment creator will be used as action author. Form name will be used as action title. Hardcoded message will be used as subtitle. Lifetime will be 100 years (almost eternity)

List
GET/actions{?user-id,effective-after,effective-before,expires_after,expires_before,type-alias,statuses,actual,page,per-page,no-pagination}

Get list of actions matches specified filters

To view list of actions user must have actions.view permission

Example URI

GET https://rest.monportailrh.com/actions?user-id=123&effective-after=2019-03-21 09:34:58&effective-before=2019-03-21 09:34:58&expires_after=2019-03-21 09:34:58&expires_before=2019-03-21 09:34:58&type-alias=leave&statuses=&actual=true&page=1&per-page=10&no-pagination=false
URI Parameters
HideShow
user-id
number (required) Example: 123
effective-after
date-time (required) Example: 2019-03-21 09:34:58
effective-before
date-time (required) Example: 2019-03-21 09:34:58
expires_after
date-time (required) Example: 2019-03-21 09:34:58
expires_before
date-time (required) Example: 2019-03-21 09:34:58
type-alias
string (required) Example: leave
statuses
array[string] (required) 

  • active

  • approved

  • pending

  • done

  • failed

  • rejected

actual
boolean (required) Example: true

Predefined set of filter. Same as effective-before=<now>&statuses[]=active&statuses[]=pending

page
number (required) Example: 1

Page number. 1 by default

per-page
number (required) Example: 10

Number of items per page, 25 by default

no-pagination
boolean (required) Example: false

if presented and positive pagination will not be applied. All available items will be returned.

Note: it may have significant impact on the performance

Note: once this option positive and presented - meta attribute with pagination data will be omit in response

Request
HideShow
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": 123,
      "author": {
        "id": 1,
        "external_id": 1,
        "first_name": "John",
        "last_name": "Snow",
        "username": "john_snow",
        "professional_email": "jsnow@example.com",
        "professional_mobile_phone": "00 33 1 40 00 00 00",
        "professional_phone": "00 33 1 40 00 00 00",
        "role": [
          "bastard",
          "king"
        ],
        "is_active": true,
        "status": "remote",
        "settings": [
          "[]"
        ],
        "user_photo": "http://example.com/images/1.jpg"
      },
      "title": "Medical Visit",
      "subtitle": "You need to visit a doctor",
      "details": "Some more info",
      "type": {
        "id": 34,
        "name": "Leave Request",
        "alias": "leave",
        "category": "validation"
      },
      "link": "http://example.com",
      "status": "active",
      "payload": {},
      "icon": "http://example.com/image.png",
      "effective_date": "2019-01-24 15:34:58",
      "expires_at": "2019-03-21 09:34:58",
      "created_at": "2019-01-24 12:23:00",
      "updated_at": "2019-01-25 03:12:43",
      "form_assignee": {
        "first_name": "John",
        "last_name": "Snow",
        "image": "https://rest-dev.monportailrh.com/storage/company/images/image.jpeg",
        "is_active": true
      }
    }
  ],
  "meta": {
    "pagination": {
      "total": 238,
      "count": 25,
      "per_page": 25,
      "current_page": 2,
      "total_pages": 10,
      "links": {
        "previous": "http://example.com/api/<endpoint>?page=1",
        "next": "http://example.com/api/<endpoint>?page=3"
      }
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number"
          },
          "author": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number"
              },
              "external_id": {
                "type": "number"
              },
              "first_name": {
                "type": "string"
              },
              "last_name": {
                "type": "string"
              },
              "username": {
                "type": "string"
              },
              "professional_email": {
                "type": "string"
              },
              "professional_mobile_phone": {
                "type": "string"
              },
              "professional_phone": {
                "type": "string"
              },
              "role": {
                "type": "array"
              },
              "is_active": {
                "type": "boolean"
              },
              "status": {
                "type": "string"
              },
              "settings": {
                "type": "array"
              },
              "user_photo": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "external_id",
              "first_name",
              "last_name",
              "username",
              "professional_email",
              "professional_mobile_phone",
              "professional_phone",
              "role",
              "is_active",
              "status",
              "settings",
              "user_photo"
            ]
          },
          "title": {
            "type": "string"
          },
          "subtitle": {
            "type": "string"
          },
          "details": {
            "type": "string"
          },
          "type": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number"
              },
              "name": {
                "type": "string"
              },
              "alias": {
                "type": "string"
              },
              "category": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "name",
              "alias",
              "category"
            ],
            "additionalProperties": false
          },
          "link": {
            "type": "string"
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "approved",
              "pending",
              "done",
              "failed",
              "rejected"
            ]
          },
          "payload": {
            "type": "object",
            "properties": {}
          },
          "icon": {
            "type": "string"
          },
          "effective_date": {
            "type": "string"
          },
          "expires_at": {
            "type": "string"
          },
          "created_at": {
            "type": "string"
          },
          "updated_at": {
            "type": "string"
          },
          "form_assignee": {
            "type": "object",
            "properties": {
              "first_name": {
                "type": "string"
              },
              "last_name": {
                "type": "string"
              },
              "image": {
                "type": "string"
              },
              "is_active": {
                "type": "boolean"
              }
            },
            "required": [
              "first_name",
              "last_name",
              "image",
              "is_active"
            ],
            "description": "Presented only if action type is form assigment. Shows base information about user assigned to form"
          }
        },
        "required": [
          "id",
          "author",
          "title",
          "status",
          "effective_date",
          "expires_at",
          "created_at",
          "updated_at"
        ]
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number"
            },
            "count": {
              "type": "number"
            },
            "per_page": {
              "type": "number"
            },
            "current_page": {
              "type": "number"
            },
            "total_pages": {
              "type": "number"
            },
            "links": {
              "type": "object",
              "properties": {
                "previous": {
                  "type": "string"
                },
                "next": {
                  "type": "string"
                }
              },
              "required": [
                "previous",
                "next"
              ]
            }
          },
          "required": [
            "total",
            "count",
            "per_page",
            "current_page",
            "total_pages",
            "links"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "pagination"
      ]
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/actions/{id}

Get details for specified action

To get action details user must have actions.view.* permissions

Example URI

GET https://rest.monportailrh.com/actions/1267
URI Parameters
HideShow
id
number (required) Example: 1267

ID of the action

Request
HideShow
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 123,
    "author": {
      "id": 1,
      "external_id": 1,
      "first_name": "John",
      "last_name": "Snow",
      "username": "john_snow",
      "professional_email": "jsnow@example.com",
      "professional_mobile_phone": "00 33 1 40 00 00 00",
      "professional_phone": "00 33 1 40 00 00 00",
      "role": [
        "bastard",
        "king"
      ],
      "is_active": true,
      "status": "remote",
      "settings": [
        "[]"
      ],
      "user_photo": "http://example.com/images/1.jpg"
    },
    "title": "Medical Visit",
    "subtitle": "You need to visit a doctor",
    "details": "Some more info",
    "type": {
      "id": 34,
      "name": "Leave Request",
      "alias": "leave",
      "category": "validation"
    },
    "link": "http://example.com",
    "status": "active",
    "payload": {},
    "icon": "http://example.com/image.png",
    "effective_date": "2019-01-24 15:34:58",
    "expires_at": "2019-03-21 09:34:58",
    "created_at": "2019-01-24 12:23:00",
    "updated_at": "2019-01-25 03:12:43",
    "form_assignee": {
      "first_name": "John",
      "last_name": "Snow",
      "image": "https://rest-dev.monportailrh.com/storage/company/images/image.jpeg",
      "is_active": true
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "author": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "external_id": {
              "type": "number"
            },
            "first_name": {
              "type": "string"
            },
            "last_name": {
              "type": "string"
            },
            "username": {
              "type": "string"
            },
            "professional_email": {
              "type": "string"
            },
            "professional_mobile_phone": {
              "type": "string"
            },
            "professional_phone": {
              "type": "string"
            },
            "role": {
              "type": "array"
            },
            "is_active": {
              "type": "boolean"
            },
            "status": {
              "type": "string"
            },
            "settings": {
              "type": "array"
            },
            "user_photo": {
              "type": "string"
            }
          },
          "required": [
            "id",
            "external_id",
            "first_name",
            "last_name",
            "username",
            "professional_email",
            "professional_mobile_phone",
            "professional_phone",
            "role",
            "is_active",
            "status",
            "settings",
            "user_photo"
          ]
        },
        "title": {
          "type": "string"
        },
        "subtitle": {
          "type": "string"
        },
        "details": {
          "type": "string"
        },
        "type": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "name": {
              "type": "string"
            },
            "alias": {
              "type": "string"
            },
            "category": {
              "type": "string"
            }
          },
          "required": [
            "id",
            "name",
            "alias",
            "category"
          ],
          "additionalProperties": false
        },
        "link": {
          "type": "string"
        },
        "status": {
          "type": "string",
          "enum": [
            "active",
            "approved",
            "pending",
            "done",
            "failed",
            "rejected"
          ]
        },
        "payload": {
          "type": "object",
          "properties": {}
        },
        "icon": {
          "type": "string"
        },
        "effective_date": {
          "type": "string"
        },
        "expires_at": {
          "type": "string"
        },
        "created_at": {
          "type": "string"
        },
        "updated_at": {
          "type": "string"
        },
        "form_assignee": {
          "type": "object",
          "properties": {
            "first_name": {
              "type": "string"
            },
            "last_name": {
              "type": "string"
            },
            "image": {
              "type": "string"
            },
            "is_active": {
              "type": "boolean"
            }
          },
          "required": [
            "first_name",
            "last_name",
            "image",
            "is_active"
          ],
          "description": "Presented only if action type is form assigment. Shows base information about user assigned to form"
        }
      },
      "required": [
        "id",
        "author",
        "title",
        "status",
        "effective_date",
        "expires_at",
        "created_at",
        "updated_at"
      ]
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Count
GET/actions/count{?user-id,effective-after,effective-before,expires_after,expires_before,type-alias,statuses,actual,page,per-page,no-pagination}

Get count of actions matches specified filters

To view number of actions user must have actions.view permission

Example URI

GET https://rest.monportailrh.com/actions/count?user-id=123&effective-after=2019-03-21 09:34:58&effective-before=2019-03-21 09:34:58&expires_after=2019-03-21 09:34:58&expires_before=2019-03-21 09:34:58&type-alias=leave&statuses=&actual=true&page=1&per-page=10&no-pagination=false
URI Parameters
HideShow
user-id
number (required) Example: 123
effective-after
date-time (required) Example: 2019-03-21 09:34:58
effective-before
date-time (required) Example: 2019-03-21 09:34:58
expires_after
date-time (required) Example: 2019-03-21 09:34:58
expires_before
date-time (required) Example: 2019-03-21 09:34:58
type-alias
string (required) Example: leave
statuses
array[string] (required) 

  • new

  • active

  • approved

  • pending

  • done

  • failed

  • rejected

actual
boolean (required) Example: true

Predefined set of filter. Same as effective-before=<now>&statuses[]=active&statuses[]=pending

page
number (required) Example: 1

Page number. 1 by default

per-page
number (required) Example: 10

Number of items per page, 25 by default

no-pagination
boolean (required) Example: false

if presented and positive pagination will not be applied. All available items will be returned.

Note: it may have significant impact on the performance

Note: once this option positive and presented - meta attribute with pagination data will be omit in response

Request
HideShow
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "count": 34
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "count": {
          "type": "number"
        }
      },
      "required": [
        "count"
      ],
      "additionalProperties": false
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Create
POST/actions

Create new action

To create action user must have one of specific permissions:

  • actions.create.* - allows to create any type of actions

  • actions.create.todo - allows to create only todo actions

  • actions.create.schedule - allows to create only schedule actions

Action population

Population is array of different populations. Each kind of population item defined by type property. Available types:

  • all (all active PSOs of given type - see pso_type in main section)

  • group (specified groups)

  • pso (specific PSOs)

  • relation (user or alias of field with relation type)

Population items can be combined. So in population array we may have few entries with different types

Examples: For all type:

[
    {
        "type": "all",
        "details": null
    }
]

For group type:

[
    {
      "type": "group",
      "details": {
        "dynamic": true,
        "includes": ["group_a", "group_b"],
        "excludes": ["group_c", "group_d"]
      }
    }
]

For pso type:

[
    {
      "type": "pso",
      "details": [123, 456]
    }
]

For relation type:

[
    {
      "type": "relation",
      "details": [
        "user",
        "manager",
        "..."
      ]
    }
]

Mixed types:

[
    {
      "type": "group",
      "details": {
        "dynamic": true,
        "includes": ["group_a", "group_b"],
        "excludes": ["group_c", "group_d"]
      }
    },
    {
      "type": "pso",
      "details": [123, 456]
    },
    {
      "type": "relation",
      "details": [
        "self",
        "manager",
        "..."
      ]
    }
]

Action Payload

form_assigment type

payload property

{
  "user_id": 123,
  "form_instance_id": 321,
  "mass_edit": false,
  "step": "some_step"
}

leave type

payload property

{
  "external_id": "some string id",
  "provider_name": "some name",
  "company_name": "company name",
  "approver_id": "some string id"
}

Action substitutions

Substitutions is an array of variables that presented in title, subtitle and details fields. And used to replace these variables in the text to data from Action recipients (they described at Population section). In this case only {$<field_alias>} syntax supported, because this route doesn’t support any conditions.

Example:

[
  "{$usr_first_name}",
  "{$usr_last_name}" 
]

warning Substitutions supports only in create request.

Example URI

POST https://rest.monportailrh.com/actions
Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Body
{
  "author_id": 123,
  "user_id": 123,
  "title": {
    "en": "Some text",
    "fr": "Du texte",
    "de": "Setwas Text",
    "es": "Algún texto"
  },
  "subtitle": {
    "en": "Some text",
    "fr": "Du texte",
    "de": "Setwas Text",
    "es": "Algún texto"
  },
  "details": {
    "en": "Some text",
    "fr": "Du texte",
    "de": "Setwas Text",
    "es": "Algún texto"
  },
  "type_id": 45,
  "link": "http://example.com",
  "icon": "http://example.com/image.png",
  "payload": {
    "user_id": 123,
    "form_instance_id": 321,
    "mass_edit": false,
    "step": "some_step"
  },
  "effective_date": "2019-01-24 15:34:58",
  "expires_at": "2019-03-21 09:34:58",
  "population": [
    {
      "type": "group",
      "details": {
        "dynamic": false,
        "includes": [
          "group_a"
        ],
        "excludes": [
          "group_b",
          "group_c"
        ]
      }
    }
  ],
  "substitutions": [
    "{$usr_first_name}",
    "{$usr_last_name}"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "author_id": {
      "type": "number",
      "description": "only Super Admin can specify it. It will use currently authorized user instead"
    },
    "user_id": {
      "type": "number",
      "description": "Used if need to create action for Another user with `relation` population, this user will be used as base user to find relation"
    },
    "title": {
      "type": "object",
      "properties": {
        "en": {
          "type": "string"
        },
        "fr": {
          "type": "string"
        },
        "de": {
          "type": "string"
        },
        "es": {
          "type": "string"
        }
      },
      "required": [
        "en",
        "fr",
        "de",
        "es"
      ],
      "additionalProperties": false
    },
    "subtitle": {
      "type": "object",
      "properties": {
        "en": {
          "type": "string"
        },
        "fr": {
          "type": "string"
        },
        "de": {
          "type": "string"
        },
        "es": {
          "type": "string"
        }
      },
      "required": [
        "en",
        "fr",
        "de",
        "es"
      ]
    },
    "details": {
      "type": "object",
      "properties": {
        "en": {
          "type": "string"
        },
        "fr": {
          "type": "string"
        },
        "de": {
          "type": "string"
        },
        "es": {
          "type": "string"
        }
      },
      "required": [
        "en",
        "fr",
        "de",
        "es"
      ]
    },
    "type_id": {
      "type": "number",
      "description": "Action type ID,list of available types you can get in /resources/action-types)."
    },
    "link": {
      "type": "string"
    },
    "icon": {
      "type": "string"
    },
    "payload": {
      "type": "extend",
      "enum": [
        {
          "user_id": 123,
          "form_instance_id": 321,
          "mass_edit": false,
          "step": "some_step"
        },
        {
          "external_id": "some stringid",
          "provider_name": "some name",
          "company_name": "company name",
          "approver_id": "some string id"
        }
      ]
    },
    "effective_date": {
      "type": "string"
    },
    "expires_at": {
      "type": "string"
    },
    "population": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "all",
              "group",
              "pso",
              "relation",
              "self"
            ]
          },
          "details": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "dynamic": {
                    "type": "boolean"
                  },
                  "includes": {
                    "type": "array"
                  },
                  "excludes": {
                    "type": "array"
                  }
                },
                "required": [
                  "dynamic",
                  "includes",
                  "excludes"
                ]
              },
              {
                "type": "array",
                "enum": [
                  [],
                  []
                ]
              }
            ],
            "type": "null"
          }
        },
        "required": [
          "type",
          "details"
        ]
      }
    },
    "substitutions": {
      "type": "array"
    }
  },
  "required": [
    "type_id",
    "effective_date",
    "expires_at"
  ]
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 123,
    "alias": "can_be_null"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "alias": {
          "type": "string"
        }
      },
      "required": [
        "id"
      ],
      "additionalProperties": false
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 400
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/actions/{id}

Update the action

To update the action user must have actions.update.* permissions

[FORBIDDEN] Approving/rejecting actions

Some action types (schedule for example) requires additional actions to be done on Approve/Reject Be sure to use Approve or Reject endpoints to perform this operation

Approval and rejection through PATCH API is forbidden

Approve means changing status property to approved

Reject means changing status property to rejected

Actions that belongs to the validation category (see type.category property) must be validated.

Validation means Approve or Reject

Example URI

PATCH https://rest.monportailrh.com/actions/1267
URI Parameters
HideShow
id
number (required) Example: 1267

ID of the action to be updated

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Body
{
  "title": {
    "en": "Some text",
    "fr": "Du texte",
    "de": "Setwas Text",
    "es": "Algún texto"
  },
  "subtitle": {
    "en": "Some text",
    "fr": "Du texte",
    "de": "Setwas Text",
    "es": "Algún texto"
  },
  "details": {
    "en": "Some text",
    "fr": "Du texte",
    "de": "Setwas Text",
    "es": "Algún texto"
  },
  "type_id": 45,
  "link": "http://example.com",
  "status": "active",
  "icon": "http://example.com/image.png",
  "payload": {
    "user_id": 123,
    "form_instance_id": 321,
    "mass_edit": false,
    "step": "some_step"
  },
  "effective_date": "2019-01-24 15:34:58",
  "expires_at": "2019-03-21 09:34:58"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "title": {
      "type": "object",
      "properties": {
        "en": {
          "type": "string"
        },
        "fr": {
          "type": "string"
        },
        "de": {
          "type": "string"
        },
        "es": {
          "type": "string"
        }
      },
      "required": [
        "en",
        "fr",
        "de",
        "es"
      ]
    },
    "subtitle": {
      "type": "object",
      "properties": {
        "en": {
          "type": "string"
        },
        "fr": {
          "type": "string"
        },
        "de": {
          "type": "string"
        },
        "es": {
          "type": "string"
        }
      },
      "required": [
        "en",
        "fr",
        "de",
        "es"
      ]
    },
    "details": {
      "type": "object",
      "properties": {
        "en": {
          "type": "string"
        },
        "fr": {
          "type": "string"
        },
        "de": {
          "type": "string"
        },
        "es": {
          "type": "string"
        }
      },
      "required": [
        "en",
        "fr",
        "de",
        "es"
      ]
    },
    "type_id": {
      "type": "number",
      "description": "Action type ID,list of available types you can get in /resources/action-types)."
    },
    "link": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "enum": [
        "active",
        "pending",
        "done",
        "failed"
      ]
    },
    "icon": {
      "type": "string"
    },
    "payload": {
      "type": "extend",
      "enum": [
        {
          "user_id": 123,
          "form_instance_id": 321,
          "mass_edit": false,
          "step": "some_step"
        },
        {
          "external_id": "some stringid",
          "provider_name": "some name",
          "company_name": "company name",
          "approver_id": "some string id"
        }
      ]
    },
    "effective_date": {
      "type": "string"
    },
    "expires_at": {
      "type": "string"
    }
  }
}
Response  200
HideShow
Headers
Content-Type: application/json
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 400
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Approve action
POST/actions/{id}/approve

To approve the action user must have actions.update.* permissions

Approve means changing status property to approved. It may also apply additional actions that depends on the action type

Actions that belongs to the validation category (see type.category property) must be validated (approved or rejected).

In addition to changing status user may leave a comment (comment property) with some details. This text will be used on notification that will be sent to the action creator

Note: This endpoint will not apply any changes for actions that do not belongs to validation category

Example URI

POST https://rest.monportailrh.com/actions/1267/approve
URI Parameters
HideShow
id
number (required) Example: 1267

ID of the action to be updated

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Body
{
  "comment": "Any free text",
  "scheduled_at": "2019-03-21 09:34:58"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "comment": {
      "type": "string"
    },
    "scheduled_at": {
      "type": "string",
      "description": "has sense (and required) only for actions with `schedule` type. format `Y-m-d`"
    }
  }
}
Response  202
HideShow
Headers
Content-Type: application/json
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 400
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Reject action
POST/actions/{id}/reject

To reject the action user must have actions.update.* permissions

Reject means changing status property to rejected

Actions that belongs to the validation category (see type.category property) must be validated (approved or rejected)

Please note: on action Reject comment is required.

Note: This endpoint will not apply any changes for actions that do not belongs to validation category

Example URI

POST https://rest.monportailrh.com/actions/1267/reject
URI Parameters
HideShow
id
number (required) Example: 1267

ID of the action to be updated

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Body
{
  "comment": "Any free text"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "comment": {
      "type": "string"
    }
  }
}
Response  200
HideShow
Headers
Content-Type: application/json
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 400
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete
DELETE/actions/{id}

Remove the action

Example URI

DELETE https://rest.monportailrh.com/actions/1267
URI Parameters
HideShow
id
number (required) Example: 1267

ID of the action to be removed

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Response  204
HideShow
Headers
Content-Type: application/json
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 400
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Assignment Data

Assignment Data is a common name for all concrete form assignments. It related to the Form Assignment (Form Instance) and to the Data Owner (PSO that assignment assigned to)

Assignment Data

Submit
POST/psos/{dataOwner}/form-instances/{formInstance}

Submit Form Data for specified formInstance that assigned to the dataOwner.

Example URI

POST https://rest.monportailrh.com/psos/5/form-instances/312
URI Parameters
HideShow
dataOwner
number (required) Example: 5

Id of PSO Form Assignment assigned to.

formInstance
number (required) Example: 312

Id of Form Assignment data related to.

Request
HideShow
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>
Body
{
  "temporary": true,
  "approval_scheduled_date": "2019-01-01 23:34:40",
  "data": [
    {
      "field_id": 123,
      "field_alias": "usr_first_name",
      "value": "some value",
      "answer_id": 123,
      "batch": "d9438793-ce22-483d-8a80-9250b7f341fd",
      "action": "create"
    }
  ]
}
Schema
{
  "type": "object",
  "properties": {
    "temporary": {
      "type": "boolean",
      "description": "optional, If presented and positive - workflow will not be updated and data will be saved as temporary"
    },
    "approval_scheduled_date": {
      "type": "string",
      "description": "optional datetime string, used for schedule fields updates, values will be stored as Scheduled Approval and applies when the time comes."
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "field_id": {
            "type": "number",
            "description": "required without field_alias"
          },
          "field_alias": {
            "type": "string",
            "description": "required without field_id"
          },
          "value": {
            "type": "string",
            "description": "empty value will clear answer"
          },
          "answer_id": {
            "type": "number",
            "description": "needs if you try to update existed answer"
          },
          "batch": {
            "type": "string",
            "description": "needs if you works with composite list of fields"
          },
          "action": {
            "enum": [
              "create",
              "update",
              "delete"
            ]
          }
        },
        "required": [
          "action"
        ]
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  202
HideShow
Headers
Content-Type: application/json
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/psos/{dataOwner}/form-instances/{formInstance}{?include}

Get Form Data for specified formInstance that assigned to the dataOwner

Example URI

GET https://rest.monportailrh.com/psos/5/form-instances/123?include=fields.type,settings
URI Parameters
HideShow
dataOwner
number (required) Example: 5

Id of PSO Form Assignment assigned to.

formInstance
number (required) Example: 123

Id of Form Assignment data related to.

include
string (optional) Example: fields.type,settings

Comma separated list of related resources that will be included into response.

Possible values:

  • settings

  • fields

  • fields.type

  • fields.category

  • fields.category.pso_type

  • fields.domains

  • fields.domains.pso_type

  • fields.privacy_level

  • fields.pso_type

  • fields.items

  • fields.options

  • fields.settings

  • fields.assignment_settings

  • fields.assignment_permissions

Note that includes uses kind of inheritance. So if you put include=fields.items.type it will also populate items property for all fields

If you need to dive into and include related resources for sub-items you can use same options that fields property has.

For example: include=fields.items.type will attach to the response all fields that assignment has.
Every included field will have items property populated. Every item in items property will have type property populated

Request
HideShow
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>
Response  200
HideShow

Note: response example provides all nested data, but in fact it depends on include option

Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 1,
    "name": "Assignment Name",
    "description": "Assignment Description",
    "form_id": 1,
    "is_active": true,
    "removable": true,
    "can_edit": true,
    "effective_date": "2019-01-01 23:34:40",
    "approval_scheduled_date": "2019-01-01 23:34:40",
    "fields": [
      {
        "id": 1,
        "name": "Field Name",
        "position": 5,
        "alias": "usr_first_name",
        "has_unique_data": false,
        "has_value": true,
        "removable": false,
        "is_active": true,
        "list": false,
        "read_only": false,
        "required": true,
        "user_required": true,
        "system_required": true,
        "type": {
          "id": 1,
          "name": "Data Type Name",
          "alias": "data_type_alias",
          "settings": [
            {
              "id": 1,
              "name": "Data Type Setting Name",
              "alias": "data_type_setting_alias",
              "is_required": true
            }
          ],
          "supports_collection": false,
          "supports_read_only": false,
          "supports_unique": false
        },
        "category": {
          "id": 32,
          "alias": "usr_identity",
          "position": 5,
          "system_required": true,
          "name": "Identity",
          "description": "...",
          "is_active": true,
          "pso_type": {
            "id": 56,
            "name": "User",
            "alias": "usr",
            "description": "...",
            "is_active": true,
            "system_required": true,
            "creation_form_instance_id": 1,
            "profile_form_instance_id": 1
          }
        },
        "domains": [
          {
            "id": 46,
            "alias": "usr_global",
            "name": "User Global",
            "description": "...",
            "is_editable": false,
            "is_removable": false,
            "is_active": true,
            "pso_type": {
              "id": 56,
              "name": "User",
              "alias": "usr",
              "description": "...",
              "is_active": true,
              "system_required": true,
              "creation_form_instance_id": 1,
              "profile_form_instance_id": 1
            }
          }
        ],
        "privacy_level": {
          "id": 123,
          "alias": "public",
          "name": "Not Sensitive",
          "level": 100
        },
        "pso_type": {
          "id": 56,
          "name": "User",
          "alias": "usr",
          "description": "...",
          "is_active": true,
          "system_required": true,
          "creation_form_instance_id": 1,
          "profile_form_instance_id": 1
        },
        "items": [
          {
            "id": 1,
            "name": "Field Name",
            "position": 5,
            "alias": "usr_first_name",
            "has_unique_data": false,
            "has_value": true,
            "removable": false,
            "is_active": true,
            "list": false,
            "read_only": false,
            "required": true,
            "user_required": true,
            "system_required": true,
            "type": {
              "id": 1,
              "name": "Data Type Name",
              "alias": "data_type_alias",
              "settings": [
                {
                  "id": 1,
                  "name": "Data Type Setting Name",
                  "alias": "data_type_setting_alias",
                  "is_required": true
                }
              ],
              "supports_collection": false,
              "supports_read_only": false,
              "supports_unique": false
            },
            "category": {
              "id": 32,
              "alias": "usr_identity",
              "position": 5,
              "system_required": true,
              "name": "Identity",
              "description": "...",
              "is_active": true,
              "pso_type": {
                "id": 56,
                "name": "User",
                "alias": "usr",
                "description": "...",
                "is_active": true,
                "system_required": true,
                "creation_form_instance_id": 1,
                "profile_form_instance_id": 1
              }
            },
            "domains": [
              {
                "id": 46,
                "alias": "usr_global",
                "name": "User Global",
                "description": "...",
                "is_editable": false,
                "is_removable": false,
                "is_active": true,
                "pso_type": {
                  "id": 56,
                  "name": "User",
                  "alias": "usr",
                  "description": "...",
                  "is_active": true,
                  "system_required": true,
                  "creation_form_instance_id": 1,
                  "profile_form_instance_id": 1
                }
              }
            ],
            "privacy_level": {
              "id": 123,
              "alias": "public",
              "name": "Not Sensitive",
              "level": 100
            },
            "pso_type": {
              "id": 56,
              "name": "User",
              "alias": "usr",
              "description": "...",
              "is_active": true,
              "system_required": true,
              "creation_form_instance_id": 1,
              "profile_form_instance_id": 1
            },
            "items": [
              {}
            ],
            "options": [
              {
                "id": 198,
                "name": "Choose me!",
                "position": 9,
                "value": "198",
                "is_active": true,
                "is_selectable": true
              }
            ],
            "settings": [],
            "validation": {
              "type": "regexp",
              "attributes": {},
              "value_example": "string",
              "error_message": {
                "en": "Some text",
                "fr": "Du texte",
                "de": "Setwas Text",
                "es": "Algún texto"
              }
            },
            "has_autocomplete_settings": true,
            "autocomplete_settings": {
              "allow_extra_values": true,
              "autofill": true,
              "provider": {
                "name": {
                  "en": "Some text",
                  "fr": "Du texte",
                  "de": "Setwas Text",
                  "es": "Algún texto"
                },
                "alias": "string",
                "base_url": "https://exmaple.com/",
                "single_value_supported": true,
                "parameters": [
                  {
                    "name": "Name",
                    "key": "alias",
                    "required": true
                  }
                ]
              },
              "parameters": [
                {
                  "name": "Name",
                  "key": "alias",
                  "required": true,
                  "value": "value",
                  "field": {
                    "id": 1,
                    "name": "Field Name",
                    "alias": "usr_first_name",
                    "value": "RU",
                    "root_field": {
                      "id": 1,
                      "name": "Field Name",
                      "alias": "usr_first_name",
                      "value": "RU",
                      "root_field": "null"
                    }
                  }
                }
              ]
            }
          }
        ],
        "options": [
          {
            "id": 198,
            "name": "Choose me!",
            "position": 9,
            "value": "198",
            "is_active": true,
            "is_selectable": true
          }
        ],
        "settings": [],
        "validation": {
          "type": "regexp",
          "attributes": {},
          "value_example": "string",
          "error_message": {
            "en": "Some text",
            "fr": "Du texte",
            "de": "Setwas Text",
            "es": "Algún texto"
          }
        },
        "has_autocomplete_settings": true,
        "autocomplete_settings": {
          "allow_extra_values": true,
          "autofill": true,
          "provider": {
            "name": {
              "en": "Some text",
              "fr": "Du texte",
              "de": "Setwas Text",
              "es": "Algún texto"
            },
            "alias": "string",
            "base_url": "https://exmaple.com/",
            "single_value_supported": true,
            "parameters": [
              {
                "name": "Name",
                "key": "alias",
                "required": true
              }
            ]
          },
          "parameters": [
            {
              "name": "Name",
              "key": "alias",
              "required": true,
              "value": "value",
              "field": {
                "id": 1,
                "name": "Field Name",
                "alias": "usr_first_name",
                "value": "RU",
                "root_field": {
                  "id": 1,
                  "name": "Field Name",
                  "alias": "usr_first_name",
                  "value": "RU",
                  "root_field": "null"
                }
              }
            }
          ]
        },
        "is_locked": true,
        "values": "123",
        "value_details": "",
        "values_count": 1,
        "assignment_settings": [],
        "assignment_permissions": [],
        "access_permissions": []
      }
    ],
    "settings": [
      {
        "id": 456,
        "form_instance_id": 1,
        "setting_id": 123,
        "value": "some value"
      }
    ],
    "workflow_actions": {
      "submit": true,
      "deny": true,
      "revert": true,
      "save": true
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "form_id": {
          "type": "number"
        },
        "is_active": {
          "type": "boolean"
        },
        "removable": {
          "type": "boolean"
        },
        "can_edit": {
          "type": "boolean"
        },
        "effective_date": {
          "type": "string"
        },
        "approval_scheduled_date": {
          "type": "string"
        },
        "fields": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number"
              },
              "name": {
                "type": "string"
              },
              "position": {
                "type": "number"
              },
              "alias": {
                "type": "string"
              },
              "has_unique_data": {
                "type": "boolean",
                "description": "whether field requires values to be unique across system"
              },
              "has_value": {
                "type": "boolean",
                "description": "whether field has at least one value submitted"
              },
              "removable": {
                "type": "boolean",
                "description": "whether field can be removed from system"
              },
              "is_active": {
                "type": "boolean"
              },
              "list": {
                "type": "boolean",
                "description": "whether field can handle collection of values"
              },
              "read_only": {
                "type": "boolean",
                "description": "whether field value can be changed"
              },
              "required": {
                "type": "boolean",
                "description": "deprecated setting"
              },
              "user_required": {
                "type": "boolean",
                "description": "whether field value required by user"
              },
              "system_required": {
                "type": "boolean",
                "description": "whether field value required by system"
              },
              "type": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "number"
                  },
                  "name": {
                    "type": "string"
                  },
                  "alias": {
                    "type": "string"
                  },
                  "settings": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "number"
                        },
                        "name": {
                          "type": "string"
                        },
                        "alias": {
                          "type": "string"
                        },
                        "is_required": {
                          "type": "boolean"
                        }
                      },
                      "required": [
                        "id",
                        "name",
                        "alias",
                        "is_required"
                      ]
                    }
                  },
                  "supports_collection": {
                    "type": "boolean"
                  },
                  "supports_read_only": {
                    "type": "boolean"
                  },
                  "supports_unique": {
                    "type": "boolean"
                  }
                },
                "required": [
                  "id",
                  "name",
                  "alias",
                  "settings",
                  "supports_collection",
                  "supports_read_only",
                  "supports_unique"
                ],
                "additionalProperties": false
              },
              "category": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "number"
                  },
                  "alias": {
                    "type": "string"
                  },
                  "position": {
                    "type": "number"
                  },
                  "system_required": {
                    "type": "boolean"
                  },
                  "name": {
                    "type": "string"
                  },
                  "description": {
                    "type": "string"
                  },
                  "is_active": {
                    "type": "boolean"
                  },
                  "pso_type": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "number"
                      },
                      "name": {
                        "type": "string"
                      },
                      "alias": {
                        "type": "string"
                      },
                      "description": {
                        "type": "string"
                      },
                      "is_active": {
                        "type": "boolean"
                      },
                      "system_required": {
                        "type": "boolean"
                      },
                      "creation_form_instance_id": {
                        "type": "number"
                      },
                      "profile_form_instance_id": {
                        "type": "number"
                      }
                    },
                    "required": [
                      "id",
                      "name",
                      "alias",
                      "description",
                      "is_active",
                      "system_required",
                      "creation_form_instance_id",
                      "profile_form_instance_id"
                    ],
                    "additionalProperties": false,
                    "description": "Presented only if `include` was send"
                  }
                },
                "required": [
                  "id",
                  "alias",
                  "position",
                  "system_required",
                  "name",
                  "description",
                  "is_active"
                ],
                "additionalProperties": false
              },
              "domains": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "number"
                    },
                    "alias": {
                      "type": "string"
                    },
                    "name": {
                      "type": "string"
                    },
                    "description": {
                      "type": "string"
                    },
                    "is_editable": {
                      "type": "boolean"
                    },
                    "is_removable": {
                      "type": "boolean"
                    },
                    "is_active": {
                      "type": "boolean"
                    },
                    "pso_type": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "number"
                        },
                        "name": {
                          "type": "string"
                        },
                        "alias": {
                          "type": "string"
                        },
                        "description": {
                          "type": "string"
                        },
                        "is_active": {
                          "type": "boolean"
                        },
                        "system_required": {
                          "type": "boolean"
                        },
                        "creation_form_instance_id": {
                          "type": "number"
                        },
                        "profile_form_instance_id": {
                          "type": "number"
                        }
                      },
                      "required": [
                        "id",
                        "name",
                        "alias",
                        "description",
                        "is_active",
                        "system_required",
                        "creation_form_instance_id",
                        "profile_form_instance_id"
                      ],
                      "additionalProperties": false
                    }
                  },
                  "required": [
                    "id",
                    "alias",
                    "name",
                    "description",
                    "is_editable",
                    "is_removable",
                    "is_active"
                  ]
                }
              },
              "privacy_level": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "number"
                  },
                  "alias": {
                    "type": "string"
                  },
                  "name": {
                    "type": "string"
                  },
                  "level": {
                    "type": "number"
                  }
                },
                "required": [
                  "id",
                  "alias",
                  "name",
                  "level"
                ],
                "additionalProperties": false
              },
              "pso_type": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "number"
                  },
                  "name": {
                    "type": "string"
                  },
                  "alias": {
                    "type": "string"
                  },
                  "description": {
                    "type": "string"
                  },
                  "is_active": {
                    "type": "boolean"
                  },
                  "system_required": {
                    "type": "boolean"
                  },
                  "creation_form_instance_id": {
                    "type": "number"
                  },
                  "profile_form_instance_id": {
                    "type": "number"
                  }
                },
                "required": [
                  "id",
                  "name",
                  "alias",
                  "description",
                  "is_active",
                  "system_required",
                  "creation_form_instance_id",
                  "profile_form_instance_id"
                ],
                "additionalProperties": false
              },
              "items": {
                "type": [
                  "array",
                  "null"
                ],
                "items": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "number"
                    },
                    "name": {
                      "type": "string"
                    },
                    "position": {
                      "type": "number"
                    },
                    "alias": {
                      "type": "string"
                    },
                    "has_unique_data": {
                      "type": "boolean",
                      "description": "whether field requires values to be unique across system"
                    },
                    "has_value": {
                      "type": "boolean",
                      "description": "whether field has at least one value submitted"
                    },
                    "removable": {
                      "type": "boolean",
                      "description": "whether field can be removed from system"
                    },
                    "is_active": {
                      "type": "boolean"
                    },
                    "list": {
                      "type": "boolean",
                      "description": "whether field can handle collection of values"
                    },
                    "read_only": {
                      "type": "boolean",
                      "description": "whether field value can be changed"
                    },
                    "required": {
                      "type": "boolean",
                      "description": "deprecated setting"
                    },
                    "user_required": {
                      "type": "boolean",
                      "description": "whether field value required by user"
                    },
                    "system_required": {
                      "type": "boolean",
                      "description": "whether field value required by system"
                    },
                    "type": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "number"
                        },
                        "name": {
                          "type": "string"
                        },
                        "alias": {
                          "type": "string"
                        },
                        "settings": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "number"
                              },
                              "name": {
                                "type": "string"
                              },
                              "alias": {
                                "type": "string"
                              },
                              "is_required": {
                                "type": "boolean"
                              }
                            },
                            "required": [
                              "id",
                              "name",
                              "alias",
                              "is_required"
                            ]
                          }
                        },
                        "supports_collection": {
                          "type": "boolean"
                        },
                        "supports_read_only": {
                          "type": "boolean"
                        },
                        "supports_unique": {
                          "type": "boolean"
                        }
                      },
                      "required": [
                        "id",
                        "name",
                        "alias",
                        "settings",
                        "supports_collection",
                        "supports_read_only",
                        "supports_unique"
                      ],
                      "additionalProperties": false
                    },
                    "category": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "number"
                        },
                        "alias": {
                          "type": "string"
                        },
                        "position": {
                          "type": "number"
                        },
                        "system_required": {
                          "type": "boolean"
                        },
                        "name": {
                          "type": "string"
                        },
                        "description": {
                          "type": "string"
                        },
                        "is_active": {
                          "type": "boolean"
                        },
                        "pso_type": {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "number"
                            },
                            "name": {
                              "type": "string"
                            },
                            "alias": {
                              "type": "string"
                            },
                            "description": {
                              "type": "string"
                            },
                            "is_active": {
                              "type": "boolean"
                            },
                            "system_required": {
                              "type": "boolean"
                            },
                            "creation_form_instance_id": {
                              "type": "number"
                            },
                            "profile_form_instance_id": {
                              "type": "number"
                            }
                          },
                          "required": [
                            "id",
                            "name",
                            "alias",
                            "description",
                            "is_active",
                            "system_required",
                            "creation_form_instance_id",
                            "profile_form_instance_id"
                          ],
                          "additionalProperties": false,
                          "description": "Presented only if `include` was send"
                        }
                      },
                      "required": [
                        "id",
                        "alias",
                        "position",
                        "system_required",
                        "name",
                        "description",
                        "is_active"
                      ],
                      "additionalProperties": false
                    },
                    "domains": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "number"
                          },
                          "alias": {
                            "type": "string"
                          },
                          "name": {
                            "type": "string"
                          },
                          "description": {
                            "type": "string"
                          },
                          "is_editable": {
                            "type": "boolean"
                          },
                          "is_removable": {
                            "type": "boolean"
                          },
                          "is_active": {
                            "type": "boolean"
                          },
                          "pso_type": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "number"
                              },
                              "name": {
                                "type": "string"
                              },
                              "alias": {
                                "type": "string"
                              },
                              "description": {
                                "type": "string"
                              },
                              "is_active": {
                                "type": "boolean"
                              },
                              "system_required": {
                                "type": "boolean"
                              },
                              "creation_form_instance_id": {
                                "type": "number"
                              },
                              "profile_form_instance_id": {
                                "type": "number"
                              }
                            },
                            "required": [
                              "id",
                              "name",
                              "alias",
                              "description",
                              "is_active",
                              "system_required",
                              "creation_form_instance_id",
                              "profile_form_instance_id"
                            ],
                            "additionalProperties": false
                          }
                        },
                        "required": [
                          "id",
                          "alias",
                          "name",
                          "description",
                          "is_editable",
                          "is_removable",
                          "is_active"
                        ]
                      }
                    },
                    "privacy_level": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "number"
                        },
                        "alias": {
                          "type": "string"
                        },
                        "name": {
                          "type": "string"
                        },
                        "level": {
                          "type": "number"
                        }
                      },
                      "required": [
                        "id",
                        "alias",
                        "name",
                        "level"
                      ],
                      "additionalProperties": false
                    },
                    "pso_type": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "number"
                        },
                        "name": {
                          "type": "string"
                        },
                        "alias": {
                          "type": "string"
                        },
                        "description": {
                          "type": "string"
                        },
                        "is_active": {
                          "type": "boolean"
                        },
                        "system_required": {
                          "type": "boolean"
                        },
                        "creation_form_instance_id": {
                          "type": "number"
                        },
                        "profile_form_instance_id": {
                          "type": "number"
                        }
                      },
                      "required": [
                        "id",
                        "name",
                        "alias",
                        "description",
                        "is_active",
                        "system_required",
                        "creation_form_instance_id",
                        "profile_form_instance_id"
                      ],
                      "additionalProperties": false
                    },
                    "items": {
                      "type": [
                        "array",
                        "null"
                      ],
                      "items": {
                        "type": "object",
                        "properties": {}
                      }
                    },
                    "options": {
                      "type": [
                        "array",
                        "null"
                      ],
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "number"
                          },
                          "name": {
                            "type": "string"
                          },
                          "position": {
                            "type": "number"
                          },
                          "value": {
                            "type": "string"
                          },
                          "is_active": {
                            "type": "boolean"
                          },
                          "is_selectable": {
                            "type": "boolean",
                            "description": "Can select on front this option (Using only in Hierarchy field))"
                          }
                        },
                        "required": [
                          "id",
                          "name",
                          "position",
                          "value",
                          "is_active",
                          "is_selectable"
                        ]
                      },
                      "description": "List of options with possible (allowed) values."
                    },
                    "settings": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      },
                      "description": "Common field settings"
                    },
                    "validation": {
                      "type": "object",
                      "properties": {
                        "type": {
                          "type": "string"
                        },
                        "attributes": {
                          "type": "object",
                          "properties": {}
                        },
                        "value_example": {
                          "type": "string"
                        },
                        "error_message": {
                          "type": "object",
                          "properties": {
                            "en": {
                              "type": "string"
                            },
                            "fr": {
                              "type": "string"
                            },
                            "de": {
                              "type": "string"
                            },
                            "es": {
                              "type": "string"
                            }
                          },
                          "required": [
                            "en",
                            "fr",
                            "de",
                            "es"
                          ]
                        }
                      },
                      "required": [
                        "type",
                        "value_example",
                        "error_message"
                      ]
                    },
                    "has_autocomplete_settings": {
                      "type": "boolean"
                    },
                    "autocomplete_settings": {
                      "type": "object",
                      "properties": {
                        "allow_extra_values": {
                          "type": "boolean"
                        },
                        "autofill": {
                          "type": "boolean"
                        },
                        "provider": {
                          "type": "object",
                          "properties": {
                            "name": {
                              "type": "object",
                              "properties": {
                                "en": {
                                  "type": "string"
                                },
                                "fr": {
                                  "type": "string"
                                },
                                "de": {
                                  "type": "string"
                                },
                                "es": {
                                  "type": "string"
                                }
                              },
                              "required": [
                                "en",
                                "fr",
                                "de",
                                "es"
                              ]
                            },
                            "alias": {
                              "type": "string"
                            },
                            "base_url": {
                              "type": "string"
                            },
                            "single_value_supported": {
                              "type": "boolean"
                            },
                            "parameters": {
                              "type": "array"
                            }
                          },
                          "required": [
                            "name",
                            "alias",
                            "base_url",
                            "single_value_supported",
                            "parameters"
                          ]
                        },
                        "parameters": {
                          "type": "array"
                        }
                      },
                      "required": [
                        "allow_extra_values",
                        "autofill",
                        "provider",
                        "parameters"
                      ]
                    }
                  },
                  "required": [
                    "id",
                    "name",
                    "position",
                    "alias",
                    "has_unique_data",
                    "has_value",
                    "removable",
                    "is_active",
                    "list",
                    "read_only",
                    "required",
                    "user_required",
                    "system_required",
                    "validation",
                    "has_autocomplete_settings",
                    "autocomplete_settings"
                  ]
                }
              },
              "options": {
                "type": [
                  "array",
                  "null"
                ],
                "items": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "number"
                    },
                    "name": {
                      "type": "string"
                    },
                    "position": {
                      "type": "number"
                    },
                    "value": {
                      "type": "string"
                    },
                    "is_active": {
                      "type": "boolean"
                    },
                    "is_selectable": {
                      "type": "boolean",
                      "description": "Can select on front this option (Using only in Hierarchy field))"
                    }
                  },
                  "required": [
                    "id",
                    "name",
                    "position",
                    "value",
                    "is_active",
                    "is_selectable"
                  ]
                },
                "description": "List of options with possible (allowed) values."
              },
              "settings": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": "Common field settings"
              },
              "validation": {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string"
                  },
                  "attributes": {
                    "type": "object",
                    "properties": {}
                  },
                  "value_example": {
                    "type": "string"
                  },
                  "error_message": {
                    "type": "object",
                    "properties": {
                      "en": {
                        "type": "string"
                      },
                      "fr": {
                        "type": "string"
                      },
                      "de": {
                        "type": "string"
                      },
                      "es": {
                        "type": "string"
                      }
                    },
                    "required": [
                      "en",
                      "fr",
                      "de",
                      "es"
                    ]
                  }
                },
                "required": [
                  "type",
                  "value_example",
                  "error_message"
                ]
              },
              "has_autocomplete_settings": {
                "type": "boolean"
              },
              "autocomplete_settings": {
                "type": "object",
                "properties": {
                  "allow_extra_values": {
                    "type": "boolean"
                  },
                  "autofill": {
                    "type": "boolean"
                  },
                  "provider": {
                    "type": "object",
                    "properties": {
                      "name": {
                        "type": "object",
                        "properties": {
                          "en": {
                            "type": "string"
                          },
                          "fr": {
                            "type": "string"
                          },
                          "de": {
                            "type": "string"
                          },
                          "es": {
                            "type": "string"
                          }
                        },
                        "required": [
                          "en",
                          "fr",
                          "de",
                          "es"
                        ]
                      },
                      "alias": {
                        "type": "string"
                      },
                      "base_url": {
                        "type": "string"
                      },
                      "single_value_supported": {
                        "type": "boolean"
                      },
                      "parameters": {
                        "type": "array"
                      }
                    },
                    "required": [
                      "name",
                      "alias",
                      "base_url",
                      "single_value_supported",
                      "parameters"
                    ]
                  },
                  "parameters": {
                    "type": "array"
                  }
                },
                "required": [
                  "allow_extra_values",
                  "autofill",
                  "provider",
                  "parameters"
                ]
              },
              "is_locked": {
                "type": "boolean"
              },
              "values": {
                "type": "string"
              },
              "value_details": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "user friendly value representation. Actual structure depends on field type"
              },
              "values_count": {
                "type": "number",
                "description": "number of values field has for current user. Meaningful only when `list` is true"
              },
              "assignment_settings": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": "Settings related to this specific Field and Form"
              },
              "assignment_permissions": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": "Permissions related to this specific Field and Form"
              },
              "access_permissions": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": "Access permissions specific for current user"
              }
            },
            "required": [
              "id",
              "name",
              "position",
              "alias",
              "has_unique_data",
              "has_value",
              "removable",
              "is_active",
              "list",
              "read_only",
              "required",
              "user_required",
              "system_required",
              "validation",
              "has_autocomplete_settings",
              "autocomplete_settings",
              "values",
              "value_details",
              "values_count",
              "access_permissions"
            ]
          }
        },
        "settings": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number"
              },
              "form_instance_id": {
                "type": "number"
              },
              "setting_id": {
                "type": "number"
              },
              "value": {
                "type": "string"
              }
            }
          }
        },
        "workflow_actions": {
          "type": "object",
          "properties": {
            "submit": {
              "type": "boolean"
            },
            "deny": {
              "type": "boolean"
            },
            "revert": {
              "type": "boolean"
            },
            "save": {
              "type": "boolean"
            }
          },
          "required": [
            "submit",
            "deny",
            "revert",
            "save"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "name",
        "description",
        "form_id",
        "is_active",
        "removable",
        "can_edit"
      ]
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Mass Edit

Submit
POST/form-instances/{formInstance}/{relation}/mass-edit

Submit Form Data for specified formInstance that assigned to the relation

Example URI

POST https://rest.monportailrh.com/form-instances/123/hr/mass-edit
URI Parameters
HideShow
formInstance
number (required) Example: 123

Id of Form Assignment data related to.

relation
string (required) Example: hr

Step relation.

Request
HideShow
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>
Body
{
  "temporary": true,
  "approval_scheduled_date": "2019-01-01 23:34:40",
  "data": [
    {
      "user_id": 1,
      "data": [
        {
          "field_id": 123,
          "field_alias": "usr_first_name",
          "value": "some value",
          "answer_id": 123,
          "batch": "d9438793-ce22-483d-8a80-9250b7f341fd",
          "action": "create"
        }
      ]
    }
  ]
}
Schema
{
  "type": "object",
  "properties": {
    "temporary": {
      "type": "boolean",
      "description": "optional, If presented and positive - workflow will not be updated and data will be saved as temporary"
    },
    "approval_scheduled_date": {
      "type": "string",
      "description": "optional datetime string, used for schedule fields updates, values will be stored as Scheduled Approval and applies when the time comes."
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "user_id": {
            "type": "number"
          },
          "data": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "field_id": {
                  "type": "number",
                  "description": "required without field_alias"
                },
                "field_alias": {
                  "type": "string",
                  "description": "required without field_id"
                },
                "value": {
                  "type": "string",
                  "description": "empty value will clear answer"
                },
                "answer_id": {
                  "type": "number",
                  "description": "needs if you try to update existed answer"
                },
                "batch": {
                  "type": "string",
                  "description": "needs if you works with composite list of fields"
                },
                "action": {
                  "enum": [
                    "create",
                    "update",
                    "delete"
                  ]
                }
              },
              "required": [
                "action"
              ]
            }
          }
        },
        "required": [
          "user_id"
        ]
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  202
HideShow
Headers
Content-Type: application/json
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/form-instances/{formInstance}/{relation}/mass-edit{?include}

Get Form Data for specified formInstance that assigned to the relation

Example URI

GET https://rest.monportailrh.com/form-instances/123/hr/mass-edit?include=form_instance.fields.type,settings
URI Parameters
HideShow
formInstance
number (required) Example: 123

Id of Form Assignment data related to.

relation
string (required) Example: hr

Step relation.

include
string (optional) Example: form_instance.fields.type,settings

Comma separated list of related resources that will be included into response.

Possible values:

  • form_instance.settings

  • form_instance.fields

  • form_instance.fields.type

  • form_instance.fields.category

  • form_instance.fields.category.pso_type

  • form_instance.fields.domains

  • form_instance.fields.domains.pso_type

  • form_instance.fields.privacy_level

  • form_instance.fields.pso_type

  • form_instance.fields.items

  • form_instance.fields.options

  • form_instance.fields.settings

  • form_instance.fields.assignment_settings

  • form_instance.fields.assignment_permissions

Note that includes uses kind of inheritance. So if you put include=form_instance.fields.items.type it will also populate items property for all fields

If you need to dive into and include related resources for sub-items you can use same options that fields property has.

For example: include=form_instance.ields.items.type will attach to the response all fields that assignment has.
Every included field will have items property populated. Every item in items property will have type property populated

Request
HideShow
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>
Response  200
HideShow

Note: response example provides all nested data, but in fact it depends on include option

Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 1,
    "name": "Assignment Name",
    "description": "Assignment Description",
    "form_id": 1,
    "is_active": true,
    "removable": true,
    "can_edit": true,
    "effective_date": "2019-01-01 23:34:40",
    "approval_scheduled_date": "2019-01-01 23:34:40",
    "fields": [
      {
        "id": 1,
        "name": "Field Name",
        "position": 5,
        "alias": "usr_first_name",
        "has_unique_data": false,
        "has_value": true,
        "removable": false,
        "is_active": true,
        "list": false,
        "read_only": false,
        "required": true,
        "user_required": true,
        "system_required": true,
        "type": {
          "id": 1,
          "name": "Data Type Name",
          "alias": "data_type_alias",
          "settings": [
            {
              "id": 1,
              "name": "Data Type Setting Name",
              "alias": "data_type_setting_alias",
              "is_required": true
            }
          ],
          "supports_collection": false,
          "supports_read_only": false,
          "supports_unique": false
        },
        "category": {
          "id": 32,
          "alias": "usr_identity",
          "position": 5,
          "system_required": true,
          "name": "Identity",
          "description": "...",
          "is_active": true,
          "pso_type": {
            "id": 56,
            "name": "User",
            "alias": "usr",
            "description": "...",
            "is_active": true,
            "system_required": true,
            "creation_form_instance_id": 1,
            "profile_form_instance_id": 1
          }
        },
        "domains": [
          {
            "id": 46,
            "alias": "usr_global",
            "name": "User Global",
            "description": "...",
            "is_editable": false,
            "is_removable": false,
            "is_active": true,
            "pso_type": {
              "id": 56,
              "name": "User",
              "alias": "usr",
              "description": "...",
              "is_active": true,
              "system_required": true,
              "creation_form_instance_id": 1,
              "profile_form_instance_id": 1
            }
          }
        ],
        "privacy_level": {
          "id": 123,
          "alias": "public",
          "name": "Not Sensitive",
          "level": 100
        },
        "pso_type": {
          "id": 56,
          "name": "User",
          "alias": "usr",
          "description": "...",
          "is_active": true,
          "system_required": true,
          "creation_form_instance_id": 1,
          "profile_form_instance_id": 1
        },
        "items": [
          {
            "id": 1,
            "name": "Field Name",
            "position": 5,
            "alias": "usr_first_name",
            "has_unique_data": false,
            "has_value": true,
            "removable": false,
            "is_active": true,
            "list": false,
            "read_only": false,
            "required": true,
            "user_required": true,
            "system_required": true,
            "type": {
              "id": 1,
              "name": "Data Type Name",
              "alias": "data_type_alias",
              "settings": [
                {
                  "id": 1,
                  "name": "Data Type Setting Name",
                  "alias": "data_type_setting_alias",
                  "is_required": true
                }
              ],
              "supports_collection": false,
              "supports_read_only": false,
              "supports_unique": false
            },
            "category": {
              "id": 32,
              "alias": "usr_identity",
              "position": 5,
              "system_required": true,
              "name": "Identity",
              "description": "...",
              "is_active": true,
              "pso_type": {
                "id": 56,
                "name": "User",
                "alias": "usr",
                "description": "...",
                "is_active": true,
                "system_required": true,
                "creation_form_instance_id": 1,
                "profile_form_instance_id": 1
              }
            },
            "domains": [
              {
                "id": 46,
                "alias": "usr_global",
                "name": "User Global",
                "description": "...",
                "is_editable": false,
                "is_removable": false,
                "is_active": true,
                "pso_type": {
                  "id": 56,
                  "name": "User",
                  "alias": "usr",
                  "description": "...",
                  "is_active": true,
                  "system_required": true,
                  "creation_form_instance_id": 1,
                  "profile_form_instance_id": 1
                }
              }
            ],
            "privacy_level": {
              "id": 123,
              "alias": "public",
              "name": "Not Sensitive",
              "level": 100
            },
            "pso_type": {
              "id": 56,
              "name": "User",
              "alias": "usr",
              "description": "...",
              "is_active": true,
              "system_required": true,
              "creation_form_instance_id": 1,
              "profile_form_instance_id": 1
            },
            "items": [
              {}
            ],
            "options": [
              {
                "id": 198,
                "name": "Choose me!",
                "position": 9,
                "value": "198",
                "is_active": true,
                "is_selectable": true
              }
            ],
            "settings": [],
            "validation": {
              "type": "regexp",
              "attributes": {},
              "value_example": "string",
              "error_message": {
                "en": "Some text",
                "fr": "Du texte",
                "de": "Setwas Text",
                "es": "Algún texto"
              }
            },
            "has_autocomplete_settings": true,
            "autocomplete_settings": {
              "allow_extra_values": true,
              "autofill": true,
              "provider": {
                "name": {
                  "en": "Some text",
                  "fr": "Du texte",
                  "de": "Setwas Text",
                  "es": "Algún texto"
                },
                "alias": "string",
                "base_url": "https://exmaple.com/",
                "single_value_supported": true,
                "parameters": [
                  {
                    "name": "Name",
                    "key": "alias",
                    "required": true
                  }
                ]
              },
              "parameters": [
                {
                  "name": "Name",
                  "key": "alias",
                  "required": true,
                  "value": "value",
                  "field": {
                    "id": 1,
                    "name": "Field Name",
                    "alias": "usr_first_name",
                    "value": "RU",
                    "root_field": {
                      "id": 1,
                      "name": "Field Name",
                      "alias": "usr_first_name",
                      "value": "RU",
                      "root_field": "null"
                    }
                  }
                }
              ]
            }
          }
        ],
        "options": [
          {
            "id": 198,
            "name": "Choose me!",
            "position": 9,
            "value": "198",
            "is_active": true,
            "is_selectable": true
          }
        ],
        "settings": [],
        "validation": {
          "type": "regexp",
          "attributes": {},
          "value_example": "string",
          "error_message": {
            "en": "Some text",
            "fr": "Du texte",
            "de": "Setwas Text",
            "es": "Algún texto"
          }
        },
        "has_autocomplete_settings": true,
        "autocomplete_settings": {
          "allow_extra_values": true,
          "autofill": true,
          "provider": {
            "name": {
              "en": "Some text",
              "fr": "Du texte",
              "de": "Setwas Text",
              "es": "Algún texto"
            },
            "alias": "string",
            "base_url": "https://exmaple.com/",
            "single_value_supported": true,
            "parameters": [
              {
                "name": "Name",
                "key": "alias",
                "required": true
              }
            ]
          },
          "parameters": [
            {
              "name": "Name",
              "key": "alias",
              "required": true,
              "value": "value",
              "field": {
                "id": 1,
                "name": "Field Name",
                "alias": "usr_first_name",
                "value": "RU",
                "root_field": {
                  "id": 1,
                  "name": "Field Name",
                  "alias": "usr_first_name",
                  "value": "RU",
                  "root_field": "null"
                }
              }
            }
          ]
        },
        "is_locked": true,
        "values": "123",
        "value_details": "",
        "values_count": 1,
        "assignment_settings": [],
        "assignment_permissions": [],
        "access_permissions": []
      }
    ],
    "settings": [
      {
        "id": 456,
        "form_instance_id": 1,
        "setting_id": 123,
        "value": "some value"
      }
    ],
    "workflow_actions": {
      "submit": true,
      "deny": true,
      "revert": true,
      "save": true
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "form_id": {
          "type": "number"
        },
        "is_active": {
          "type": "boolean"
        },
        "removable": {
          "type": "boolean"
        },
        "can_edit": {
          "type": "boolean"
        },
        "effective_date": {
          "type": "string"
        },
        "approval_scheduled_date": {
          "type": "string"
        },
        "fields": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number"
              },
              "name": {
                "type": "string"
              },
              "position": {
                "type": "number"
              },
              "alias": {
                "type": "string"
              },
              "has_unique_data": {
                "type": "boolean",
                "description": "whether field requires values to be unique across system"
              },
              "has_value": {
                "type": "boolean",
                "description": "whether field has at least one value submitted"
              },
              "removable": {
                "type": "boolean",
                "description": "whether field can be removed from system"
              },
              "is_active": {
                "type": "boolean"
              },
              "list": {
                "type": "boolean",
                "description": "whether field can handle collection of values"
              },
              "read_only": {
                "type": "boolean",
                "description": "whether field value can be changed"
              },
              "required": {
                "type": "boolean",
                "description": "deprecated setting"
              },
              "user_required": {
                "type": "boolean",
                "description": "whether field value required by user"
              },
              "system_required": {
                "type": "boolean",
                "description": "whether field value required by system"
              },
              "type": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "number"
                  },
                  "name": {
                    "type": "string"
                  },
                  "alias": {
                    "type": "string"
                  },
                  "settings": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "number"
                        },
                        "name": {
                          "type": "string"
                        },
                        "alias": {
                          "type": "string"
                        },
                        "is_required": {
                          "type": "boolean"
                        }
                      },
                      "required": [
                        "id",
                        "name",
                        "alias",
                        "is_required"
                      ]
                    }
                  },
                  "supports_collection": {
                    "type": "boolean"
                  },
                  "supports_read_only": {
                    "type": "boolean"
                  },
                  "supports_unique": {
                    "type": "boolean"
                  }
                },
                "required": [
                  "id",
                  "name",
                  "alias",
                  "settings",
                  "supports_collection",
                  "supports_read_only",
                  "supports_unique"
                ],
                "additionalProperties": false
              },
              "category": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "number"
                  },
                  "alias": {
                    "type": "string"
                  },
                  "position": {
                    "type": "number"
                  },
                  "system_required": {
                    "type": "boolean"
                  },
                  "name": {
                    "type": "string"
                  },
                  "description": {
                    "type": "string"
                  },
                  "is_active": {
                    "type": "boolean"
                  },
                  "pso_type": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "number"
                      },
                      "name": {
                        "type": "string"
                      },
                      "alias": {
                        "type": "string"
                      },
                      "description": {
                        "type": "string"
                      },
                      "is_active": {
                        "type": "boolean"
                      },
                      "system_required": {
                        "type": "boolean"
                      },
                      "creation_form_instance_id": {
                        "type": "number"
                      },
                      "profile_form_instance_id": {
                        "type": "number"
                      }
                    },
                    "required": [
                      "id",
                      "name",
                      "alias",
                      "description",
                      "is_active",
                      "system_required",
                      "creation_form_instance_id",
                      "profile_form_instance_id"
                    ],
                    "additionalProperties": false,
                    "description": "Presented only if `include` was send"
                  }
                },
                "required": [
                  "id",
                  "alias",
                  "position",
                  "system_required",
                  "name",
                  "description",
                  "is_active"
                ],
                "additionalProperties": false
              },
              "domains": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "number"
                    },
                    "alias": {
                      "type": "string"
                    },
                    "name": {
                      "type": "string"
                    },
                    "description": {
                      "type": "string"
                    },
                    "is_editable": {
                      "type": "boolean"
                    },
                    "is_removable": {
                      "type": "boolean"
                    },
                    "is_active": {
                      "type": "boolean"
                    },
                    "pso_type": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "number"
                        },
                        "name": {
                          "type": "string"
                        },
                        "alias": {
                          "type": "string"
                        },
                        "description": {
                          "type": "string"
                        },
                        "is_active": {
                          "type": "boolean"
                        },
                        "system_required": {
                          "type": "boolean"
                        },
                        "creation_form_instance_id": {
                          "type": "number"
                        },
                        "profile_form_instance_id": {
                          "type": "number"
                        }
                      },
                      "required": [
                        "id",
                        "name",
                        "alias",
                        "description",
                        "is_active",
                        "system_required",
                        "creation_form_instance_id",
                        "profile_form_instance_id"
                      ],
                      "additionalProperties": false
                    }
                  },
                  "required": [
                    "id",
                    "alias",
                    "name",
                    "description",
                    "is_editable",
                    "is_removable",
                    "is_active"
                  ]
                }
              },
              "privacy_level": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "number"
                  },
                  "alias": {
                    "type": "string"
                  },
                  "name": {
                    "type": "string"
                  },
                  "level": {
                    "type": "number"
                  }
                },
                "required": [
                  "id",
                  "alias",
                  "name",
                  "level"
                ],
                "additionalProperties": false
              },
              "pso_type": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "number"
                  },
                  "name": {
                    "type": "string"
                  },
                  "alias": {
                    "type": "string"
                  },
                  "description": {
                    "type": "string"
                  },
                  "is_active": {
                    "type": "boolean"
                  },
                  "system_required": {
                    "type": "boolean"
                  },
                  "creation_form_instance_id": {
                    "type": "number"
                  },
                  "profile_form_instance_id": {
                    "type": "number"
                  }
                },
                "required": [
                  "id",
                  "name",
                  "alias",
                  "description",
                  "is_active",
                  "system_required",
                  "creation_form_instance_id",
                  "profile_form_instance_id"
                ],
                "additionalProperties": false
              },
              "items": {
                "type": [
                  "array",
                  "null"
                ],
                "items": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "number"
                    },
                    "name": {
                      "type": "string"
                    },
                    "position": {
                      "type": "number"
                    },
                    "alias": {
                      "type": "string"
                    },
                    "has_unique_data": {
                      "type": "boolean",
                      "description": "whether field requires values to be unique across system"
                    },
                    "has_value": {
                      "type": "boolean",
                      "description": "whether field has at least one value submitted"
                    },
                    "removable": {
                      "type": "boolean",
                      "description": "whether field can be removed from system"
                    },
                    "is_active": {
                      "type": "boolean"
                    },
                    "list": {
                      "type": "boolean",
                      "description": "whether field can handle collection of values"
                    },
                    "read_only": {
                      "type": "boolean",
                      "description": "whether field value can be changed"
                    },
                    "required": {
                      "type": "boolean",
                      "description": "deprecated setting"
                    },
                    "user_required": {
                      "type": "boolean",
                      "description": "whether field value required by user"
                    },
                    "system_required": {
                      "type": "boolean",
                      "description": "whether field value required by system"
                    },
                    "type": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "number"
                        },
                        "name": {
                          "type": "string"
                        },
                        "alias": {
                          "type": "string"
                        },
                        "settings": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "number"
                              },
                              "name": {
                                "type": "string"
                              },
                              "alias": {
                                "type": "string"
                              },
                              "is_required": {
                                "type": "boolean"
                              }
                            },
                            "required": [
                              "id",
                              "name",
                              "alias",
                              "is_required"
                            ]
                          }
                        },
                        "supports_collection": {
                          "type": "boolean"
                        },
                        "supports_read_only": {
                          "type": "boolean"
                        },
                        "supports_unique": {
                          "type": "boolean"
                        }
                      },
                      "required": [
                        "id",
                        "name",
                        "alias",
                        "settings",
                        "supports_collection",
                        "supports_read_only",
                        "supports_unique"
                      ],
                      "additionalProperties": false
                    },
                    "category": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "number"
                        },
                        "alias": {
                          "type": "string"
                        },
                        "position": {
                          "type": "number"
                        },
                        "system_required": {
                          "type": "boolean"
                        },
                        "name": {
                          "type": "string"
                        },
                        "description": {
                          "type": "string"
                        },
                        "is_active": {
                          "type": "boolean"
                        },
                        "pso_type": {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "number"
                            },
                            "name": {
                              "type": "string"
                            },
                            "alias": {
                              "type": "string"
                            },
                            "description": {
                              "type": "string"
                            },
                            "is_active": {
                              "type": "boolean"
                            },
                            "system_required": {
                              "type": "boolean"
                            },
                            "creation_form_instance_id": {
                              "type": "number"
                            },
                            "profile_form_instance_id": {
                              "type": "number"
                            }
                          },
                          "required": [
                            "id",
                            "name",
                            "alias",
                            "description",
                            "is_active",
                            "system_required",
                            "creation_form_instance_id",
                            "profile_form_instance_id"
                          ],
                          "additionalProperties": false,
                          "description": "Presented only if `include` was send"
                        }
                      },
                      "required": [
                        "id",
                        "alias",
                        "position",
                        "system_required",
                        "name",
                        "description",
                        "is_active"
                      ],
                      "additionalProperties": false
                    },
                    "domains": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "number"
                          },
                          "alias": {
                            "type": "string"
                          },
                          "name": {
                            "type": "string"
                          },
                          "description": {
                            "type": "string"
                          },
                          "is_editable": {
                            "type": "boolean"
                          },
                          "is_removable": {
                            "type": "boolean"
                          },
                          "is_active": {
                            "type": "boolean"
                          },
                          "pso_type": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "number"
                              },
                              "name": {
                                "type": "string"
                              },
                              "alias": {
                                "type": "string"
                              },
                              "description": {
                                "type": "string"
                              },
                              "is_active": {
                                "type": "boolean"
                              },
                              "system_required": {
                                "type": "boolean"
                              },
                              "creation_form_instance_id": {
                                "type": "number"
                              },
                              "profile_form_instance_id": {
                                "type": "number"
                              }
                            },
                            "required": [
                              "id",
                              "name",
                              "alias",
                              "description",
                              "is_active",
                              "system_required",
                              "creation_form_instance_id",
                              "profile_form_instance_id"
                            ],
                            "additionalProperties": false
                          }
                        },
                        "required": [
                          "id",
                          "alias",
                          "name",
                          "description",
                          "is_editable",
                          "is_removable",
                          "is_active"
                        ]
                      }
                    },
                    "privacy_level": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "number"
                        },
                        "alias": {
                          "type": "string"
                        },
                        "name": {
                          "type": "string"
                        },
                        "level": {
                          "type": "number"
                        }
                      },
                      "required": [
                        "id",
                        "alias",
                        "name",
                        "level"
                      ],
                      "additionalProperties": false
                    },
                    "pso_type": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "number"
                        },
                        "name": {
                          "type": "string"
                        },
                        "alias": {
                          "type": "string"
                        },
                        "description": {
                          "type": "string"
                        },
                        "is_active": {
                          "type": "boolean"
                        },
                        "system_required": {
                          "type": "boolean"
                        },
                        "creation_form_instance_id": {
                          "type": "number"
                        },
                        "profile_form_instance_id": {
                          "type": "number"
                        }
                      },
                      "required": [
                        "id",
                        "name",
                        "alias",
                        "description",
                        "is_active",
                        "system_required",
                        "creation_form_instance_id",
                        "profile_form_instance_id"
                      ],
                      "additionalProperties": false
                    },
                    "items": {
                      "type": [
                        "array",
                        "null"
                      ],
                      "items": {
                        "type": "object",
                        "properties": {}
                      }
                    },
                    "options": {
                      "type": [
                        "array",
                        "null"
                      ],
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "number"
                          },
                          "name": {
                            "type": "string"
                          },
                          "position": {
                            "type": "number"
                          },
                          "value": {
                            "type": "string"
                          },
                          "is_active": {
                            "type": "boolean"
                          },
                          "is_selectable": {
                            "type": "boolean",
                            "description": "Can select on front this option (Using only in Hierarchy field))"
                          }
                        },
                        "required": [
                          "id",
                          "name",
                          "position",
                          "value",
                          "is_active",
                          "is_selectable"
                        ]
                      },
                      "description": "List of options with possible (allowed) values."
                    },
                    "settings": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      },
                      "description": "Common field settings"
                    },
                    "validation": {
                      "type": "object",
                      "properties": {
                        "type": {
                          "type": "string"
                        },
                        "attributes": {
                          "type": "object",
                          "properties": {}
                        },
                        "value_example": {
                          "type": "string"
                        },
                        "error_message": {
                          "type": "object",
                          "properties": {
                            "en": {
                              "type": "string"
                            },
                            "fr": {
                              "type": "string"
                            },
                            "de": {
                              "type": "string"
                            },
                            "es": {
                              "type": "string"
                            }
                          },
                          "required": [
                            "en",
                            "fr",
                            "de",
                            "es"
                          ]
                        }
                      },
                      "required": [
                        "type",
                        "value_example",
                        "error_message"
                      ]
                    },
                    "has_autocomplete_settings": {
                      "type": "boolean"
                    },
                    "autocomplete_settings": {
                      "type": "object",
                      "properties": {
                        "allow_extra_values": {
                          "type": "boolean"
                        },
                        "autofill": {
                          "type": "boolean"
                        },
                        "provider": {
                          "type": "object",
                          "properties": {
                            "name": {
                              "type": "object",
                              "properties": {
                                "en": {
                                  "type": "string"
                                },
                                "fr": {
                                  "type": "string"
                                },
                                "de": {
                                  "type": "string"
                                },
                                "es": {
                                  "type": "string"
                                }
                              },
                              "required": [
                                "en",
                                "fr",
                                "de",
                                "es"
                              ]
                            },
                            "alias": {
                              "type": "string"
                            },
                            "base_url": {
                              "type": "string"
                            },
                            "single_value_supported": {
                              "type": "boolean"
                            },
                            "parameters": {
                              "type": "array"
                            }
                          },
                          "required": [
                            "name",
                            "alias",
                            "base_url",
                            "single_value_supported",
                            "parameters"
                          ]
                        },
                        "parameters": {
                          "type": "array"
                        }
                      },
                      "required": [
                        "allow_extra_values",
                        "autofill",
                        "provider",
                        "parameters"
                      ]
                    }
                  },
                  "required": [
                    "id",
                    "name",
                    "position",
                    "alias",
                    "has_unique_data",
                    "has_value",
                    "removable",
                    "is_active",
                    "list",
                    "read_only",
                    "required",
                    "user_required",
                    "system_required",
                    "validation",
                    "has_autocomplete_settings",
                    "autocomplete_settings"
                  ]
                }
              },
              "options": {
                "type": [
                  "array",
                  "null"
                ],
                "items": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "number"
                    },
                    "name": {
                      "type": "string"
                    },
                    "position": {
                      "type": "number"
                    },
                    "value": {
                      "type": "string"
                    },
                    "is_active": {
                      "type": "boolean"
                    },
                    "is_selectable": {
                      "type": "boolean",
                      "description": "Can select on front this option (Using only in Hierarchy field))"
                    }
                  },
                  "required": [
                    "id",
                    "name",
                    "position",
                    "value",
                    "is_active",
                    "is_selectable"
                  ]
                },
                "description": "List of options with possible (allowed) values."
              },
              "settings": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": "Common field settings"
              },
              "validation": {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string"
                  },
                  "attributes": {
                    "type": "object",
                    "properties": {}
                  },
                  "value_example": {
                    "type": "string"
                  },
                  "error_message": {
                    "type": "object",
                    "properties": {
                      "en": {
                        "type": "string"
                      },
                      "fr": {
                        "type": "string"
                      },
                      "de": {
                        "type": "string"
                      },
                      "es": {
                        "type": "string"
                      }
                    },
                    "required": [
                      "en",
                      "fr",
                      "de",
                      "es"
                    ]
                  }
                },
                "required": [
                  "type",
                  "value_example",
                  "error_message"
                ]
              },
              "has_autocomplete_settings": {
                "type": "boolean"
              },
              "autocomplete_settings": {
                "type": "object",
                "properties": {
                  "allow_extra_values": {
                    "type": "boolean"
                  },
                  "autofill": {
                    "type": "boolean"
                  },
                  "provider": {
                    "type": "object",
                    "properties": {
                      "name": {
                        "type": "object",
                        "properties": {
                          "en": {
                            "type": "string"
                          },
                          "fr": {
                            "type": "string"
                          },
                          "de": {
                            "type": "string"
                          },
                          "es": {
                            "type": "string"
                          }
                        },
                        "required": [
                          "en",
                          "fr",
                          "de",
                          "es"
                        ]
                      },
                      "alias": {
                        "type": "string"
                      },
                      "base_url": {
                        "type": "string"
                      },
                      "single_value_supported": {
                        "type": "boolean"
                      },
                      "parameters": {
                        "type": "array"
                      }
                    },
                    "required": [
                      "name",
                      "alias",
                      "base_url",
                      "single_value_supported",
                      "parameters"
                    ]
                  },
                  "parameters": {
                    "type": "array"
                  }
                },
                "required": [
                  "allow_extra_values",
                  "autofill",
                  "provider",
                  "parameters"
                ]
              },
              "is_locked": {
                "type": "boolean"
              },
              "values": {
                "type": "string"
              },
              "value_details": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "user friendly value representation. Actual structure depends on field type"
              },
              "values_count": {
                "type": "number",
                "description": "number of values field has for current user. Meaningful only when `list` is true"
              },
              "assignment_settings": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": "Settings related to this specific Field and Form"
              },
              "assignment_permissions": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": "Permissions related to this specific Field and Form"
              },
              "access_permissions": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": "Access permissions specific for current user"
              }
            },
            "required": [
              "id",
              "name",
              "position",
              "alias",
              "has_unique_data",
              "has_value",
              "removable",
              "is_active",
              "list",
              "read_only",
              "required",
              "user_required",
              "system_required",
              "validation",
              "has_autocomplete_settings",
              "autocomplete_settings",
              "values",
              "value_details",
              "values_count",
              "access_permissions"
            ]
          }
        },
        "settings": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number"
              },
              "form_instance_id": {
                "type": "number"
              },
              "setting_id": {
                "type": "number"
              },
              "value": {
                "type": "string"
              }
            }
          }
        },
        "workflow_actions": {
          "type": "object",
          "properties": {
            "submit": {
              "type": "boolean"
            },
            "deny": {
              "type": "boolean"
            },
            "revert": {
              "type": "boolean"
            },
            "save": {
              "type": "boolean"
            }
          },
          "required": [
            "submit",
            "deny",
            "revert",
            "save"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "name",
        "description",
        "form_id",
        "is_active",
        "removable",
        "can_edit"
      ]
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Form assigment

Save data
POST/form-assignment/{formInstance}/workflow/save-data

Save Form Data for specified formInstance without progress workflow.

Example URI

POST https://rest.monportailrh.com/form-assignment/312/workflow/save-data
URI Parameters
HideShow
formInstance
number (required) Example: 312

Id of Form Assignment data related to.

Request
HideShow
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>
Body
{
  "data_owner": 1,
  "data": [
    {
      "field_id": 123,
      "field_alias": "usr_first_name",
      "value": "some value",
      "answer_id": 123,
      "batch": "d9438793-ce22-483d-8a80-9250b7f341fd",
      "action": "create"
    }
  ]
}
Schema
{
  "type": "object",
  "properties": {
    "data_owner": {
      "type": "number",
      "description": "user that assigned to formInstance."
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "field_id": {
            "type": "number",
            "description": "required without field_alias"
          },
          "field_alias": {
            "type": "string",
            "description": "required without field_id"
          },
          "value": {
            "type": "string",
            "description": "empty value will clear answer"
          },
          "answer_id": {
            "type": "number",
            "description": "needs if you try to update existed answer"
          },
          "batch": {
            "type": "string",
            "description": "needs if you works with composite list of fields"
          },
          "action": {
            "enum": [
              "create",
              "update",
              "delete"
            ]
          }
        },
        "required": [
          "action"
        ]
      }
    }
  },
  "required": [
    "data_owner"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  202
HideShow
Headers
Content-Type: application/json
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Revert form
POST/form-assignment/{formInstance}/workflow/revert

Revert Form for specified formInstance to previous step.

Example URI

POST https://rest.monportailrh.com/form-assignment/312/workflow/revert
URI Parameters
HideShow
formInstance
number (required) Example: 312

Id of Form Assignment data related to.

Request
HideShow
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>
Body
{
  "data_owner": 1,
  "message": "Comment"
}
Schema
{
  "type": "object",
  "properties": {
    "data_owner": {
      "type": "number",
      "description": "user that assigned to formInstance."
    },
    "message": {
      "type": "string",
      "description": "Text that will be send as notification to the user"
    }
  },
  "required": [
    "data_owner",
    "message"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  202
HideShow
Headers
Content-Type: application/json
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Cancel form
POST/form-assignment/{formInstance}/workflow/cancel

Cancel Form progress for specified formInstance and reset first step with clear all not approved form answers.

Example URI

POST https://rest.monportailrh.com/form-assignment/312/workflow/cancel
URI Parameters
HideShow
formInstance
number (required) Example: 312

Id of Form Assignment data related to.

Request
HideShow
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>
Body
{
  "data_owner": 1,
  "message": "Comment"
}
Schema
{
  "type": "object",
  "properties": {
    "data_owner": {
      "type": "number",
      "description": "user that assigned to formInstance."
    },
    "message": {
      "type": "string",
      "description": "Text that will be send as notification to the user"
    }
  },
  "required": [
    "data_owner",
    "message"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  202
HideShow
Headers
Content-Type: application/json
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Fields Categories

Fields categories.

Fields Categories

List
GET/category{?pso-type,active,search,include,sort-by,sort-direction,page,per-page,no-pagination}

Fetch list of fields categories

Example URI

GET https://rest.monportailrh.com/category?pso-type=usr&active=true&search=Category to search&include=pso_type&sort-by=name&sort-direction=asc&page=1&per-page=10&no-pagination=false
URI Parameters
HideShow
pso-type
string (optional) Example: usr

PSO type alias to filtering. Strict, case-insensitive

active
boolean (optional) Example: true

To filtering fields categories by active state

search
string (optional) Example: Category to search

Search by fields categories title. Non strict, case-insensitive.

include
pso_type (optional) Example: pso_type

The way to include relations in the response.

sort-by
name, pso-type (optional) Default: name Example: name

Field to sort fields categories by.

sort-direction
asc, desc (optional) Default: asc Example: asc

Direction to order fields categories by.

page
number (required) Example: 1

Page number. 1 by default

per-page
number (required) Example: 10

Number of items per page, 25 by default

no-pagination
boolean (required) Example: false

if presented and positive pagination will not be applied. All available items will be returned.

Note: it may have significant impact on the performance

Note: once this option positive and presented - meta attribute with pagination data will be omit in response

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": 32,
      "alias": "usr_identity",
      "position": 5,
      "system_required": true,
      "name": "Identity",
      "description": "...",
      "is_active": true,
      "pso_type": {
        "id": 56,
        "name": "User",
        "alias": "usr",
        "description": "...",
        "is_active": true,
        "system_required": true,
        "creation_form_instance_id": 1,
        "profile_form_instance_id": 1
      }
    }
  ],
  "meta": {
    "pagination": {
      "total": 238,
      "count": 25,
      "per_page": 25,
      "current_page": 2,
      "total_pages": 10,
      "links": {
        "previous": "http://example.com/api/<endpoint>?page=1",
        "next": "http://example.com/api/<endpoint>?page=3"
      }
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number"
          },
          "alias": {
            "type": "string"
          },
          "position": {
            "type": "number"
          },
          "system_required": {
            "type": "boolean"
          },
          "name": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "is_active": {
            "type": "boolean"
          },
          "pso_type": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number"
              },
              "name": {
                "type": "string"
              },
              "alias": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "is_active": {
                "type": "boolean"
              },
              "system_required": {
                "type": "boolean"
              },
              "creation_form_instance_id": {
                "type": "number"
              },
              "profile_form_instance_id": {
                "type": "number"
              }
            },
            "required": [
              "id",
              "name",
              "alias",
              "description",
              "is_active",
              "system_required",
              "creation_form_instance_id",
              "profile_form_instance_id"
            ],
            "additionalProperties": false,
            "description": "Presented only if `include` was send"
          }
        },
        "required": [
          "id",
          "alias",
          "position",
          "system_required",
          "name",
          "description",
          "is_active"
        ]
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number"
            },
            "count": {
              "type": "number"
            },
            "per_page": {
              "type": "number"
            },
            "current_page": {
              "type": "number"
            },
            "total_pages": {
              "type": "number"
            },
            "links": {
              "type": "object",
              "properties": {
                "previous": {
                  "type": "string"
                },
                "next": {
                  "type": "string"
                }
              },
              "required": [
                "previous",
                "next"
              ]
            }
          },
          "required": [
            "total",
            "count",
            "per_page",
            "current_page",
            "total_pages",
            "links"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "pagination"
      ]
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Create
POST/category

Create new field category item

Example URI

POST https://rest.monportailrh.com/category
Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Body
{
  "pso_type": "usr",
  "name": {
    "en": "Some text",
    "fr": "Du texte",
    "de": "Setwas Text",
    "es": "Algún texto"
  },
  "description": {
    "en": "Some text",
    "fr": "Du texte",
    "de": "Setwas Text",
    "es": "Algún texto"
  },
  "is_active": true,
  "alias": "usr_global",
  "position": 5
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "pso_type": {
      "type": "string"
    },
    "name": {
      "type": "object",
      "properties": {
        "en": {
          "type": "string"
        },
        "fr": {
          "type": "string"
        },
        "de": {
          "type": "string"
        },
        "es": {
          "type": "string"
        }
      },
      "required": [
        "en",
        "fr",
        "de",
        "es"
      ]
    },
    "description": {
      "type": "object",
      "properties": {
        "en": {
          "type": "string"
        },
        "fr": {
          "type": "string"
        },
        "de": {
          "type": "string"
        },
        "es": {
          "type": "string"
        }
      },
      "required": [
        "en",
        "fr",
        "de",
        "es"
      ]
    },
    "alias": {
      "type": "string"
    },
    "position": {
      "type": "number"
    },
    "is_active": {
      "type": "boolean"
    }
  },
  "required": [
    "pso_type",
    "name",
    "position",
    "is_active"
  ]
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 32,
    "alias": "usr_identity",
    "position": 5,
    "system_required": true,
    "name": "Identity",
    "description": "...",
    "is_active": true,
    "pso_type": {
      "id": 56,
      "name": "User",
      "alias": "usr",
      "description": "...",
      "is_active": true,
      "system_required": true,
      "creation_form_instance_id": 1,
      "profile_form_instance_id": 1
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "alias": {
          "type": "string"
        },
        "position": {
          "type": "number"
        },
        "system_required": {
          "type": "boolean"
        },
        "name": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "is_active": {
          "type": "boolean"
        },
        "pso_type": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "name": {
              "type": "string"
            },
            "alias": {
              "type": "string"
            },
            "description": {
              "type": "string"
            },
            "is_active": {
              "type": "boolean"
            },
            "system_required": {
              "type": "boolean"
            },
            "creation_form_instance_id": {
              "type": "number"
            },
            "profile_form_instance_id": {
              "type": "number"
            }
          },
          "required": [
            "id",
            "name",
            "alias",
            "description",
            "is_active",
            "system_required",
            "creation_form_instance_id",
            "profile_form_instance_id"
          ],
          "additionalProperties": false,
          "description": "Presented only if `include` was send"
        }
      },
      "required": [
        "id",
        "alias",
        "position",
        "system_required",
        "name",
        "description",
        "is_active"
      ],
      "additionalProperties": false
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 400
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/category/{alias}{?include}

Fetch single fields category item

Example URI

GET https://rest.monportailrh.com/category/somedomain?include=pso_type
URI Parameters
HideShow
alias
string (required) Example: somedomain

Alias of the Category item.

include
pso_type (optional) Example: pso_type

The way to include relations in the response.

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 32,
    "alias": "usr_identity",
    "position": 5,
    "system_required": true,
    "name": "Identity",
    "description": "...",
    "is_active": true,
    "pso_type": {
      "id": 56,
      "name": "User",
      "alias": "usr",
      "description": "...",
      "is_active": true,
      "system_required": true,
      "creation_form_instance_id": 1,
      "profile_form_instance_id": 1
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "alias": {
          "type": "string"
        },
        "position": {
          "type": "number"
        },
        "system_required": {
          "type": "boolean"
        },
        "name": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "is_active": {
          "type": "boolean"
        },
        "pso_type": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "name": {
              "type": "string"
            },
            "alias": {
              "type": "string"
            },
            "description": {
              "type": "string"
            },
            "is_active": {
              "type": "boolean"
            },
            "system_required": {
              "type": "boolean"
            },
            "creation_form_instance_id": {
              "type": "number"
            },
            "profile_form_instance_id": {
              "type": "number"
            }
          },
          "required": [
            "id",
            "name",
            "alias",
            "description",
            "is_active",
            "system_required",
            "creation_form_instance_id",
            "profile_form_instance_id"
          ],
          "additionalProperties": false,
          "description": "Presented only if `include` was send"
        }
      },
      "required": [
        "id",
        "alias",
        "position",
        "system_required",
        "name",
        "description",
        "is_active"
      ],
      "additionalProperties": false
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete
DELETE/category/{alias}

Delete fields category item

Example URI

DELETE https://rest.monportailrh.com/category/somedomain
URI Parameters
HideShow
alias
string (required) Example: somedomain

Alias of the Category item.

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Response  204
HideShow
Headers
Content-Type: application/json
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/category/{alias}

Update fields category item

Example URI

PATCH https://rest.monportailrh.com/category/somedomain
URI Parameters
HideShow
alias
string (required) Example: somedomain

Alias of the Category item.

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Body
{
  "name": {
    "en": "Some text",
    "fr": "Du texte",
    "de": "Setwas Text",
    "es": "Algún texto"
  },
  "description": {
    "en": "Some text",
    "fr": "Du texte",
    "de": "Setwas Text",
    "es": "Algún texto"
  },
  "position": 5,
  "system_required": true,
  "is_active": true,
  "alias": "usr_global",
  "is_public": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "object",
      "properties": {
        "en": {
          "type": "string"
        },
        "fr": {
          "type": "string"
        },
        "de": {
          "type": "string"
        },
        "es": {
          "type": "string"
        }
      },
      "required": [
        "en",
        "fr",
        "de",
        "es"
      ]
    },
    "description": {
      "type": "object",
      "properties": {
        "en": {
          "type": "string"
        },
        "fr": {
          "type": "string"
        },
        "de": {
          "type": "string"
        },
        "es": {
          "type": "string"
        }
      },
      "required": [
        "en",
        "fr",
        "de",
        "es"
      ]
    },
    "system_required": {
      "type": "boolean"
    },
    "position": {
      "type": "number"
    },
    "alias": {
      "type": "string"
    },
    "is_active": {
      "type": "boolean"
    },
    "is_public": {
      "type": "boolean"
    }
  },
  "required": [
    "position",
    "is_active",
    "is_public"
  ]
}
Response  202
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 32,
    "alias": "usr_identity",
    "position": 5,
    "system_required": true,
    "name": "Identity",
    "description": "...",
    "is_active": true,
    "pso_type": {
      "id": 56,
      "name": "User",
      "alias": "usr",
      "description": "...",
      "is_active": true,
      "system_required": true,
      "creation_form_instance_id": 1,
      "profile_form_instance_id": 1
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "alias": {
          "type": "string"
        },
        "position": {
          "type": "number"
        },
        "system_required": {
          "type": "boolean"
        },
        "name": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "is_active": {
          "type": "boolean"
        },
        "pso_type": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "name": {
              "type": "string"
            },
            "alias": {
              "type": "string"
            },
            "description": {
              "type": "string"
            },
            "is_active": {
              "type": "boolean"
            },
            "system_required": {
              "type": "boolean"
            },
            "creation_form_instance_id": {
              "type": "number"
            },
            "profile_form_instance_id": {
              "type": "number"
            }
          },
          "required": [
            "id",
            "name",
            "alias",
            "description",
            "is_active",
            "system_required",
            "creation_form_instance_id",
            "profile_form_instance_id"
          ],
          "additionalProperties": false,
          "description": "Presented only if `include` was send"
        }
      },
      "required": [
        "id",
        "alias",
        "position",
        "system_required",
        "name",
        "description",
        "is_active"
      ],
      "additionalProperties": false
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 400
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Chats

Chats section.

Chats

List
GET/chats{?include-empty}

Fetch list of chats

Permissions

  • hr_request.view.chat

Example URI

GET https://rest.monportailrh.com/chats?include-empty=false
URI Parameters
HideShow
include-empty
boolean (optional) Example: false

Include new and still empty chats.

By default API returns only not empty chats. To see empty chats you need add that param.

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": 1,
      "author": {
        "id": 1,
        "external_id": 1,
        "first_name": "John",
        "last_name": "Snow",
        "username": "john_snow",
        "professional_email": "jsnow@example.com",
        "professional_mobile_phone": "00 33 1 40 00 00 00",
        "professional_phone": "00 33 1 40 00 00 00",
        "role": [
          "bastard",
          "king"
        ],
        "is_active": true,
        "status": "remote",
        "settings": [
          "[]"
        ],
        "user_photo": "http://example.com/images/1.jpg"
      },
      "title": "Chat title",
      "is_viewed_by_user": true,
      "is_viewed_by_hr": true,
      "status": "opened",
      "created_at": "2019-04-24 11:47:47",
      "updated_at": "2019-04-24 11:47:47"
    }
  ],
  "meta": {
    "pagination": {
      "total": 238,
      "count": 25,
      "per_page": 25,
      "current_page": 2,
      "total_pages": 10,
      "links": {
        "previous": "http://example.com/api/<endpoint>?page=1",
        "next": "http://example.com/api/<endpoint>?page=3"
      }
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number"
          },
          "author": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number"
              },
              "external_id": {
                "type": "number"
              },
              "first_name": {
                "type": "string"
              },
              "last_name": {
                "type": "string"
              },
              "username": {
                "type": "string"
              },
              "professional_email": {
                "type": "string"
              },
              "professional_mobile_phone": {
                "type": "string"
              },
              "professional_phone": {
                "type": "string"
              },
              "role": {
                "type": "array"
              },
              "is_active": {
                "type": "boolean"
              },
              "status": {
                "type": "string"
              },
              "settings": {
                "type": "array"
              },
              "user_photo": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "external_id",
              "first_name",
              "last_name",
              "username",
              "professional_email",
              "professional_mobile_phone",
              "professional_phone",
              "role",
              "is_active",
              "status",
              "settings",
              "user_photo"
            ],
            "additionalProperties": false
          },
          "title": {
            "type": "string"
          },
          "is_viewed_by_user": {
            "type": "boolean"
          },
          "is_viewed_by_hr": {
            "type": "boolean"
          },
          "status": {
            "type": "string",
            "enum": [
              "opened",
              "closed"
            ]
          },
          "created_at": {
            "type": "string"
          },
          "updated_at": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "author",
          "title",
          "is_viewed_by_user",
          "is_viewed_by_hr",
          "status",
          "created_at",
          "updated_at"
        ]
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number"
            },
            "count": {
              "type": "number"
            },
            "per_page": {
              "type": "number"
            },
            "current_page": {
              "type": "number"
            },
            "total_pages": {
              "type": "number"
            },
            "links": {
              "type": "object",
              "properties": {
                "previous": {
                  "type": "string"
                },
                "next": {
                  "type": "string"
                }
              },
              "required": [
                "previous",
                "next"
              ]
            }
          },
          "required": [
            "total",
            "count",
            "per_page",
            "current_page",
            "total_pages",
            "links"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "pagination"
      ]
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Create
POST/chats

Create a new chat.

Permissions

  • hr_request.create.chat

Example URI

POST https://rest.monportailrh.com/chats
Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: '*'
Body
{
  "title": {
    "en": "Some text",
    "fr": "Du texte",
    "de": "Setwas Text",
    "es": "Algún texto"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "title": {
      "type": "object",
      "properties": {
        "en": {
          "type": "string"
        },
        "fr": {
          "type": "string"
        },
        "de": {
          "type": "string"
        },
        "es": {
          "type": "string"
        }
      },
      "required": [
        "en",
        "fr",
        "de",
        "es"
      ]
    }
  },
  "required": [
    "title"
  ]
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 1,
    "author": {
      "id": 1,
      "external_id": 1,
      "first_name": "John",
      "last_name": "Snow",
      "username": "john_snow",
      "professional_email": "jsnow@example.com",
      "professional_mobile_phone": "00 33 1 40 00 00 00",
      "professional_phone": "00 33 1 40 00 00 00",
      "role": [
        "bastard",
        "king"
      ],
      "is_active": true,
      "status": "remote",
      "settings": [
        "[]"
      ],
      "user_photo": "http://example.com/images/1.jpg"
    },
    "title": "Chat title",
    "is_viewed_by_user": true,
    "is_viewed_by_hr": true,
    "status": "opened",
    "created_at": "2019-04-24 11:47:47",
    "updated_at": "2019-04-24 11:47:47"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "author": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "external_id": {
              "type": "number"
            },
            "first_name": {
              "type": "string"
            },
            "last_name": {
              "type": "string"
            },
            "username": {
              "type": "string"
            },
            "professional_email": {
              "type": "string"
            },
            "professional_mobile_phone": {
              "type": "string"
            },
            "professional_phone": {
              "type": "string"
            },
            "role": {
              "type": "array"
            },
            "is_active": {
              "type": "boolean"
            },
            "status": {
              "type": "string"
            },
            "settings": {
              "type": "array"
            },
            "user_photo": {
              "type": "string"
            }
          },
          "required": [
            "id",
            "external_id",
            "first_name",
            "last_name",
            "username",
            "professional_email",
            "professional_mobile_phone",
            "professional_phone",
            "role",
            "is_active",
            "status",
            "settings",
            "user_photo"
          ],
          "additionalProperties": false
        },
        "title": {
          "type": "string"
        },
        "is_viewed_by_user": {
          "type": "boolean"
        },
        "is_viewed_by_hr": {
          "type": "boolean"
        },
        "status": {
          "type": "string",
          "enum": [
            "opened",
            "closed"
          ]
        },
        "created_at": {
          "type": "string"
        },
        "updated_at": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "author",
        "title",
        "is_viewed_by_user",
        "is_viewed_by_hr",
        "status",
        "created_at",
        "updated_at"
      ],
      "additionalProperties": false
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 400
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/chats/{id}

Get single chat item and mark it as viewed.

Permissions

Chat can be showed only for the author or user with hr_request.edit.chat permission

Example URI

GET https://rest.monportailrh.com/chats/5
URI Parameters
HideShow
id
number (required) Example: 5

Id of the Chat item.

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: '*'
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 1,
    "author": {
      "id": 1,
      "external_id": 1,
      "first_name": "John",
      "last_name": "Snow",
      "username": "john_snow",
      "professional_email": "jsnow@example.com",
      "professional_mobile_phone": "00 33 1 40 00 00 00",
      "professional_phone": "00 33 1 40 00 00 00",
      "role": [
        "bastard",
        "king"
      ],
      "is_active": true,
      "status": "remote",
      "settings": [
        "[]"
      ],
      "user_photo": "http://example.com/images/1.jpg"
    },
    "title": "Chat title",
    "is_viewed_by_user": true,
    "is_viewed_by_hr": true,
    "status": "opened",
    "created_at": "2019-04-24 11:47:47",
    "updated_at": "2019-04-24 11:47:47"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "author": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "external_id": {
              "type": "number"
            },
            "first_name": {
              "type": "string"
            },
            "last_name": {
              "type": "string"
            },
            "username": {
              "type": "string"
            },
            "professional_email": {
              "type": "string"
            },
            "professional_mobile_phone": {
              "type": "string"
            },
            "professional_phone": {
              "type": "string"
            },
            "role": {
              "type": "array"
            },
            "is_active": {
              "type": "boolean"
            },
            "status": {
              "type": "string"
            },
            "settings": {
              "type": "array"
            },
            "user_photo": {
              "type": "string"
            }
          },
          "required": [
            "id",
            "external_id",
            "first_name",
            "last_name",
            "username",
            "professional_email",
            "professional_mobile_phone",
            "professional_phone",
            "role",
            "is_active",
            "status",
            "settings",
            "user_photo"
          ],
          "additionalProperties": false
        },
        "title": {
          "type": "string"
        },
        "is_viewed_by_user": {
          "type": "boolean"
        },
        "is_viewed_by_hr": {
          "type": "boolean"
        },
        "status": {
          "type": "string",
          "enum": [
            "opened",
            "closed"
          ]
        },
        "created_at": {
          "type": "string"
        },
        "updated_at": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "author",
        "title",
        "is_viewed_by_user",
        "is_viewed_by_hr",
        "status",
        "created_at",
        "updated_at"
      ],
      "additionalProperties": false
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/chats/{id}

Update chat status

Permissions

  • hr_request.edit.chat

Example URI

PATCH https://rest.monportailrh.com/chats/123
URI Parameters
HideShow
id
number (required) Example: 123

Id of the chat.

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Body
{
  "status": "opened"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "opened",
        "closed"
      ]
    }
  },
  "required": [
    "status"
  ]
}
Response  202
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 1,
    "author": {
      "id": 1,
      "external_id": 1,
      "first_name": "John",
      "last_name": "Snow",
      "username": "john_snow",
      "professional_email": "jsnow@example.com",
      "professional_mobile_phone": "00 33 1 40 00 00 00",
      "professional_phone": "00 33 1 40 00 00 00",
      "role": [
        "bastard",
        "king"
      ],
      "is_active": true,
      "status": "remote",
      "settings": [
        "[]"
      ],
      "user_photo": "http://example.com/images/1.jpg"
    },
    "title": "Chat title",
    "is_viewed_by_user": true,
    "is_viewed_by_hr": true,
    "status": "opened",
    "created_at": "2019-04-24 11:47:47",
    "updated_at": "2019-04-24 11:47:47"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "author": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "external_id": {
              "type": "number"
            },
            "first_name": {
              "type": "string"
            },
            "last_name": {
              "type": "string"
            },
            "username": {
              "type": "string"
            },
            "professional_email": {
              "type": "string"
            },
            "professional_mobile_phone": {
              "type": "string"
            },
            "professional_phone": {
              "type": "string"
            },
            "role": {
              "type": "array"
            },
            "is_active": {
              "type": "boolean"
            },
            "status": {
              "type": "string"
            },
            "settings": {
              "type": "array"
            },
            "user_photo": {
              "type": "string"
            }
          },
          "required": [
            "id",
            "external_id",
            "first_name",
            "last_name",
            "username",
            "professional_email",
            "professional_mobile_phone",
            "professional_phone",
            "role",
            "is_active",
            "status",
            "settings",
            "user_photo"
          ],
          "additionalProperties": false
        },
        "title": {
          "type": "string"
        },
        "is_viewed_by_user": {
          "type": "boolean"
        },
        "is_viewed_by_hr": {
          "type": "boolean"
        },
        "status": {
          "type": "string",
          "enum": [
            "opened",
            "closed"
          ]
        },
        "created_at": {
          "type": "string"
        },
        "updated_at": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "author",
        "title",
        "is_viewed_by_user",
        "is_viewed_by_hr",
        "status",
        "created_at",
        "updated_at"
      ],
      "additionalProperties": false
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 400
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Messages

List
GET/chats/{id}/messages

Fetch list of chat messages(with attachments, if added). Visiting that url also marks chat as viewed.

Permissions

User should be chat’s author or have hr_request.edit.chat

Example URI

GET https://rest.monportailrh.com/chats/5/messages
URI Parameters
HideShow
id
number (required) Example: 5

Chat id

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": 1,
      "author": {
        "id": 1,
        "external_id": 1,
        "first_name": "John",
        "last_name": "Snow",
        "username": "john_snow",
        "professional_email": "jsnow@example.com",
        "professional_mobile_phone": "00 33 1 40 00 00 00",
        "professional_phone": "00 33 1 40 00 00 00",
        "role": [
          "bastard",
          "king"
        ],
        "is_active": true,
        "status": "remote",
        "settings": [
          "[]"
        ],
        "user_photo": "http://example.com/images/1.jpg"
      },
      "chat_id": 1,
      "message": "Message text",
      "attachments": [
        {
          "id": 1,
          "url": "http://example.com/images/logo.jpg",
          "original_name": "logo",
          "format": "jpg"
        }
      ],
      "created_at": "2019-04-24 11:47:47"
    }
  ],
  "meta": {
    "pagination": {
      "total": 238,
      "count": 25,
      "per_page": 25,
      "current_page": 2,
      "total_pages": 10,
      "links": {
        "previous": "http://example.com/api/<endpoint>?page=1",
        "next": "http://example.com/api/<endpoint>?page=3"
      }
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number"
          },
          "author": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number"
              },
              "external_id": {
                "type": "number"
              },
              "first_name": {
                "type": "string"
              },
              "last_name": {
                "type": "string"
              },
              "username": {
                "type": "string"
              },
              "professional_email": {
                "type": "string"
              },
              "professional_mobile_phone": {
                "type": "string"
              },
              "professional_phone": {
                "type": "string"
              },
              "role": {
                "type": "array"
              },
              "is_active": {
                "type": "boolean"
              },
              "status": {
                "type": "string"
              },
              "settings": {
                "type": "array"
              },
              "user_photo": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "external_id",
              "first_name",
              "last_name",
              "username",
              "professional_email",
              "professional_mobile_phone",
              "professional_phone",
              "role",
              "is_active",
              "status",
              "settings",
              "user_photo"
            ],
            "additionalProperties": false
          },
          "chat_id": {
            "type": "number"
          },
          "message": {
            "type": "string"
          },
          "attachments": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number"
                },
                "url": {
                  "type": "string"
                },
                "original_name": {
                  "type": "string"
                },
                "format": {
                  "type": "string"
                }
              },
              "required": [
                "id",
                "url",
                "original_name",
                "format"
              ]
            }
          },
          "created_at": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "author",
          "chat_id",
          "message",
          "created_at"
        ]
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number"
            },
            "count": {
              "type": "number"
            },
            "per_page": {
              "type": "number"
            },
            "current_page": {
              "type": "number"
            },
            "total_pages": {
              "type": "number"
            },
            "links": {
              "type": "object",
              "properties": {
                "previous": {
                  "type": "string"
                },
                "next": {
                  "type": "string"
                }
              },
              "required": [
                "previous",
                "next"
              ]
            }
          },
          "required": [
            "total",
            "count",
            "per_page",
            "current_page",
            "total_pages",
            "links"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "pagination"
      ]
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Create
POST/chats/{id}/messages

Create a new message into the chat.

Permissions

User should be chat’s author or have hr_request.edit.chat

Example URI

POST https://rest.monportailrh.com/chats/5/messages
URI Parameters
HideShow
id
number (required) Example: 5

Target chat id

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: '*'
Body
{
  "message": "Message body",
  "attachments": [
    {
      "url": "http://example.com/images/logo.jpg",
      "original_name": "logo",
      "format": "jpg"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": [
        "string",
        "null"
      ],
      "description": "max length 255 chars."
    },
    "attachments": {
      "type": "array"
    }
  },
  "required": [
    "message"
  ]
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 1,
    "author": {
      "id": 1,
      "external_id": 1,
      "first_name": "John",
      "last_name": "Snow",
      "username": "john_snow",
      "professional_email": "jsnow@example.com",
      "professional_mobile_phone": "00 33 1 40 00 00 00",
      "professional_phone": "00 33 1 40 00 00 00",
      "role": [
        "bastard",
        "king"
      ],
      "is_active": true,
      "status": "remote",
      "settings": [
        "[]"
      ],
      "user_photo": "http://example.com/images/1.jpg"
    },
    "chat_id": 1,
    "message": "Message text",
    "attachments": [
      {
        "id": 1,
        "url": "http://example.com/images/logo.jpg",
        "original_name": "logo",
        "format": "jpg"
      }
    ],
    "created_at": "2019-04-24 11:47:47"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "author": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "external_id": {
              "type": "number"
            },
            "first_name": {
              "type": "string"
            },
            "last_name": {
              "type": "string"
            },
            "username": {
              "type": "string"
            },
            "professional_email": {
              "type": "string"
            },
            "professional_mobile_phone": {
              "type": "string"
            },
            "professional_phone": {
              "type": "string"
            },
            "role": {
              "type": "array"
            },
            "is_active": {
              "type": "boolean"
            },
            "status": {
              "type": "string"
            },
            "settings": {
              "type": "array"
            },
            "user_photo": {
              "type": "string"
            }
          },
          "required": [
            "id",
            "external_id",
            "first_name",
            "last_name",
            "username",
            "professional_email",
            "professional_mobile_phone",
            "professional_phone",
            "role",
            "is_active",
            "status",
            "settings",
            "user_photo"
          ],
          "additionalProperties": false
        },
        "chat_id": {
          "type": "number"
        },
        "message": {
          "type": "string"
        },
        "attachments": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number"
              },
              "url": {
                "type": "string"
              },
              "original_name": {
                "type": "string"
              },
              "format": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "url",
              "original_name",
              "format"
            ]
          }
        },
        "created_at": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "author",
        "chat_id",
        "message",
        "created_at"
      ],
      "additionalProperties": false
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 400
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Company

Show info

Show info
GET/companies/info

Fetch company info

Example URI

GET https://rest.monportailrh.com/companies/info
Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <comma separated features>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "name": "First Company",
    "external_id": "absdfdfdf-bsdsvsdfgbf-fdsdfsd",
    "phone": "89348612390",
    "employees_count": 10,
    "settings": [
      {
        "alias": "default_language",
        "value": "en"
      },
      {
        "alias": "background_color",
        "value": "#5f5c28"
      },
      {
        "alias": "icon_color",
        "value": "#5f5c28"
      },
      {
        "alias": "title_color",
        "value": "#5f5c28"
      },
      {
        "alias": "second_title_color",
        "value": "#5f5c28"
      },
      {
        "alias": "button_color",
        "value": "#5f5c28"
      },
      {
        "alias": "web_logo",
        "value": "https://rest-dev.monportailrh.com/storage/company/logo.png"
      },
      {
        "alias": "logout_url",
        "value": "https://example.com"
      },
      {
        "alias": "idp_name",
        "value": "value of idp_name"
      },
      {
        "alias": "idp_type",
        "value": "value of idp_type"
      },
      {
        "alias": "identifier_type",
        "value": "value of identifier_type"
      }
    ]
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "external_id": {
          "type": "string"
        },
        "phone": {
          "type": "string"
        },
        "employees_count": {
          "type": "number"
        },
        "settings": {
          "type": "array"
        }
      },
      "required": [
        "name",
        "external_id",
        "phone",
        "employees_count",
        "settings"
      ],
      "additionalProperties": false
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show settings

Show settings
GET/companies/settings?

Fetch company settings

Example URI

GET https://rest.monportailrh.com/companies/settings?
Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <comma separated features>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "alias": "default_language",
      "value": "en"
    },
    {
      "alias": "background_color",
      "value": "#5f5c28"
    },
    {
      "alias": "icon_color",
      "value": "#5f5c28"
    },
    {
      "alias": "title_color",
      "value": "#5f5c28"
    },
    {
      "alias": "second_title_color",
      "value": "#5f5c28"
    },
    {
      "alias": "button_color",
      "value": "#5f5c28"
    },
    {
      "alias": "web_logo",
      "value": "https://rest-dev.monportailrh.com/storage/company/logo.png"
    },
    {
      "alias": "logout_url",
      "value": "https://example.com"
    },
    {
      "alias": "idp_name",
      "value": "value of idp_name"
    },
    {
      "alias": "idp_type",
      "value": "value of idp_type"
    },
    {
      "alias": "identifier_type",
      "value": "value of identifier_type"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": [
        {
          "type": "object",
          "properties": {
            "alias": {
              "type": "string",
              "enum": [
                "default_language"
              ]
            },
            "value": {
              "type": [
                "string",
                "null"
              ],
              "enum": [
                "en",
                null
              ]
            }
          },
          "required": [
            "alias"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "alias": {
              "type": "string",
              "enum": [
                "background_color"
              ]
            },
            "value": {
              "type": [
                "string",
                "null"
              ],
              "enum": [
                "#5f5c28",
                null
              ]
            }
          },
          "required": [
            "alias"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "alias": {
              "type": "string",
              "enum": [
                "icon_color"
              ]
            },
            "value": {
              "type": [
                "string",
                "null"
              ],
              "enum": [
                "#5f5c28",
                null
              ]
            }
          },
          "required": [
            "alias"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "alias": {
              "type": "string",
              "enum": [
                "title_color"
              ]
            },
            "value": {
              "type": [
                "string",
                "null"
              ],
              "enum": [
                "#5f5c28",
                null
              ]
            }
          },
          "required": [
            "alias"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "alias": {
              "type": "string",
              "enum": [
                "second_title_color"
              ]
            },
            "value": {
              "type": [
                "string",
                "null"
              ],
              "enum": [
                "#5f5c28",
                null
              ]
            }
          },
          "required": [
            "alias"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "alias": {
              "type": "string",
              "enum": [
                "button_color"
              ]
            },
            "value": {
              "type": [
                "string",
                "null"
              ],
              "enum": [
                "#5f5c28",
                null
              ]
            }
          },
          "required": [
            "alias"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "alias": {
              "type": "string",
              "enum": [
                "web_logo"
              ]
            },
            "value": {
              "type": [
                "string",
                "null"
              ],
              "enum": [
                "https://rest-dev.monportailrh.com/storage/company/logo.png",
                null
              ]
            }
          },
          "required": [
            "alias"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "alias": {
              "type": "string",
              "enum": [
                "logout_url"
              ]
            },
            "value": {
              "type": [
                "string",
                "null"
              ],
              "enum": [
                "https://example.com",
                null
              ]
            }
          },
          "required": [
            "alias"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "alias": {
              "type": "string",
              "enum": [
                "idp_name"
              ]
            },
            "value": {
              "type": [
                "string",
                "null"
              ],
              "enum": [
                "value of idp_name",
                null
              ]
            }
          },
          "required": [
            "alias",
            "value"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "alias": {
              "type": "string",
              "enum": [
                "idp_type"
              ]
            },
            "value": {
              "type": [
                "string",
                "null"
              ],
              "enum": [
                "value of idp_type",
                null
              ]
            }
          },
          "required": [
            "alias",
            "value"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "alias": {
              "type": "string",
              "enum": [
                "identifier_type"
              ]
            },
            "value": {
              "type": [
                "string",
                "null"
              ],
              "enum": [
                "value of identifier_type",
                null
              ]
            }
          },
          "required": [
            "alias",
            "value"
          ],
          "additionalProperties": false
        }
      ]
    }
  },
  "required": [
    "data"
  ]
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update settings

Update settings
PATCH/companies/settings

Update company settings

Example URI

PATCH https://rest.monportailrh.com/companies/settings
Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Body
{
  "default_language": "en",
  "background_color": "#5f5c28",
  "header_color": "#5f5c28",
  "icon_color": "#5f5c28",
  "title_color": "#5f5c28",
  "second_title_color": "#5f5c28",
  "button_color": "#5f5c28",
  "web_logo": "https://rest-dev.monportailrh.com/storage/company/logo.png",
  "logout_url": "https://example.com",
  "idp_name": "value",
  "idp_type": "value",
  "identifier_type": "#5f5c28"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "default_language": {
      "type": [
        "string",
        "null"
      ]
    },
    "background_color": {
      "type": [
        "string",
        "null"
      ]
    },
    "header_color": {
      "type": [
        "string",
        "null"
      ]
    },
    "icon_color": {
      "type": [
        "string",
        "null"
      ]
    },
    "title_color": {
      "type": [
        "string",
        "null"
      ]
    },
    "second_title_color": {
      "type": [
        "string",
        "null"
      ]
    },
    "button_color": {
      "type": [
        "string",
        "null"
      ]
    },
    "web_logo": {
      "type": [
        "string",
        "null"
      ]
    },
    "logout_url": {
      "type": [
        "string",
        "null"
      ]
    },
    "idp_name": {
      "type": [
        "string",
        "null"
      ]
    },
    "idp_type": {
      "type": [
        "string",
        "null"
      ]
    },
    "identifier_type": {
      "type": "string"
    }
  }
}
Response  202
HideShow
Headers
Content-Type: application/json
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 400
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Connector Builder

Connector builder consists from few parts.

Export Export is a way to extract desired data from system to the file (CSV or XLS)

Management Permissions:

  • connector_builder_export.manage.* - Allows to create, edit and remove export mappings for all Pso Types

Pso Type specific permissions:

  • connector_builder_export.manage.<trigram> - Allows to create, edit and remove export mappings for specific Pso Type only

Common flow Once the export map created - it may be used to do an export. Preparing and formatting data may take some time, so it will be done in asynchronous way. To initiate the process we need to run export (see related section). status for affected export map will be changed to processing Once the process completed status for affected export map will be changed to done or failed (it depends whether result successful or not) More details about export process can be got by using Export Logs endpoint

Import Import is a way to load desired data into system from file (XLS)

Pso Type specific permissions:

  • connector_builder_imports.manage.<trigram>

Exports

List
GET/connector-builder/exports{?name,pso-type,active,type,sort,order,include}

Fetch list of export maps

Example URI

GET https://rest.monportailrh.com/connector-builder/exports?name=Export map to search for&pso-type=usr&active=true&type=shared&sort=title&order=asc&include=pso_type,language
URI Parameters
HideShow
name
string (optional) Example: Export map to search for

Search by name. Non strict, case-insensitive.

pso-type
string (required) Example: usr

Pso Type trigram to filter export maps for

active
boolean (optional) Example: true

Field for filter exports by is_active column

type
shared, owned (optional) Example: shared

If presented will be used to filter mappings by type

sort
pso-type, name (optional) Default: name Example: title

Field to sort export maps by.

order
asc, desc (optional) Default: asc Example: asc

Direction to order export maps by.

include
pso_type, mapping, mapping.root_field, language, owner, population (optional) Example: pso_type,language

The way to include relations in the response. Target relations can be comma separated if you want to get few of them

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": 132,
      "alias": "my_widget",
      "name": "Export mapping Name",
      "description": "Some description",
      "pso_type": {
        "id": 56,
        "name": "User",
        "alias": "usr",
        "description": "...",
        "is_active": true,
        "system_required": true,
        "creation_form_instance_id": 1,
        "profile_form_instance_id": 1
      },
      "is_active": true,
      "is_locked": false,
      "status": "new",
      "type": "owned",
      "report_file": "filename.csv",
      "mapping": [
        {
          "internal": 123,
          "external": "Active",
          "root_field": {
            "id": 1,
            "name": "Field Name",
            "position": 5,
            "alias": "usr_first_name",
            "has_unique_data": false,
            "has_value": true,
            "removable": false,
            "is_active": true,
            "list": false,
            "read_only": false,
            "required": true,
            "user_required": true,
            "system_required": true,
            "type": {
              "id": 1,
              "name": "Data Type Name",
              "alias": "data_type_alias",
              "settings": [
                {
                  "id": 1,
                  "name": "Data Type Setting Name",
                  "alias": "data_type_setting_alias",
                  "is_required": true
                }
              ],
              "supports_collection": false,
              "supports_read_only": false,
              "supports_unique": false
            },
            "category": {
              "id": 32,
              "alias": "usr_identity",
              "position": 5,
              "system_required": true,
              "name": "Identity",
              "description": "...",
              "is_active": true,
              "pso_type": {
                "id": 56,
                "name": "User",
                "alias": "usr",
                "description": "...",
                "is_active": true,
                "system_required": true,
                "creation_form_instance_id": 1,
                "profile_form_instance_id": 1
              }
            },
            "domains": [
              {
                "id": 46,
                "alias": "usr_global",
                "name": "User Global",
                "description": "...",
                "is_editable": false,
                "is_removable": false,
                "is_active": true,
                "pso_type": {
                  "id": 56,
                  "name": "User",
                  "alias": "usr",
                  "description": "...",
                  "is_active": true,
                  "system_required": true,
                  "creation_form_instance_id": 1,
                  "profile_form_instance_id": 1
                }
              }
            ],
            "privacy_level": {
              "id": 123,
              "alias": "public",
              "name": "Not Sensitive",
              "level": 100
            },
            "pso_type": {
              "id": 56,
              "name": "User",
              "alias": "usr",
              "description": "...",
              "is_active": true,
              "system_required": true,
              "creation_form_instance_id": 1,
              "profile_form_instance_id": 1
            },
            "items": [
              {}
            ],
            "options": [
              {
                "id": 198,
                "name": "Choose me!",
                "position": 9,
                "value": "198",
                "is_active": true,
                "is_selectable": true
              }
            ],
            "settings": [],
            "validation": {
              "type": "regexp",
              "attributes": {},
              "value_example": "string",
              "error_message": {
                "en": "Some text",
                "fr": "Du texte",
                "de": "Setwas Text",
                "es": "Algún texto"
              }
            },
            "has_autocomplete_settings": true,
            "autocomplete_settings": {
              "allow_extra_values": true,
              "autofill": true,
              "provider": {
                "name": {
                  "en": "Some text",
                  "fr": "Du texte",
                  "de": "Setwas Text",
                  "es": "Algún texto"
                },
                "alias": "string",
                "base_url": "https://exmaple.com/",
                "single_value_supported": true,
                "parameters": [
                  {
                    "name": "Name",
                    "key": "alias",
                    "required": true
                  }
                ]
              },
              "parameters": [
                {
                  "name": "Name",
                  "key": "alias",
                  "required": true,
                  "value": "value",
                  "field": {
                    "id": 1,
                    "name": "Field Name",
                    "alias": "usr_first_name",
                    "value": "RU",
                    "root_field": {
                      "id": 1,
                      "name": "Field Name",
                      "alias": "usr_first_name",
                      "value": "RU",
                      "root_field": "null"
                    }
                  }
                }
              ]
            }
          }
        }
      ],
      "language": {
        "id": 1,
        "alias": "en",
        "name": "English"
      },
      "owner": {
        "id": 1,
        "external_id": 1,
        "first_name": "John",
        "last_name": "Snow",
        "username": "john_snow",
        "professional_email": "jsnow@example.com",
        "professional_mobile_phone": "00 33 1 40 00 00 00",
        "professional_phone": "00 33 1 40 00 00 00",
        "role": [
          "bastard",
          "king"
        ],
        "is_active": true,
        "status": "remote",
        "settings": [
          "[]"
        ],
        "user_photo": "http://example.com/images/1.jpg"
      },
      "conditions": [
        {
          "type": "group",
          "combine_with": "and",
          "conditions": [
            {
              "type": "condition",
              "field": "usr_email",
              "raw_value": "john.doe@example.com",
              "operator": "=="
            }
          ]
        }
      ],
      "permissions": {
        "can_edit": true,
        "can_delete": false,
        "can_deactivate": true
      },
      "population": [
        {
          "type": "group",
          "details": {
            "dynamic": false,
            "includes": [
              "group_a"
            ],
            "excludes": [
              "group_b",
              "group_c"
            ]
          }
        }
      ],
      "created_at": "2019-01-01 23:34:40",
      "updated_at": "2019-01-01 23:34:40"
    }
  ],
  "meta": {
    "pagination": {
      "total": 238,
      "count": 25,
      "per_page": 25,
      "current_page": 2,
      "total_pages": 10,
      "links": {
        "previous": "http://example.com/api/<endpoint>?page=1",
        "next": "http://example.com/api/<endpoint>?page=3"
      }
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number"
          },
          "alias": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "pso_type": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number"
              },
              "name": {
                "type": "string"
              },
              "alias": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "is_active": {
                "type": "boolean"
              },
              "system_required": {
                "type": "boolean"
              },
              "creation_form_instance_id": {
                "type": "number"
              },
              "profile_form_instance_id": {
                "type": "number"
              }
            },
            "required": [
              "id",
              "name",
              "alias",
              "description",
              "is_active",
              "system_required",
              "creation_form_instance_id",
              "profile_form_instance_id"
            ],
            "additionalProperties": false
          },
          "is_active": {
            "type": "boolean"
          },
          "is_locked": {
            "type": "boolean"
          },
          "status": {
            "type": "string",
            "enum": [
              "new",
              "processing",
              "done",
              "failed"
            ]
          },
          "type": {
            "type": "string",
            "enum": [
              "owned",
              "shared"
            ]
          },
          "report_file": {
            "type": "string"
          },
          "mapping": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "internal": {
                  "type": "number"
                },
                "external": {
                  "type": "string"
                },
                "root_field": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "number"
                    },
                    "name": {
                      "type": "string"
                    },
                    "position": {
                      "type": "number"
                    },
                    "alias": {
                      "type": "string"
                    },
                    "has_unique_data": {
                      "type": "boolean",
                      "description": "whether field requires values to be unique across system"
                    },
                    "has_value": {
                      "type": "boolean",
                      "description": "whether field has at least one value submitted"
                    },
                    "removable": {
                      "type": "boolean",
                      "description": "whether field can be removed from system"
                    },
                    "is_active": {
                      "type": "boolean"
                    },
                    "list": {
                      "type": "boolean",
                      "description": "whether field can handle collection of values"
                    },
                    "read_only": {
                      "type": "boolean",
                      "description": "whether field value can be changed"
                    },
                    "required": {
                      "type": "boolean",
                      "description": "deprecated setting"
                    },
                    "user_required": {
                      "type": "boolean",
                      "description": "whether field value required by user"
                    },
                    "system_required": {
                      "type": "boolean",
                      "description": "whether field value required by system"
                    },
                    "type": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "number"
                        },
                        "name": {
                          "type": "string"
                        },
                        "alias": {
                          "type": "string"
                        },
                        "settings": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "number"
                              },
                              "name": {
                                "type": "string"
                              },
                              "alias": {
                                "type": "string"
                              },
                              "is_required": {
                                "type": "boolean"
                              }
                            },
                            "required": [
                              "id",
                              "name",
                              "alias",
                              "is_required"
                            ]
                          }
                        },
                        "supports_collection": {
                          "type": "boolean"
                        },
                        "supports_read_only": {
                          "type": "boolean"
                        },
                        "supports_unique": {
                          "type": "boolean"
                        }
                      },
                      "required": [
                        "id",
                        "name",
                        "alias",
                        "settings",
                        "supports_collection",
                        "supports_read_only",
                        "supports_unique"
                      ],
                      "additionalProperties": false
                    },
                    "category": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "number"
                        },
                        "alias": {
                          "type": "string"
                        },
                        "position": {
                          "type": "number"
                        },
                        "system_required": {
                          "type": "boolean"
                        },
                        "name": {
                          "type": "string"
                        },
                        "description": {
                          "type": "string"
                        },
                        "is_active": {
                          "type": "boolean"
                        },
                        "pso_type": {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "number"
                            },
                            "name": {
                              "type": "string"
                            },
                            "alias": {
                              "type": "string"
                            },
                            "description": {
                              "type": "string"
                            },
                            "is_active": {
                              "type": "boolean"
                            },
                            "system_required": {
                              "type": "boolean"
                            },
                            "creation_form_instance_id": {
                              "type": "number"
                            },
                            "profile_form_instance_id": {
                              "type": "number"
                            }
                          },
                          "required": [
                            "id",
                            "name",
                            "alias",
                            "description",
                            "is_active",
                            "system_required",
                            "creation_form_instance_id",
                            "profile_form_instance_id"
                          ],
                          "additionalProperties": false,
                          "description": "Presented only if `include` was send"
                        }
                      },
                      "required": [
                        "id",
                        "alias",
                        "position",
                        "system_required",
                        "name",
                        "description",
                        "is_active"
                      ],
                      "additionalProperties": false
                    },
                    "domains": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "number"
                          },
                          "alias": {
                            "type": "string"
                          },
                          "name": {
                            "type": "string"
                          },
                          "description": {
                            "type": "string"
                          },
                          "is_editable": {
                            "type": "boolean"
                          },
                          "is_removable": {
                            "type": "boolean"
                          },
                          "is_active": {
                            "type": "boolean"
                          },
                          "pso_type": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "number"
                              },
                              "name": {
                                "type": "string"
                              },
                              "alias": {
                                "type": "string"
                              },
                              "description": {
                                "type": "string"
                              },
                              "is_active": {
                                "type": "boolean"
                              },
                              "system_required": {
                                "type": "boolean"
                              },
                              "creation_form_instance_id": {
                                "type": "number"
                              },
                              "profile_form_instance_id": {
                                "type": "number"
                              }
                            },
                            "required": [
                              "id",
                              "name",
                              "alias",
                              "description",
                              "is_active",
                              "system_required",
                              "creation_form_instance_id",
                              "profile_form_instance_id"
                            ],
                            "additionalProperties": false
                          }
                        },
                        "required": [
                          "id",
                          "alias",
                          "name",
                          "description",
                          "is_editable",
                          "is_removable",
                          "is_active"
                        ]
                      }
                    },
                    "privacy_level": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "number"
                        },
                        "alias": {
                          "type": "string"
                        },
                        "name": {
                          "type": "string"
                        },
                        "level": {
                          "type": "number"
                        }
                      },
                      "required": [
                        "id",
                        "alias",
                        "name",
                        "level"
                      ],
                      "additionalProperties": false
                    },
                    "pso_type": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "number"
                        },
                        "name": {
                          "type": "string"
                        },
                        "alias": {
                          "type": "string"
                        },
                        "description": {
                          "type": "string"
                        },
                        "is_active": {
                          "type": "boolean"
                        },
                        "system_required": {
                          "type": "boolean"
                        },
                        "creation_form_instance_id": {
                          "type": "number"
                        },
                        "profile_form_instance_id": {
                          "type": "number"
                        }
                      },
                      "required": [
                        "id",
                        "name",
                        "alias",
                        "description",
                        "is_active",
                        "system_required",
                        "creation_form_instance_id",
                        "profile_form_instance_id"
                      ],
                      "additionalProperties": false
                    },
                    "items": {
                      "type": [
                        "array",
                        "null"
                      ],
                      "items": {
                        "type": "object",
                        "properties": {}
                      }
                    },
                    "options": {
                      "type": [
                        "array",
                        "null"
                      ],
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "number"
                          },
                          "name": {
                            "type": "string"
                          },
                          "position": {
                            "type": "number"
                          },
                          "value": {
                            "type": "string"
                          },
                          "is_active": {
                            "type": "boolean"
                          },
                          "is_selectable": {
                            "type": "boolean",
                            "description": "Can select on front this option (Using only in Hierarchy field))"
                          }
                        },
                        "required": [
                          "id",
                          "name",
                          "position",
                          "value",
                          "is_active",
                          "is_selectable"
                        ]
                      },
                      "description": "List of options with possible (allowed) values."
                    },
                    "settings": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      },
                      "description": "Common field settings"
                    },
                    "validation": {
                      "type": "object",
                      "properties": {
                        "type": {
                          "type": "string"
                        },
                        "attributes": {
                          "type": "object",
                          "properties": {}
                        },
                        "value_example": {
                          "type": "string"
                        },
                        "error_message": {
                          "type": "object",
                          "properties": {
                            "en": {
                              "type": "string"
                            },
                            "fr": {
                              "type": "string"
                            },
                            "de": {
                              "type": "string"
                            },
                            "es": {
                              "type": "string"
                            }
                          },
                          "required": [
                            "en",
                            "fr",
                            "de",
                            "es"
                          ]
                        }
                      },
                      "required": [
                        "type",
                        "value_example",
                        "error_message"
                      ]
                    },
                    "has_autocomplete_settings": {
                      "type": "boolean"
                    },
                    "autocomplete_settings": {
                      "type": "object",
                      "properties": {
                        "allow_extra_values": {
                          "type": "boolean"
                        },
                        "autofill": {
                          "type": "boolean"
                        },
                        "provider": {
                          "type": "object",
                          "properties": {
                            "name": {
                              "type": "object",
                              "properties": {
                                "en": {
                                  "type": "string"
                                },
                                "fr": {
                                  "type": "string"
                                },
                                "de": {
                                  "type": "string"
                                },
                                "es": {
                                  "type": "string"
                                }
                              },
                              "required": [
                                "en",
                                "fr",
                                "de",
                                "es"
                              ]
                            },
                            "alias": {
                              "type": "string"
                            },
                            "base_url": {
                              "type": "string"
                            },
                            "single_value_supported": {
                              "type": "boolean"
                            },
                            "parameters": {
                              "type": "array"
                            }
                          },
                          "required": [
                            "name",
                            "alias",
                            "base_url",
                            "single_value_supported",
                            "parameters"
                          ]
                        },
                        "parameters": {
                          "type": "array"
                        }
                      },
                      "required": [
                        "allow_extra_values",
                        "autofill",
                        "provider",
                        "parameters"
                      ]
                    }
                  },
                  "required": [
                    "id",
                    "name",
                    "position",
                    "alias",
                    "has_unique_data",
                    "has_value",
                    "removable",
                    "is_active",
                    "list",
                    "read_only",
                    "required",
                    "user_required",
                    "system_required",
                    "items",
                    "options",
                    "validation",
                    "has_autocomplete_settings",
                    "autocomplete_settings"
                  ],
                  "additionalProperties": false
                }
              },
              "required": [
                "internal",
                "external"
              ]
            }
          },
          "language": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number"
              },
              "alias": {
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "alias",
              "name"
            ]
          },
          "owner": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number"
              },
              "external_id": {
                "type": "number"
              },
              "first_name": {
                "type": "string"
              },
              "last_name": {
                "type": "string"
              },
              "username": {
                "type": "string"
              },
              "professional_email": {
                "type": "string"
              },
              "professional_mobile_phone": {
                "type": "string"
              },
              "professional_phone": {
                "type": "string"
              },
              "role": {
                "type": "array"
              },
              "is_active": {
                "type": "boolean"
              },
              "status": {
                "type": "string"
              },
              "settings": {
                "type": "array"
              },
              "user_photo": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "external_id",
              "first_name",
              "last_name",
              "username",
              "professional_email",
              "professional_mobile_phone",
              "professional_phone",
              "role",
              "is_active",
              "status",
              "settings",
              "user_photo"
            ],
            "additionalProperties": false
          },
          "conditions": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "type": {
                  "type": "string",
                  "enum": [
                    "group"
                  ]
                },
                "combine_with": {
                  "type": "string",
                  "enum": [
                    "and",
                    "or"
                  ]
                },
                "conditions": {
                  "type": "array"
                }
              },
              "required": [
                "type",
                "combine_with",
                "conditions"
              ]
            }
          },
          "permissions": {
            "type": "object",
            "properties": {
              "can_edit": {
                "type": "boolean"
              },
              "can_delete": {
                "type": "boolean"
              },
              "can_deactivate": {
                "type": "boolean"
              }
            },
            "required": [
              "can_edit",
              "can_delete",
              "can_deactivate"
            ]
          },
          "population": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "type": {
                  "type": "string",
                  "enum": [
                    "all",
                    "group",
                    "pso",
                    "relation",
                    "self"
                  ]
                },
                "details": {
                  "anyOf": [
                    {
                      "type": "object",
                      "properties": {
                        "dynamic": {
                          "type": "boolean"
                        },
                        "includes": {
                          "type": "array"
                        },
                        "excludes": {
                          "type": "array"
                        }
                      },
                      "required": [
                        "dynamic",
                        "includes",
                        "excludes"
                      ]
                    },
                    {
                      "type": "array",
                      "enum": [
                        [],
                        []
                      ]
                    }
                  ],
                  "type": "null"
                }
              },
              "required": [
                "type",
                "details"
              ]
            }
          },
          "created_at": {
            "type": "string"
          },
          "updated_at": {
            "type": "string"
          }
        },
        "required": [
          "alias",
          "name",
          "description",
          "is_active",
          "status",
          "type",
          "mapping",
          "language",
          "population",
          "created_at",
          "updated_at"
        ]
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number"
            },
            "count": {
              "type": "number"
            },
            "per_page": {
              "type": "number"
            },
            "current_page": {
              "type": "number"
            },
            "total_pages": {
              "type": "number"
            },
            "links": {
              "type": "object",
              "properties": {
                "previous": {
                  "type": "string"
                },
                "next": {
                  "type": "string"
                }
              },
              "required": [
                "previous",
                "next"
              ]
            }
          },
          "required": [
            "total",
            "count",
            "per_page",
            "current_page",
            "total_pages",
            "links"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "pagination"
      ]
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/connector-builder/exports/{alias}{?include}

Fetch specified export map

Example URI

GET https://rest.monportailrh.com/connector-builder/exports/usr_report?include=pso_type,language
URI Parameters
HideShow
alias
string (required) Example: usr_report

Alias of the Export Mapping.

include
pso_type, mapping, mapping.root_field, language, owner, population (optional) Example: pso_type,language

The way to include relations in the response. Target relations can be comma separated if you want to get few of them.

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <comma separated features>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 132,
    "alias": "my_widget",
    "name": "Export mapping Name",
    "description": "Some description",
    "pso_type": {
      "id": 56,
      "name": "User",
      "alias": "usr",
      "description": "...",
      "is_active": true,
      "system_required": true,
      "creation_form_instance_id": 1,
      "profile_form_instance_id": 1
    },
    "is_active": true,
    "is_locked": false,
    "status": "new",
    "type": "owned",
    "report_file": "filename.csv",
    "mapping": [
      {
        "internal": 123,
        "external": "Active",
        "root_field": {
          "id": 1,
          "name": "Field Name",
          "position": 5,
          "alias": "usr_first_name",
          "has_unique_data": false,
          "has_value": true,
          "removable": false,
          "is_active": true,
          "list": false,
          "read_only": false,
          "required": true,
          "user_required": true,
          "system_required": true,
          "type": {
            "id": 1,
            "name": "Data Type Name",
            "alias": "data_type_alias",
            "settings": [
              {
                "id": 1,
                "name": "Data Type Setting Name",
                "alias": "data_type_setting_alias",
                "is_required": true
              }
            ],
            "supports_collection": false,
            "supports_read_only": false,
            "supports_unique": false
          },
          "category": {
            "id": 32,
            "alias": "usr_identity",
            "position": 5,
            "system_required": true,
            "name": "Identity",
            "description": "...",
            "is_active": true,
            "pso_type": {
              "id": 56,
              "name": "User",
              "alias": "usr",
              "description": "...",
              "is_active": true,
              "system_required": true,
              "creation_form_instance_id": 1,
              "profile_form_instance_id": 1
            }
          },
          "domains": [
            {
              "id": 46,
              "alias": "usr_global",
              "name": "User Global",
              "description": "...",
              "is_editable": false,
              "is_removable": false,
              "is_active": true,
              "pso_type": {
                "id": 56,
                "name": "User",
                "alias": "usr",
                "description": "...",
                "is_active": true,
                "system_required": true,
                "creation_form_instance_id": 1,
                "profile_form_instance_id": 1
              }
            }
          ],
          "privacy_level": {
            "id": 123,
            "alias": "public",
            "name": "Not Sensitive",
            "level": 100
          },
          "pso_type": {
            "id": 56,
            "name": "User",
            "alias": "usr",
            "description": "...",
            "is_active": true,
            "system_required": true,
            "creation_form_instance_id": 1,
            "profile_form_instance_id": 1
          },
          "items": [
            {}
          ],
          "options": [
            {
              "id": 198,
              "name": "Choose me!",
              "position": 9,
              "value": "198",
              "is_active": true,
              "is_selectable": true
            }
          ],
          "settings": [],
          "validation": {
            "type": "regexp",
            "attributes": {},
            "value_example": "string",
            "error_message": {
              "en": "Some text",
              "fr": "Du texte",
              "de": "Setwas Text",
              "es": "Algún texto"
            }
          },
          "has_autocomplete_settings": true,
          "autocomplete_settings": {
            "allow_extra_values": true,
            "autofill": true,
            "provider": {
              "name": {
                "en": "Some text",
                "fr": "Du texte",
                "de": "Setwas Text",
                "es": "Algún texto"
              },
              "alias": "string",
              "base_url": "https://exmaple.com/",
              "single_value_supported": true,
              "parameters": [
                {
                  "name": "Name",
                  "key": "alias",
                  "required": true
                }
              ]
            },
            "parameters": [
              {
                "name": "Name",
                "key": "alias",
                "required": true,
                "value": "value",
                "field": {
                  "id": 1,
                  "name": "Field Name",
                  "alias": "usr_first_name",
                  "value": "RU",
                  "root_field": {
                    "id": 1,
                    "name": "Field Name",
                    "alias": "usr_first_name",
                    "value": "RU",
                    "root_field": "null"
                  }
                }
              }
            ]
          }
        }
      }
    ],
    "language": {
      "id": 1,
      "alias": "en",
      "name": "English"
    },
    "owner": {
      "id": 1,
      "external_id": 1,
      "first_name": "John",
      "last_name": "Snow",
      "username": "john_snow",
      "professional_email": "jsnow@example.com",
      "professional_mobile_phone": "00 33 1 40 00 00 00",
      "professional_phone": "00 33 1 40 00 00 00",
      "role": [
        "bastard",
        "king"
      ],
      "is_active": true,
      "status": "remote",
      "settings": [
        "[]"
      ],
      "user_photo": "http://example.com/images/1.jpg"
    },
    "conditions": [
      {
        "type": "group",
        "combine_with": "and",
        "conditions": [
          {
            "type": "condition",
            "field": "usr_email",
            "raw_value": "john.doe@example.com",
            "operator": "=="
          }
        ]
      }
    ],
    "permissions": {
      "can_edit": true,
      "can_delete": false,
      "can_deactivate": true
    },
    "population": [
      {
        "type": "group",
        "details": {
          "dynamic": false,
          "includes": [
            "group_a"
          ],
          "excludes": [
            "group_b",
            "group_c"
          ]
        }
      }
    ],
    "created_at": "2019-01-01 23:34:40",
    "updated_at": "2019-01-01 23:34:40"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "alias": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "pso_type": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "name": {
              "type": "string"
            },
            "alias": {
              "type": "string"
            },
            "description": {
              "type": "string"
            },
            "is_active": {
              "type": "boolean"
            },
            "system_required": {
              "type": "boolean"
            },
            "creation_form_instance_id": {
              "type": "number"
            },
            "profile_form_instance_id": {
              "type": "number"
            }
          },
          "required": [
            "id",
            "name",
            "alias",
            "description",
            "is_active",
            "system_required",
            "creation_form_instance_id",
            "profile_form_instance_id"
          ],
          "additionalProperties": false
        },
        "is_active": {
          "type": "boolean"
        },
        "is_locked": {
          "type": "boolean"
        },
        "status": {
          "type": "string",
          "enum": [
            "new",
            "processing",
            "done",
            "failed"
          ]
        },
        "type": {
          "type": "string",
          "enum": [
            "owned",
            "shared"
          ]
        },
        "report_file": {
          "type": "string"
        },
        "mapping": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "internal": {
                "type": "number"
              },
              "external": {
                "type": "string"
              },
              "root_field": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "number"
                  },
                  "name": {
                    "type": "string"
                  },
                  "position": {
                    "type": "number"
                  },
                  "alias": {
                    "type": "string"
                  },
                  "has_unique_data": {
                    "type": "boolean",
                    "description": "whether field requires values to be unique across system"
                  },
                  "has_value": {
                    "type": "boolean",
                    "description": "whether field has at least one value submitted"
                  },
                  "removable": {
                    "type": "boolean",
                    "description": "whether field can be removed from system"
                  },
                  "is_active": {
                    "type": "boolean"
                  },
                  "list": {
                    "type": "boolean",
                    "description": "whether field can handle collection of values"
                  },
                  "read_only": {
                    "type": "boolean",
                    "description": "whether field value can be changed"
                  },
                  "required": {
                    "type": "boolean",
                    "description": "deprecated setting"
                  },
                  "user_required": {
                    "type": "boolean",
                    "description": "whether field value required by user"
                  },
                  "system_required": {
                    "type": "boolean",
                    "description": "whether field value required by system"
                  },
                  "type": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "number"
                      },
                      "name": {
                        "type": "string"
                      },
                      "alias": {
                        "type": "string"
                      },
                      "settings": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "number"
                            },
                            "name": {
                              "type": "string"
                            },
                            "alias": {
                              "type": "string"
                            },
                            "is_required": {
                              "type": "boolean"
                            }
                          },
                          "required": [
                            "id",
                            "name",
                            "alias",
                            "is_required"
                          ]
                        }
                      },
                      "supports_collection": {
                        "type": "boolean"
                      },
                      "supports_read_only": {
                        "type": "boolean"
                      },
                      "supports_unique": {
                        "type": "boolean"
                      }
                    },
                    "required": [
                      "id",
                      "name",
                      "alias",
                      "settings",
                      "supports_collection",
                      "supports_read_only",
                      "supports_unique"
                    ],
                    "additionalProperties": false
                  },
                  "category": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "number"
                      },
                      "alias": {
                        "type": "string"
                      },
                      "position": {
                        "type": "number"
                      },
                      "system_required": {
                        "type": "boolean"
                      },
                      "name": {
                        "type": "string"
                      },
                      "description": {
                        "type": "string"
                      },
                      "is_active": {
                        "type": "boolean"
                      },
                      "pso_type": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "number"
                          },
                          "name": {
                            "type": "string"
                          },
                          "alias": {
                            "type": "string"
                          },
                          "description": {
                            "type": "string"
                          },
                          "is_active": {
                            "type": "boolean"
                          },
                          "system_required": {
                            "type": "boolean"
                          },
                          "creation_form_instance_id": {
                            "type": "number"
                          },
                          "profile_form_instance_id": {
                            "type": "number"
                          }
                        },
                        "required": [
                          "id",
                          "name",
                          "alias",
                          "description",
                          "is_active",
                          "system_required",
                          "creation_form_instance_id",
                          "profile_form_instance_id"
                        ],
                        "additionalProperties": false,
                        "description": "Presented only if `include` was send"
                      }
                    },
                    "required": [
                      "id",
                      "alias",
                      "position",
                      "system_required",
                      "name",
                      "description",
                      "is_active"
                    ],
                    "additionalProperties": false
                  },
                  "domains": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "number"
                        },
                        "alias": {
                          "type": "string"
                        },
                        "name": {
                          "type": "string"
                        },
                        "description": {
                          "type": "string"
                        },
                        "is_editable": {
                          "type": "boolean"
                        },
                        "is_removable": {
                          "type": "boolean"
                        },
                        "is_active": {
                          "type": "boolean"
                        },
                        "pso_type": {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "number"
                            },
                            "name": {
                              "type": "string"
                            },
                            "alias": {
                              "type": "string"
                            },
                            "description": {
                              "type": "string"
                            },
                            "is_active": {
                              "type": "boolean"
                            },
                            "system_required": {
                              "type": "boolean"
                            },
                            "creation_form_instance_id": {
                              "type": "number"
                            },
                            "profile_form_instance_id": {
                              "type": "number"
                            }
                          },
                          "required": [
                            "id",
                            "name",
                            "alias",
                            "description",
                            "is_active",
                            "system_required",
                            "creation_form_instance_id",
                            "profile_form_instance_id"
                          ],
                          "additionalProperties": false
                        }
                      },
                      "required": [
                        "id",
                        "alias",
                        "name",
                        "description",
                        "is_editable",
                        "is_removable",
                        "is_active"
                      ]
                    }
                  },
                  "privacy_level": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "number"
                      },
                      "alias": {
                        "type": "string"
                      },
                      "name": {
                        "type": "string"
                      },
                      "level": {
                        "type": "number"
                      }
                    },
                    "required": [
                      "id",
                      "alias",
                      "name",
                      "level"
                    ],
                    "additionalProperties": false
                  },
                  "pso_type": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "number"
                      },
                      "name": {
                        "type": "string"
                      },
                      "alias": {
                        "type": "string"
                      },
                      "description": {
                        "type": "string"
                      },
                      "is_active": {
                        "type": "boolean"
                      },
                      "system_required": {
                        "type": "boolean"
                      },
                      "creation_form_instance_id": {
                        "type": "number"
                      },
                      "profile_form_instance_id": {
                        "type": "number"
                      }
                    },
                    "required": [
                      "id",
                      "name",
                      "alias",
                      "description",
                      "is_active",
                      "system_required",
                      "creation_form_instance_id",
                      "profile_form_instance_id"
                    ],
                    "additionalProperties": false
                  },
                  "items": {
                    "type": [
                      "array",
                      "null"
                    ],
                    "items": {
                      "type": "object",
                      "properties": {}
                    }
                  },
                  "options": {
                    "type": [
                      "array",
                      "null"
                    ],
                    "items": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "number"
                        },
                        "name": {
                          "type": "string"
                        },
                        "position": {
                          "type": "number"
                        },
                        "value": {
                          "type": "string"
                        },
                        "is_active": {
                          "type": "boolean"
                        },
                        "is_selectable": {
                          "type": "boolean",
                          "description": "Can select on front this option (Using only in Hierarchy field))"
                        }
                      },
                      "required": [
                        "id",
                        "name",
                        "position",
                        "value",
                        "is_active",
                        "is_selectable"
                      ]
                    },
                    "description": "List of options with possible (allowed) values."
                  },
                  "settings": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    },
                    "description": "Common field settings"
                  },
                  "validation": {
                    "type": "object",
                    "properties": {
                      "type": {
                        "type": "string"
                      },
                      "attributes": {
                        "type": "object",
                        "properties": {}
                      },
                      "value_example": {
                        "type": "string"
                      },
                      "error_message": {
                        "type": "object",
                        "properties": {
                          "en": {
                            "type": "string"
                          },
                          "fr": {
                            "type": "string"
                          },
                          "de": {
                            "type": "string"
                          },
                          "es": {
                            "type": "string"
                          }
                        },
                        "required": [
                          "en",
                          "fr",
                          "de",
                          "es"
                        ]
                      }
                    },
                    "required": [
                      "type",
                      "value_example",
                      "error_message"
                    ]
                  },
                  "has_autocomplete_settings": {
                    "type": "boolean"
                  },
                  "autocomplete_settings": {
                    "type": "object",
                    "properties": {
                      "allow_extra_values": {
                        "type": "boolean"
                      },
                      "autofill": {
                        "type": "boolean"
                      },
                      "provider": {
                        "type": "object",
                        "properties": {
                          "name": {
                            "type": "object",
                            "properties": {
                              "en": {
                                "type": "string"
                              },
                              "fr": {
                                "type": "string"
                              },
                              "de": {
                                "type": "string"
                              },
                              "es": {
                                "type": "string"
                              }
                            },
                            "required": [
                              "en",
                              "fr",
                              "de",
                              "es"
                            ]
                          },
                          "alias": {
                            "type": "string"
                          },
                          "base_url": {
                            "type": "string"
                          },
                          "single_value_supported": {
                            "type": "boolean"
                          },
                          "parameters": {
                            "type": "array"
                          }
                        },
                        "required": [
                          "name",
                          "alias",
                          "base_url",
                          "single_value_supported",
                          "parameters"
                        ]
                      },
                      "parameters": {
                        "type": "array"
                      }
                    },
                    "required": [
                      "allow_extra_values",
                      "autofill",
                      "provider",
                      "parameters"
                    ]
                  }
                },
                "required": [
                  "id",
                  "name",
                  "position",
                  "alias",
                  "has_unique_data",
                  "has_value",
                  "removable",
                  "is_active",
                  "list",
                  "read_only",
                  "required",
                  "user_required",
                  "system_required",
                  "items",
                  "options",
                  "validation",
                  "has_autocomplete_settings",
                  "autocomplete_settings"
                ],
                "additionalProperties": false
              }
            },
            "required": [
              "internal",
              "external"
            ]
          }
        },
        "language": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "alias": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          },
          "required": [
            "id",
            "alias",
            "name"
          ]
        },
        "owner": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "external_id": {
              "type": "number"
            },
            "first_name": {
              "type": "string"
            },
            "last_name": {
              "type": "string"
            },
            "username": {
              "type": "string"
            },
            "professional_email": {
              "type": "string"
            },
            "professional_mobile_phone": {
              "type": "string"
            },
            "professional_phone": {
              "type": "string"
            },
            "role": {
              "type": "array"
            },
            "is_active": {
              "type": "boolean"
            },
            "status": {
              "type": "string"
            },
            "settings": {
              "type": "array"
            },
            "user_photo": {
              "type": "string"
            }
          },
          "required": [
            "id",
            "external_id",
            "first_name",
            "last_name",
            "username",
            "professional_email",
            "professional_mobile_phone",
            "professional_phone",
            "role",
            "is_active",
            "status",
            "settings",
            "user_photo"
          ],
          "additionalProperties": false
        },
        "conditions": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "type": {
                "type": "string",
                "enum": [
                  "group"
                ]
              },
              "combine_with": {
                "type": "string",
                "enum": [
                  "and",
                  "or"
                ]
              },
              "conditions": {
                "type": "array"
              }
            },
            "required": [
              "type",
              "combine_with",
              "conditions"
            ]
          }
        },
        "permissions": {
          "type": "object",
          "properties": {
            "can_edit": {
              "type": "boolean"
            },
            "can_delete": {
              "type": "boolean"
            },
            "can_deactivate": {
              "type": "boolean"
            }
          },
          "required": [
            "can_edit",
            "can_delete",
            "can_deactivate"
          ]
        },
        "population": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "type": {
                "type": "string",
                "enum": [
                  "all",
                  "group",
                  "pso",
                  "relation",
                  "self"
                ]
              },
              "details": {
                "anyOf": [
                  {
                    "type": "object",
                    "properties": {
                      "dynamic": {
                        "type": "boolean"
                      },
                      "includes": {
                        "type": "array"
                      },
                      "excludes": {
                        "type": "array"
                      }
                    },
                    "required": [
                      "dynamic",
                      "includes",
                      "excludes"
                    ]
                  },
                  {
                    "type": "array",
                    "enum": [
                      [],
                      []
                    ]
                  }
                ],
                "type": "null"
              }
            },
            "required": [
              "type",
              "details"
            ]
          }
        },
        "created_at": {
          "type": "string"
        },
        "updated_at": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "alias",
        "name",
        "description",
        "is_active",
        "is_locked",
        "status",
        "type",
        "report_file",
        "mapping",
        "language",
        "conditions",
        "permissions",
        "population",
        "created_at",
        "updated_at"
      ],
      "additionalProperties": false
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Trigger data export
POST/connector-builder/exports/{alias}/run

Start data export process using specified mapping

Example URI

POST https://rest.monportailrh.com/connector-builder/exports/usr_report/run
URI Parameters
HideShow
alias
string (required) Example: usr_report

Id of the Export Mapping.

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <comma separated features>
Body
{
  "output_format": "csv"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "output_format": {
      "type": "string",
      "enum": [
        "csv",
        "xls"
      ]
    }
  }
}
Response  202
HideShow
Headers
Content-Type: application/json
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 400
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Download Exported data
GET/connector-builder/exports/{alias}/download/{filename}

Download latest export result for specified mapping

Example URI

GET https://rest.monportailrh.com/connector-builder/exports/usr_report/download/user_report
URI Parameters
HideShow
alias
string (required) Example: usr_report

Alias of the Export Mapping.

filename
string (required) Example: user_report

27_12_2019_15_20_35.csv Report filename for download

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <comma separated features>
Response  200
HideShow
Headers
Content-Type: text/csv
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Get Export Logs
GET/connector-builder/exports/{alias}/logs

Fetch export process logs for specified mapping

Example URI

GET https://rest.monportailrh.com/connector-builder/exports/usr_report/logs
URI Parameters
HideShow
alias
string (required) Example: usr_report

Id of the Export Mapping.

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <comma separated features>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": 123,
      "started_at": "2019-01-01 23:34:40",
      "finished_at": "2019-01-01 23:34:40",
      "result": "ok",
      "log_file": "logs/numeric_scale",
      "report_file": "numeric_scale",
      "user": {
        "id": 1,
        "external_id": 1,
        "first_name": "John",
        "last_name": "Snow",
        "username": "john_snow",
        "professional_email": "jsnow@example.com",
        "professional_mobile_phone": "00 33 1 40 00 00 00",
        "professional_phone": "00 33 1 40 00 00 00",
        "role": [
          "bastard",
          "king"
        ],
        "is_active": true,
        "status": "remote",
        "settings": [
          "[]"
        ],
        "user_photo": "http://example.com/images/1.jpg"
      }
    }
  ],
  "meta": {
    "pagination": {
      "total": 238,
      "count": 25,
      "per_page": 25,
      "current_page": 2,
      "total_pages": 10,
      "links": {
        "previous": "http://example.com/api/<endpoint>?page=1",
        "next": "http://example.com/api/<endpoint>?page=3"
      }
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number"
          },
          "started_at": {
            "type": "string"
          },
          "finished_at": {
            "type": "string"
          },
          "result": {
            "type": "string",
            "enum": [
              "ok",
              "failed"
            ]
          },
          "log_file": {
            "type": "string",
            "description": "181220190931.log (string, required)"
          },
          "report_file": {
            "type": "string",
            "description": "181220190931.csv (string, optional)"
          },
          "user": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number"
              },
              "external_id": {
                "type": "number"
              },
              "first_name": {
                "type": "string"
              },
              "last_name": {
                "type": "string"
              },
              "username": {
                "type": "string"
              },
              "professional_email": {
                "type": "string"
              },
              "professional_mobile_phone": {
                "type": "string"
              },
              "professional_phone": {
                "type": "string"
              },
              "role": {
                "type": "array"
              },
              "is_active": {
                "type": "boolean"
              },
              "status": {
                "type": "string"
              },
              "settings": {
                "type": "array"
              },
              "user_photo": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "external_id",
              "first_name",
              "last_name",
              "username",
              "professional_email",
              "professional_mobile_phone",
              "professional_phone",
              "role",
              "is_active",
              "status",
              "settings",
              "user_photo"
            ]
          }
        },
        "required": [
          "id",
          "started_at",
          "finished_at",
          "result",
          "user"
        ]
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number"
            },
            "count": {
              "type": "number"
            },
            "per_page": {
              "type": "number"
            },
            "current_page": {
              "type": "number"
            },
            "total_pages": {
              "type": "number"
            },
            "links": {
              "type": "object",
              "properties": {
                "previous": {
                  "type": "string"
                },
                "next": {
                  "type": "string"
                }
              },
              "required": [
                "previous",
                "next"
              ]
            }
          },
          "required": [
            "total",
            "count",
            "per_page",
            "current_page",
            "total_pages",
            "links"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "pagination"
      ]
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Create
POST/connector-builder/exports

Create new export map

On creation alias for mapping will be generated automatically

By default all PSO objects from system will be exported using given mapping. There are few limitations:

  • The whole composite field cannot be selected in mapping. You must specify each item explicitly

  • population property is used to “share” created mapping with specified users. Only all, group and pso is supported. Only items of User Pso Type allowed

Example URI

POST https://rest.monportailrh.com/connector-builder/exports
Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target features>
Body
{
  "name": {
    "en": "Some text",
    "fr": "Du texte",
    "de": "Setwas Text",
    "es": "Algún texto"
  },
  "description": {
    "en": "Some text",
    "fr": "Du texte",
    "de": "Setwas Text",
    "es": "Algún texto"
  },
  "pso_type": "usr",
  "is_active": true,
  "language": "en",
  "mapping": [
    {
      "internal": 123,
      "external": "Active"
    }
  ],
  "conditions": [
    {
      "type": "group",
      "combine_with": "and",
      "conditions": [
        {
          "type": "condition",
          "field": "usr_email",
          "raw_value": "john.doe@example.com",
          "field_value: usr_additional_email": "Hello, world!",
          "operator": "Hello, world!"
        }
      ]
    }
  ],
  "population": [
    {
      "type": "all",
      "details": {
        "dynamic": true,
        "includes": [
          "group_a"
        ],
        "excludes": [
          "group_b",
          "group_c"
        ]
      }
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "object",
      "properties": {
        "en": {
          "type": "string"
        },
        "fr": {
          "type": "string"
        },
        "de": {
          "type": "string"
        },
        "es": {
          "type": "string"
        }
      },
      "required": [
        "en",
        "fr",
        "de",
        "es"
      ],
      "additionalProperties": false
    },
    "description": {
      "type": "object",
      "properties": {
        "en": {
          "type": "string"
        },
        "fr": {
          "type": "string"
        },
        "de": {
          "type": "string"
        },
        "es": {
          "type": "string"
        }
      },
      "required": [
        "en",
        "fr",
        "de",
        "es"
      ],
      "additionalProperties": false
    },
    "pso_type": {
      "type": "string"
    },
    "is_active": {
      "type": "boolean"
    },
    "language": {
      "type": "string"
    },
    "mapping": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "internal": {
            "type": "number"
          },
          "external": {
            "type": "string"
          }
        },
        "required": [
          "internal",
          "external"
        ]
      }
    },
    "conditions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "group"
            ]
          },
          "combine_with": {
            "type": "string",
            "enum": [
              "and",
              "or"
            ]
          },
          "conditions": {
            "type": "array"
          }
        },
        "required": [
          "type",
          "combine_with",
          "conditions"
        ]
      }
    },
    "population": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "all",
              "group",
              "pso",
              "relation",
              "self"
            ]
          },
          "details": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "dynamic": {
                    "type": "boolean"
                  },
                  "includes": {
                    "type": "array"
                  },
                  "excludes": {
                    "type": "array"
                  }
                },
                "required": [
                  "dynamic",
                  "includes",
                  "excludes"
                ]
              },
              {
                "type": "array",
                "enum": [
                  [],
                  []
                ]
              }
            ],
            "type": "null"
          }
        },
        "required": [
          "type",
          "details"
        ]
      }
    }
  },
  "required": [
    "name",
    "description",
    "pso_type",
    "is_active",
    "language",
    "mapping",
    "population"
  ]
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 123,
    "alias": "can_be_null"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "alias": {
          "type": "string"
        }
      },
      "required": [
        "id"
      ],
      "additionalProperties": false
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 400
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/connector-builder/exports/{alias}

Update export map

On creation alias for mapping will be generated automatically

By default all PSO objects from system will be exported using given mapping. There are few limitations:

  • The whole composite field cannot be selected in mapping. You must specify each item explicitly

  • population property is used to “share” created mapping with specified users. Only all, group and pso is supported. Only items of User Pso Type allowed

Note this endpoint supports partial updates. You may specify ONLY property that need to be changed

Note this endpoint does not support complicated updates. To update nested relations - you need to put all required data

Example URI

PATCH https://rest.monportailrh.com/connector-builder/exports/usr_report
URI Parameters
HideShow
alias
string (required) Example: usr_report

Alias of the Export Mapping.

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target features>
Body
{
  "name": {
    "en": "Some text",
    "fr": "Du texte",
    "de": "Setwas Text",
    "es": "Algún texto"
  },
  "description": {
    "en": "Some text",
    "fr": "Du texte",
    "de": "Setwas Text",
    "es": "Algún texto"
  },
  "is_active": true,
  "language": "en",
  "mapping": [
    {
      "internal": 123,
      "external": "Active"
    }
  ],
  "conditions": [
    {
      "type": "group",
      "combine_with": "and",
      "conditions": [
        {
          "type": "condition",
          "field": "usr_email",
          "raw_value": "john.doe@example.com",
          "field_value: usr_additional_email": "Hello, world!",
          "operator": "Hello, world!"
        }
      ]
    }
  ],
  "population": [
    {
      "type": "all",
      "details": {
        "dynamic": true,
        "includes": [
          "group_a"
        ],
        "excludes": [
          "group_b",
          "group_c"
        ]
      }
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "object",
      "properties": {
        "en": {
          "type": "string"
        },
        "fr": {
          "type": "string"
        },
        "de": {
          "type": "string"
        },
        "es": {
          "type": "string"
        }
      },
      "required": [
        "en",
        "fr",
        "de",
        "es"
      ],
      "additionalProperties": false
    },
    "description": {
      "type": "object",
      "properties": {
        "en": {
          "type": "string"
        },
        "fr": {
          "type": "string"
        },
        "de": {
          "type": "string"
        },
        "es": {
          "type": "string"
        }
      },
      "required": [
        "en",
        "fr",
        "de",
        "es"
      ],
      "additionalProperties": false
    },
    "is_active": {
      "type": "boolean"
    },
    "language": {
      "type": "string"
    },
    "mapping": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "internal": {
            "type": "number"
          },
          "external": {
            "type": "string"
          }
        },
        "required": [
          "internal",
          "external"
        ]
      }
    },
    "conditions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "group"
            ]
          },
          "combine_with": {
            "type": "string",
            "enum": [
              "and",
              "or"
            ]
          },
          "conditions": {
            "type": "array"
          }
        },
        "required": [
          "type",
          "combine_with",
          "conditions"
        ]
      }
    },
    "population": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "all",
              "group",
              "pso",
              "relation",
              "self"
            ]
          },
          "details": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "dynamic": {
                    "type": "boolean"
                  },
                  "includes": {
                    "type": "array"
                  },
                  "excludes": {
                    "type": "array"
                  }
                },
                "required": [
                  "dynamic",
                  "includes",
                  "excludes"
                ]
              },
              {
                "type": "array",
                "enum": [
                  [],
                  []
                ]
              }
            ],
            "type": "null"
          }
        },
        "required": [
          "type",
          "details"
        ]
      }
    }
  },
  "required": [
    "is_active"
  ]
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 123,
    "alias": "can_be_null"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "alias": {
          "type": "string"
        }
      },
      "required": [
        "id"
      ],
      "additionalProperties": false
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 400
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete
DELETE/connector-builder/exports/{alias}

Delete export map

On creation alias for mapping will be generated automatically

  • It should NOT ALLOW to delete it if the status is processing (ask for message once it needed)

  • It should drop ONLY map from DB. All generated files and logs must be kept

  • It requires user to have connector_builder_export.delete.* or connector_builder_export.delete. feature

Example URI

DELETE https://rest.monportailrh.com/connector-builder/exports/usr_report
URI Parameters
HideShow
alias
string (required) Example: usr_report

Alias of the Export Mapping.

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target features>
Response  204
HideShow
Headers
Content-Type: application/json
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 400
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Imports

List
GET/connector-builder/imports{?name,pso-type,active,include,sort-by,sort-direction}&status[]={status}&strategies[list_of]={strategies_list_of}&strategies[empty]={strategies_empty}

Fetch list of data imports

Example URI

GET https://rest.monportailrh.com/connector-builder/imports?name=Data Import to search for&pso-type=usr&active=true&include=language,form&sort-by=name&sort-direction=asc&status[]=pending&strategies[list_of]=add&strategies[empty]=erase
URI Parameters
HideShow
name
string (optional) Example: Data Import to search for

Search by name. Non strict, case-insensitive.

pso-type
string (optional) Example: usr

Pso Type trigram to filter imports

active
boolean (optional) Example: true

Field for filter data imports by is_active column

status
array (optional) Example: pending

Array if statuses to filter imports

strategies_list_of
add,replace (optional) Example: add

Available strategies to filter imports by strategies

strategies_empty
erase,ignore (optional) Example: erase

Available strategies to filter imports by strategies

sort-by
name, active (optional) Example: name

Field to sort data imports by.

sort-direction
asc, desc (optional) Default: asc Example: asc

Direction to order data imports by.

include
form, files, language, owner (optional) Example: language,form

The way to include relations in the response. Target relations can be comma separated if you want to get few of them

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": 1,
      "name": "Data Import Name",
      "description": "Data Import Description",
      "is_active": true,
      "status": "pending",
      "strategies": {
        "list_of": "add",
        "empty_values": "erase"
      },
      "form": {
        "id": 1,
        "name": "Form Name",
        "description": "Form Description",
        "is_active": true,
        "removable": true,
        "has_assigned": true,
        "fields": [
          {
            "id": 1,
            "name": "Field Name",
            "position": 5,
            "alias": "usr_first_name",
            "has_unique_data": false,
            "has_value": true,
            "removable": false,
            "is_active": true,
            "list": false,
            "read_only": false,
            "required": true,
            "user_required": true,
            "system_required": true,
            "type": {
              "id": 1,
              "name": "Data Type Name",
              "alias": "data_type_alias",
              "settings": [
                {
                  "id": 1,
                  "name": "Data Type Setting Name",
                  "alias": "data_type_setting_alias",
                  "is_required": true
                }
              ],
              "supports_collection": false,
              "supports_read_only": false,
              "supports_unique": false
            },
            "category": {
              "id": 32,
              "alias": "usr_identity",
              "position": 5,
              "system_required": true,
              "name": "Identity",
              "description": "...",
              "is_active": true,
              "pso_type": {
                "id": 56,
                "name": "User",
                "alias": "usr",
                "description": "...",
                "is_active": true,
                "system_required": true,
                "creation_form_instance_id": 1,
                "profile_form_instance_id": 1
              }
            },
            "domains": [
              {
                "id": 46,
                "alias": "usr_global",
                "name": "User Global",
                "description": "...",
                "is_editable": false,
                "is_removable": false,
                "is_active": true,
                "pso_type": {
                  "id": 56,
                  "name": "User",
                  "alias": "usr",
                  "description": "...",
                  "is_active": true,
                  "system_required": true,
                  "creation_form_instance_id": 1,
                  "profile_form_instance_id": 1
                }
              }
            ],
            "privacy_level": {
              "id": 123,
              "alias": "public",
              "name": "Not Sensitive",
              "level": 100
            },
            "pso_type": {
              "id": 56,
              "name": "User",
              "alias": "usr",
              "description": "...",
              "is_active": true,
              "system_required": true,
              "creation_form_instance_id": 1,
              "profile_form_instance_id": 1
            },
            "items": [
              {}
            ],
            "options": [
              {
                "id": 198,
                "name": "Choose me!",
                "position": 9,
                "value": "198",
                "is_active": true,
                "is_selectable": true
              }
            ],
            "settings": [],
            "validation": {
              "type": "regexp",
              "attributes": {},
              "value_example": "string",
              "error_message": {
                "en": "Some text",
                "fr": "Du texte",
                "de": "Setwas Text",
                "es": "Algún texto"
              }
            },
            "has_autocomplete_settings": true,
            "autocomplete_settings": {
              "allow_extra_values": true,
              "autofill": true,
              "provider": {
                "name": {
                  "en": "Some text",
                  "fr": "Du texte",
                  "de": "Setwas Text",
                  "es": "Algún texto"
                },
                "alias": "string",
                "base_url": "https://exmaple.com/",
                "single_value_supported": true,
                "parameters": [
                  {
                    "name": "Name",
                    "key": "alias",
                    "required": true
                  }
                ]
              },
              "parameters": [
                {
                  "name": "Name",
                  "key": "alias",
                  "required": true,
                  "value": "value",
                  "field": {
                    "id": 1,
                    "name": "Field Name",
                    "alias": "usr_first_name",
                    "value": "RU",
                    "root_field": {
                      "id": 1,
                      "name": "Field Name",
                      "alias": "usr_first_name",
                      "value": "RU",
                      "root_field": "null"
                    }
                  }
                }
              ]
            }
          }
        ],
        "pso_type": {
          "id": 56,
          "name": "User",
          "alias": "usr",
          "description": "...",
          "is_active": true,
          "system_required": true,
          "creation_form_instance_id": 1,
          "profile_form_instance_id": 1
        }
      },
      "language": {
        "id": 1,
        "alias": "en",
        "name": "English"
      },
      "files": [],
      "owner": {
        "id": 1,
        "external_id": 1,
        "first_name": "John",
        "last_name": "Snow",
        "username": "john_snow",
        "professional_email": "jsnow@example.com",
        "professional_mobile_phone": "00 33 1 40 00 00 00",
        "professional_phone": "00 33 1 40 00 00 00",
        "role": [
          "bastard",
          "king"
        ],
        "is_active": true,
        "status": "remote",
        "settings": [
          "[]"
        ],
        "user_photo": "http://example.com/images/1.jpg"
      }
    }
  ],
  "meta": {
    "pagination": {
      "total": 238,
      "count": 25,
      "per_page": 25,
      "current_page": 2,
      "total_pages": 10,
      "links": {
        "previous": "http://example.com/api/<endpoint>?page=1",
        "next": "http://example.com/api/<endpoint>?page=3"
      }
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number"
          },
          "name": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "is_active": {
            "type": "boolean"
          },
          "status": {
            "type": "string",
            "enum": [
              "pending",
              "validation_in_progress",
              "validation_success",
              "validation_failed",
              "validation_warning",
              "import_in_progress",
              "import_success",
              "import_failed",
              "import_warning"
            ]
          },
          "strategies": {
            "type": "object",
            "properties": {
              "list_of": {
                "type": "string",
                "enum": [
                  "add",
                  "replace"
                ]
              },
              "empty_values": {
                "type": "string",
                "enum": [
                  "erase",
                  "ignore"
                ]
              }
            },
            "required": [
              "list_of",
              "empty_values"
            ],
            "additionalProperties": false
          },
          "form": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number"
              },
              "name": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "is_active": {
                "type": "boolean"
              },
              "removable": {
                "type": "boolean"
              },
              "has_assigned": {
                "type": "boolean"
              },
              "fields": {
                "type": "array"
              },
              "pso_type": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "number"
                  },
                  "name": {
                    "type": "string"
                  },
                  "alias": {
                    "type": "string"
                  },
                  "description": {
                    "type": "string"
                  },
                  "is_active": {
                    "type": "boolean"
                  },
                  "system_required": {
                    "type": "boolean"
                  },
                  "creation_form_instance_id": {
                    "type": "number"
                  },
                  "profile_form_instance_id": {
                    "type": "number"
                  }
                },
                "required": [
                  "id",
                  "name",
                  "alias",
                  "description",
                  "is_active",
                  "system_required",
                  "creation_form_instance_id",
                  "profile_form_instance_id"
                ]
              }
            },
            "required": [
              "id",
              "name",
              "description",
              "is_active",
              "removable",
              "has_assigned"
            ]
          },
          "language": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number"
              },
              "alias": {
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "alias",
              "name"
            ]
          },
          "files": {
            "type": "array"
          },
          "owner": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number"
              },
              "external_id": {
                "type": "number"
              },
              "first_name": {
                "type": "string"
              },
              "last_name": {
                "type": "string"
              },
              "username": {
                "type": "string"
              },
              "professional_email": {
                "type": "string"
              },
              "professional_mobile_phone": {
                "type": "string"
              },
              "professional_phone": {
                "type": "string"
              },
              "role": {
                "type": "array"
              },
              "is_active": {
                "type": "boolean"
              },
              "status": {
                "type": "string"
              },
              "settings": {
                "type": "array"
              },
              "user_photo": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "external_id",
              "first_name",
              "last_name",
              "username",
              "professional_email",
              "professional_mobile_phone",
              "professional_phone",
              "role",
              "is_active",
              "status",
              "settings",
              "user_photo"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "id",
          "name",
          "description",
          "is_active",
          "status",
          "strategies"
        ]
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number"
            },
            "count": {
              "type": "number"
            },
            "per_page": {
              "type": "number"
            },
            "current_page": {
              "type": "number"
            },
            "total_pages": {
              "type": "number"
            },
            "links": {
              "type": "object",
              "properties": {
                "previous": {
                  "type": "string"
                },
                "next": {
                  "type": "string"
                }
              },
              "required": [
                "previous",
                "next"
              ]
            }
          },
          "required": [
            "total",
            "count",
            "per_page",
            "current_page",
            "total_pages",
            "links"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "pagination"
      ]
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/connector-builder/imports/{id}{?include}

Fetch specified data import

Example URI

GET https://rest.monportailrh.com/connector-builder/imports/1?include=language,form
URI Parameters
HideShow
id
number (required) Example: 1

Id of the Data Import.

include
form, files, language, owner (optional) Example: language,form
The way to include relations in the response. Target relations can be comma separated if you want to get few of them
Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <comma separated features>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 1,
    "name": "Data Import Name",
    "description": "Data Import Description",
    "is_active": true,
    "status": "pending",
    "strategies": {
      "list_of": "add",
      "empty_values": "erase"
    },
    "form": {
      "id": 1,
      "name": "Form Name",
      "description": "Form Description",
      "is_active": true,
      "removable": true,
      "has_assigned": true,
      "fields": [
        {
          "id": 1,
          "name": "Field Name",
          "position": 5,
          "alias": "usr_first_name",
          "has_unique_data": false,
          "has_value": true,
          "removable": false,
          "is_active": true,
          "list": false,
          "read_only": false,
          "required": true,
          "user_required": true,
          "system_required": true,
          "type": {
            "id": 1,
            "name": "Data Type Name",
            "alias": "data_type_alias",
            "settings": [
              {
                "id": 1,
                "name": "Data Type Setting Name",
                "alias": "data_type_setting_alias",
                "is_required": true
              }
            ],
            "supports_collection": false,
            "supports_read_only": false,
            "supports_unique": false
          },
          "category": {
            "id": 32,
            "alias": "usr_identity",
            "position": 5,
            "system_required": true,
            "name": "Identity",
            "description": "...",
            "is_active": true,
            "pso_type": {
              "id": 56,
              "name": "User",
              "alias": "usr",
              "description": "...",
              "is_active": true,
              "system_required": true,
              "creation_form_instance_id": 1,
              "profile_form_instance_id": 1
            }
          },
          "domains": [
            {
              "id": 46,
              "alias": "usr_global",
              "name": "User Global",
              "description": "...",
              "is_editable": false,
              "is_removable": false,
              "is_active": true,
              "pso_type": {
                "id": 56,
                "name": "User",
                "alias": "usr",
                "description": "...",
                "is_active": true,
                "system_required": true,
                "creation_form_instance_id": 1,
                "profile_form_instance_id": 1
              }
            }
          ],
          "privacy_level": {
            "id": 123,
            "alias": "public",
            "name": "Not Sensitive",
            "level": 100
          },
          "pso_type": {
            "id": 56,
            "name": "User",
            "alias": "usr",
            "description": "...",
            "is_active": true,
            "system_required": true,
            "creation_form_instance_id": 1,
            "profile_form_instance_id": 1
          },
          "items": [
            {}
          ],
          "options": [
            {
              "id": 198,
              "name": "Choose me!",
              "position": 9,
              "value": "198",
              "is_active": true,
              "is_selectable": true
            }
          ],
          "settings": [],
          "validation": {
            "type": "regexp",
            "attributes": {},
            "value_example": "string",
            "error_message": {
              "en": "Some text",
              "fr": "Du texte",
              "de": "Setwas Text",
              "es": "Algún texto"
            }
          },
          "has_autocomplete_settings": true,
          "autocomplete_settings": {
            "allow_extra_values": true,
            "autofill": true,
            "provider": {
              "name": {
                "en": "Some text",
                "fr": "Du texte",
                "de": "Setwas Text",
                "es": "Algún texto"
              },
              "alias": "string",
              "base_url": "https://exmaple.com/",
              "single_value_supported": true,
              "parameters": [
                {
                  "name": "Name",
                  "key": "alias",
                  "required": true
                }
              ]
            },
            "parameters": [
              {
                "name": "Name",
                "key": "alias",
                "required": true,
                "value": "value",
                "field": {
                  "id": 1,
                  "name": "Field Name",
                  "alias": "usr_first_name",
                  "value": "RU",
                  "root_field": {
                    "id": 1,
                    "name": "Field Name",
                    "alias": "usr_first_name",
                    "value": "RU",
                    "root_field": "null"
                  }
                }
              }
            ]
          }
        }
      ],
      "pso_type": {
        "id": 56,
        "name": "User",
        "alias": "usr",
        "description": "...",
        "is_active": true,
        "system_required": true,
        "creation_form_instance_id": 1,
        "profile_form_instance_id": 1
      }
    },
    "language": {
      "id": 1,
      "alias": "en",
      "name": "English"
    },
    "files": [],
    "owner": {
      "id": 1,
      "external_id": 1,
      "first_name": "John",
      "last_name": "Snow",
      "username": "john_snow",
      "professional_email": "jsnow@example.com",
      "professional_mobile_phone": "00 33 1 40 00 00 00",
      "professional_phone": "00 33 1 40 00 00 00",
      "role": [
        "bastard",
        "king"
      ],
      "is_active": true,
      "status": "remote",
      "settings": [
        "[]"
      ],
      "user_photo": "http://example.com/images/1.jpg"
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "is_active": {
          "type": "boolean"
        },
        "status": {
          "type": "string",
          "enum": [
            "pending",
            "validation_in_progress",
            "validation_success",
            "validation_failed",
            "validation_warning",
            "import_in_progress",
            "import_success",
            "import_failed",
            "import_warning"
          ]
        },
        "strategies": {
          "type": "object",
          "properties": {
            "list_of": {
              "type": "string",
              "enum": [
                "add",
                "replace"
              ]
            },
            "empty_values": {
              "type": "string",
              "enum": [
                "erase",
                "ignore"
              ]
            }
          },
          "required": [
            "list_of",
            "empty_values"
          ],
          "additionalProperties": false
        },
        "form": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "name": {
              "type": "string"
            },
            "description": {
              "type": "string"
            },
            "is_active": {
              "type": "boolean"
            },
            "removable": {
              "type": "boolean"
            },
            "has_assigned": {
              "type": "boolean"
            },
            "fields": {
              "type": "array"
            },
            "pso_type": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number"
                },
                "name": {
                  "type": "string"
                },
                "alias": {
                  "type": "string"
                },
                "description": {
                  "type": "string"
                },
                "is_active": {
                  "type": "boolean"
                },
                "system_required": {
                  "type": "boolean"
                },
                "creation_form_instance_id": {
                  "type": "number"
                },
                "profile_form_instance_id": {
                  "type": "number"
                }
              },
              "required": [
                "id",
                "name",
                "alias",
                "description",
                "is_active",
                "system_required",
                "creation_form_instance_id",
                "profile_form_instance_id"
              ]
            }
          },
          "required": [
            "id",
            "name",
            "description",
            "is_active",
            "removable",
            "has_assigned"
          ]
        },
        "language": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "alias": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          },
          "required": [
            "id",
            "alias",
            "name"
          ]
        },
        "files": {
          "type": "array"
        },
        "owner": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "external_id": {
              "type": "number"
            },
            "first_name": {
              "type": "string"
            },
            "last_name": {
              "type": "string"
            },
            "username": {
              "type": "string"
            },
            "professional_email": {
              "type": "string"
            },
            "professional_mobile_phone": {
              "type": "string"
            },
            "professional_phone": {
              "type": "string"
            },
            "role": {
              "type": "array"
            },
            "is_active": {
              "type": "boolean"
            },
            "status": {
              "type": "string"
            },
            "settings": {
              "type": "array"
            },
            "user_photo": {
              "type": "string"
            }
          },
          "required": [
            "id",
            "external_id",
            "first_name",
            "last_name",
            "username",
            "professional_email",
            "professional_mobile_phone",
            "professional_phone",
            "role",
            "is_active",
            "status",
            "settings",
            "user_photo"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "id",
        "name",
        "description",
        "is_active",
        "status",
        "strategies"
      ],
      "additionalProperties": false
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Create
POST/connector-builder/imports

Create new data import

Example URI

POST https://rest.monportailrh.com/connector-builder/imports
Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target features>
Body
{
  "name": {
    "en": "Some text",
    "fr": "Du texte",
    "de": "Setwas Text",
    "es": "Algún texto"
  },
  "description": {
    "en": "Some text",
    "fr": "Du texte",
    "de": "Setwas Text",
    "es": "Algún texto"
  },
  "form": 1,
  "language": "en",
  "is_active": true,
  "strategies": {
    "list_of": "add",
    "empty_values": "erase"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "object",
      "properties": {
        "en": {
          "type": "string"
        },
        "fr": {
          "type": "string"
        },
        "de": {
          "type": "string"
        },
        "es": {
          "type": "string"
        }
      },
      "required": [
        "en",
        "fr",
        "de",
        "es"
      ]
    },
    "description": {
      "type": "object",
      "properties": {
        "en": {
          "type": "string"
        },
        "fr": {
          "type": "string"
        },
        "de": {
          "type": "string"
        },
        "es": {
          "type": "string"
        }
      },
      "required": [
        "en",
        "fr",
        "de",
        "es"
      ]
    },
    "form": {
      "type": "number"
    },
    "language": {
      "type": "string",
      "description": "alias of available in system language"
    },
    "is_active": {
      "type": "boolean"
    },
    "strategies": {
      "type": "object",
      "properties": {
        "list_of": {
          "type": "string",
          "enum": [
            "add",
            "replace"
          ]
        },
        "empty_values": {
          "type": "string",
          "enum": [
            "erase",
            "ignore"
          ]
        }
      },
      "required": [
        "list_of",
        "empty_values"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "name",
    "description",
    "form",
    "language",
    "is_active",
    "strategies"
  ]
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 1,
    "name": "Data Import Name",
    "description": "Data Import Description",
    "is_active": true,
    "status": "pending",
    "strategies": {
      "list_of": "add",
      "empty_values": "erase"
    },
    "form": {
      "id": 1,
      "name": "Form Name",
      "description": "Form Description",
      "is_active": true,
      "removable": true,
      "has_assigned": true,
      "fields": [
        {
          "id": 1,
          "name": "Field Name",
          "position": 5,
          "alias": "usr_first_name",
          "has_unique_data": false,
          "has_value": true,
          "removable": false,
          "is_active": true,
          "list": false,
          "read_only": false,
          "required": true,
          "user_required": true,
          "system_required": true,
          "type": {
            "id": 1,
            "name": "Data Type Name",
            "alias": "data_type_alias",
            "settings": [
              {
                "id": 1,
                "name": "Data Type Setting Name",
                "alias": "data_type_setting_alias",
                "is_required": true
              }
            ],
            "supports_collection": false,
            "supports_read_only": false,
            "supports_unique": false
          },
          "category": {
            "id": 32,
            "alias": "usr_identity",
            "position": 5,
            "system_required": true,
            "name": "Identity",
            "description": "...",
            "is_active": true,
            "pso_type": {
              "id": 56,
              "name": "User",
              "alias": "usr",
              "description": "...",
              "is_active": true,
              "system_required": true,
              "creation_form_instance_id": 1,
              "profile_form_instance_id": 1
            }
          },
          "domains": [
            {
              "id": 46,
              "alias": "usr_global",
              "name": "User Global",
              "description": "...",
              "is_editable": false,
              "is_removable": false,
              "is_active": true,
              "pso_type": {
                "id": 56,
                "name": "User",
                "alias": "usr",
                "description": "...",
                "is_active": true,
                "system_required": true,
                "creation_form_instance_id": 1,
                "profile_form_instance_id": 1
              }
            }
          ],
          "privacy_level": {
            "id": 123,
            "alias": "public",
            "name": "Not Sensitive",
            "level": 100
          },
          "pso_type": {
            "id": 56,
            "name": "User",
            "alias": "usr",
            "description": "...",
            "is_active": true,
            "system_required": true,
            "creation_form_instance_id": 1,
            "profile_form_instance_id": 1
          },
          "items": [
            {}
          ],
          "options": [
            {
              "id": 198,
              "name": "Choose me!",
              "position": 9,
              "value": "198",
              "is_active": true,
              "is_selectable": true
            }
          ],
          "settings": [],
          "validation": {
            "type": "regexp",
            "attributes": {},
            "value_example": "string",
            "error_message": {
              "en": "Some text",
              "fr": "Du texte",
              "de": "Setwas Text",
              "es": "Algún texto"
            }
          },
          "has_autocomplete_settings": true,
          "autocomplete_settings": {
            "allow_extra_values": true,
            "autofill": true,
            "provider": {
              "name": {
                "en": "Some text",
                "fr": "Du texte",
                "de": "Setwas Text",
                "es": "Algún texto"
              },
              "alias": "string",
              "base_url": "https://exmaple.com/",
              "single_value_supported": true,
              "parameters": [
                {
                  "name": "Name",
                  "key": "alias",
                  "required": true
                }
              ]
            },
            "parameters": [
              {
                "name": "Name",
                "key": "alias",
                "required": true,
                "value": "value",
                "field": {
                  "id": 1,
                  "name": "Field Name",
                  "alias": "usr_first_name",
                  "value": "RU",
                  "root_field": {
                    "id": 1,
                    "name": "Field Name",
                    "alias": "usr_first_name",
                    "value": "RU",
                    "root_field": "null"
                  }
                }
              }
            ]
          }
        }
      ],
      "pso_type": {
        "id": 56,
        "name": "User",
        "alias": "usr",
        "description": "...",
        "is_active": true,
        "system_required": true,
        "creation_form_instance_id": 1,
        "profile_form_instance_id": 1
      }
    },
    "language": {
      "id": 1,
      "alias": "en",
      "name": "English"
    },
    "files": [],
    "owner": {
      "id": 1,
      "external_id": 1,
      "first_name": "John",
      "last_name": "Snow",
      "username": "john_snow",
      "professional_email": "jsnow@example.com",
      "professional_mobile_phone": "00 33 1 40 00 00 00",
      "professional_phone": "00 33 1 40 00 00 00",
      "role": [
        "bastard",
        "king"
      ],
      "is_active": true,
      "status": "remote",
      "settings": [
        "[]"
      ],
      "user_photo": "http://example.com/images/1.jpg"
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "is_active": {
          "type": "boolean"
        },
        "status": {
          "type": "string",
          "enum": [
            "pending",
            "validation_in_progress",
            "validation_success",
            "validation_failed",
            "validation_warning",
            "import_in_progress",
            "import_success",
            "import_failed",
            "import_warning"
          ]
        },
        "strategies": {
          "type": "object",
          "properties": {
            "list_of": {
              "type": "string",
              "enum": [
                "add",
                "replace"
              ]
            },
            "empty_values": {
              "type": "string",
              "enum": [
                "erase",
                "ignore"
              ]
            }
          },
          "required": [
            "list_of",
            "empty_values"
          ],
          "additionalProperties": false
        },
        "form": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "name": {
              "type": "string"
            },
            "description": {
              "type": "string"
            },
            "is_active": {
              "type": "boolean"
            },
            "removable": {
              "type": "boolean"
            },
            "has_assigned": {
              "type": "boolean"
            },
            "fields": {
              "type": "array"
            },
            "pso_type": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number"
                },
                "name": {
                  "type": "string"
                },
                "alias": {
                  "type": "string"
                },
                "description": {
                  "type": "string"
                },
                "is_active": {
                  "type": "boolean"
                },
                "system_required": {
                  "type": "boolean"
                },
                "creation_form_instance_id": {
                  "type": "number"
                },
                "profile_form_instance_id": {
                  "type": "number"
                }
              },
              "required": [
                "id",
                "name",
                "alias",
                "description",
                "is_active",
                "system_required",
                "creation_form_instance_id",
                "profile_form_instance_id"
              ]
            }
          },
          "required": [
            "id",
            "name",
            "description",
            "is_active",
            "removable",
            "has_assigned"
          ]
        },
        "language": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "alias": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          },
          "required": [
            "id",
            "alias",
            "name"
          ]
        },
        "files": {
          "type": "array"
        },
        "owner": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "external_id": {
              "type": "number"
            },
            "first_name": {
              "type": "string"
            },
            "last_name": {
              "type": "string"
            },
            "username": {
              "type": "string"
            },
            "professional_email": {
              "type": "string"
            },
            "professional_mobile_phone": {
              "type": "string"
            },
            "professional_phone": {
              "type": "string"
            },
            "role": {
              "type": "array"
            },
            "is_active": {
              "type": "boolean"
            },
            "status": {
              "type": "string"
            },
            "settings": {
              "type": "array"
            },
            "user_photo": {
              "type": "string"
            }
          },
          "required": [
            "id",
            "external_id",
            "first_name",
            "last_name",
            "username",
            "professional_email",
            "professional_mobile_phone",
            "professional_phone",
            "role",
            "is_active",
            "status",
            "settings",
            "user_photo"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "id",
        "name",
        "description",
        "is_active",
        "status",
        "strategies"
      ],
      "additionalProperties": false
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 400
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/connector-builder/imports/{id}

Update data import

Example URI

PATCH https://rest.monportailrh.com/connector-builder/imports/1
URI Parameters
HideShow
id
number (required) Example: 1

Id of the Data Import.

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target features>
Body
{
  "name": {
    "en": "Some text",
    "fr": "Du texte",
    "de": "Setwas Text",
    "es": "Algún texto"
  },
  "description": {
    "en": "Some text",
    "fr": "Du texte",
    "de": "Setwas Text",
    "es": "Algún texto"
  },
  "form": 1,
  "language": "en",
  "is_active": true,
  "strategies": {
    "list_of": "add",
    "empty_values": "erase"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "object",
      "properties": {
        "en": {
          "type": "string"
        },
        "fr": {
          "type": "string"
        },
        "de": {
          "type": "string"
        },
        "es": {
          "type": "string"
        }
      },
      "required": [
        "en",
        "fr",
        "de",
        "es"
      ]
    },
    "description": {
      "type": "object",
      "properties": {
        "en": {
          "type": "string"
        },
        "fr": {
          "type": "string"
        },
        "de": {
          "type": "string"
        },
        "es": {
          "type": "string"
        }
      },
      "required": [
        "en",
        "fr",
        "de",
        "es"
      ]
    },
    "form": {
      "type": "number"
    },
    "language": {
      "type": "string",
      "description": "alias of available in system language"
    },
    "is_active": {
      "type": "boolean"
    },
    "strategies": {
      "type": "object",
      "properties": {
        "list_of": {
          "type": "string",
          "enum": [
            "add",
            "replace"
          ]
        },
        "empty_values": {
          "type": "string",
          "enum": [
            "erase",
            "ignore"
          ]
        }
      }
    }
  }
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 1,
    "name": "Data Import Name",
    "description": "Data Import Description",
    "is_active": true,
    "status": "pending",
    "strategies": {
      "list_of": "add",
      "empty_values": "erase"
    },
    "form": {
      "id": 1,
      "name": "Form Name",
      "description": "Form Description",
      "is_active": true,
      "removable": true,
      "has_assigned": true,
      "fields": [
        {
          "id": 1,
          "name": "Field Name",
          "position": 5,
          "alias": "usr_first_name",
          "has_unique_data": false,
          "has_value": true,
          "removable": false,
          "is_active": true,
          "list": false,
          "read_only": false,
          "required": true,
          "user_required": true,
          "system_required": true,
          "type": {
            "id": 1,
            "name": "Data Type Name",
            "alias": "data_type_alias",
            "settings": [
              {
                "id": 1,
                "name": "Data Type Setting Name",
                "alias": "data_type_setting_alias",
                "is_required": true
              }
            ],
            "supports_collection": false,
            "supports_read_only": false,
            "supports_unique": false
          },
          "category": {
            "id": 32,
            "alias": "usr_identity",
            "position": 5,
            "system_required": true,
            "name": "Identity",
            "description": "...",
            "is_active": true,
            "pso_type": {
              "id": 56,
              "name": "User",
              "alias": "usr",
              "description": "...",
              "is_active": true,
              "system_required": true,
              "creation_form_instance_id": 1,
              "profile_form_instance_id": 1
            }
          },
          "domains": [
            {
              "id": 46,
              "alias": "usr_global",
              "name": "User Global",
              "description": "...",
              "is_editable": false,
              "is_removable": false,
              "is_active": true,
              "pso_type": {
                "id": 56,
                "name": "User",
                "alias": "usr",
                "description": "...",
                "is_active": true,
                "system_required": true,
                "creation_form_instance_id": 1,
                "profile_form_instance_id": 1
              }
            }
          ],
          "privacy_level": {
            "id": 123,
            "alias": "public",
            "name": "Not Sensitive",
            "level": 100
          },
          "pso_type": {
            "id": 56,
            "name": "User",
            "alias": "usr",
            "description": "...",
            "is_active": true,
            "system_required": true,
            "creation_form_instance_id": 1,
            "profile_form_instance_id": 1
          },
          "items": [
            {}
          ],
          "options": [
            {
              "id": 198,
              "name": "Choose me!",
              "position": 9,
              "value": "198",
              "is_active": true,
              "is_selectable": true
            }
          ],
          "settings": [],
          "validation": {
            "type": "regexp",
            "attributes": {},
            "value_example": "string",
            "error_message": {
              "en": "Some text",
              "fr": "Du texte",
              "de": "Setwas Text",
              "es": "Algún texto"
            }
          },
          "has_autocomplete_settings": true,
          "autocomplete_settings": {
            "allow_extra_values": true,
            "autofill": true,
            "provider": {
              "name": {
                "en": "Some text",
                "fr": "Du texte",
                "de": "Setwas Text",
                "es": "Algún texto"
              },
              "alias": "string",
              "base_url": "https://exmaple.com/",
              "single_value_supported": true,
              "parameters": [
                {
                  "name": "Name",
                  "key": "alias",
                  "required": true
                }
              ]
            },
            "parameters": [
              {
                "name": "Name",
                "key": "alias",
                "required": true,
                "value": "value",
                "field": {
                  "id": 1,
                  "name": "Field Name",
                  "alias": "usr_first_name",
                  "value": "RU",
                  "root_field": {
                    "id": 1,
                    "name": "Field Name",
                    "alias": "usr_first_name",
                    "value": "RU",
                    "root_field": "null"
                  }
                }
              }
            ]
          }
        }
      ],
      "pso_type": {
        "id": 56,
        "name": "User",
        "alias": "usr",
        "description": "...",
        "is_active": true,
        "system_required": true,
        "creation_form_instance_id": 1,
        "profile_form_instance_id": 1
      }
    },
    "language": {
      "id": 1,
      "alias": "en",
      "name": "English"
    },
    "files": [],
    "owner": {
      "id": 1,
      "external_id": 1,
      "first_name": "John",
      "last_name": "Snow",
      "username": "john_snow",
      "professional_email": "jsnow@example.com",
      "professional_mobile_phone": "00 33 1 40 00 00 00",
      "professional_phone": "00 33 1 40 00 00 00",
      "role": [
        "bastard",
        "king"
      ],
      "is_active": true,
      "status": "remote",
      "settings": [
        "[]"
      ],
      "user_photo": "http://example.com/images/1.jpg"
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "is_active": {
          "type": "boolean"
        },
        "status": {
          "type": "string",
          "enum": [
            "pending",
            "validation_in_progress",
            "validation_success",
            "validation_failed",
            "validation_warning",
            "import_in_progress",
            "import_success",
            "import_failed",
            "import_warning"
          ]
        },
        "strategies": {
          "type": "object",
          "properties": {
            "list_of": {
              "type": "string",
              "enum": [
                "add",
                "replace"
              ]
            },
            "empty_values": {
              "type": "string",
              "enum": [
                "erase",
                "ignore"
              ]
            }
          },
          "required": [
            "list_of",
            "empty_values"
          ],
          "additionalProperties": false
        },
        "form": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "name": {
              "type": "string"
            },
            "description": {
              "type": "string"
            },
            "is_active": {
              "type": "boolean"
            },
            "removable": {
              "type": "boolean"
            },
            "has_assigned": {
              "type": "boolean"
            },
            "fields": {
              "type": "array"
            },
            "pso_type": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number"
                },
                "name": {
                  "type": "string"
                },
                "alias": {
                  "type": "string"
                },
                "description": {
                  "type": "string"
                },
                "is_active": {
                  "type": "boolean"
                },
                "system_required": {
                  "type": "boolean"
                },
                "creation_form_instance_id": {
                  "type": "number"
                },
                "profile_form_instance_id": {
                  "type": "number"
                }
              },
              "required": [
                "id",
                "name",
                "alias",
                "description",
                "is_active",
                "system_required",
                "creation_form_instance_id",
                "profile_form_instance_id"
              ]
            }
          },
          "required": [
            "id",
            "name",
            "description",
            "is_active",
            "removable",
            "has_assigned"
          ]
        },
        "language": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "alias": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          },
          "required": [
            "id",
            "alias",
            "name"
          ]
        },
        "files": {
          "type": "array"
        },
        "owner": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "external_id": {
              "type": "number"
            },
            "first_name": {
              "type": "string"
            },
            "last_name": {
              "type": "string"
            },
            "username": {
              "type": "string"
            },
            "professional_email": {
              "type": "string"
            },
            "professional_mobile_phone": {
              "type": "string"
            },
            "professional_phone": {
              "type": "string"
            },
            "role": {
              "type": "array"
            },
            "is_active": {
              "type": "boolean"
            },
            "status": {
              "type": "string"
            },
            "settings": {
              "type": "array"
            },
            "user_photo": {
              "type": "string"
            }
          },
          "required": [
            "id",
            "external_id",
            "first_name",
            "last_name",
            "username",
            "professional_email",
            "professional_mobile_phone",
            "professional_phone",
            "role",
            "is_active",
            "status",
            "settings",
            "user_photo"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "id",
        "name",
        "description",
        "is_active",
        "status",
        "strategies"
      ],
      "additionalProperties": false
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 400
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete
DELETE/connector-builder/imports/{id}

Delete data import

Example URI

DELETE https://rest.monportailrh.com/connector-builder/imports/1
URI Parameters
HideShow
id
number (required) Example: 1

Id of the data Import.

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target features>
Response  204
HideShow
Headers
Content-Type: application/json
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 400
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Download template
GET/connector-builder/imports/{form}/template/{language}

Generate .xls template for import based by selected form

It returns file stream with generated template file.

Example URI

GET https://rest.monportailrh.com/connector-builder/imports/1/template/en
URI Parameters
HideShow
form
number (required) Example: 1

Id of the form for template

language
string (required) Example: en

Language alias for the template generating

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <comma separated features>
Response  200
HideShow
Headers
Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Validate
POST/connector-builder/imports/{id}/validate

Upload and validate filled template template

Upload filled .xls template and plan it to validate. It not available if any other file in process(validation/submission) at the moment.

Example URI

POST https://rest.monportailrh.com/connector-builder/imports/1/validate
URI Parameters
HideShow
id
number (required) Example: 1

Id of the Data Import.

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <comma separated features>
Body
{
  "name": "image.jpg",
  "file": {}
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "file": {
      "type": "object",
      "properties": {},
      "description": "file to upload. Max size 5 megabytes."
    }
  },
  "required": [
    "file"
  ]
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 1,
    "name": "Data Import Name",
    "description": "Data Import Description",
    "is_active": true,
    "status": "pending",
    "strategies": {
      "list_of": "add",
      "empty_values": "erase"
    },
    "form": {
      "id": 1,
      "name": "Form Name",
      "description": "Form Description",
      "is_active": true,
      "removable": true,
      "has_assigned": true,
      "fields": [
        {
          "id": 1,
          "name": "Field Name",
          "position": 5,
          "alias": "usr_first_name",
          "has_unique_data": false,
          "has_value": true,
          "removable": false,
          "is_active": true,
          "list": false,
          "read_only": false,
          "required": true,
          "user_required": true,
          "system_required": true,
          "type": {
            "id": 1,
            "name": "Data Type Name",
            "alias": "data_type_alias",
            "settings": [
              {
                "id": 1,
                "name": "Data Type Setting Name",
                "alias": "data_type_setting_alias",
                "is_required": true
              }
            ],
            "supports_collection": false,
            "supports_read_only": false,
            "supports_unique": false
          },
          "category": {
            "id": 32,
            "alias": "usr_identity",
            "position": 5,
            "system_required": true,
            "name": "Identity",
            "description": "...",
            "is_active": true,
            "pso_type": {
              "id": 56,
              "name": "User",
              "alias": "usr",
              "description": "...",
              "is_active": true,
              "system_required": true,
              "creation_form_instance_id": 1,
              "profile_form_instance_id": 1
            }
          },
          "domains": [
            {
              "id": 46,
              "alias": "usr_global",
              "name": "User Global",
              "description": "...",
              "is_editable": false,
              "is_removable": false,
              "is_active": true,
              "pso_type": {
                "id": 56,
                "name": "User",
                "alias": "usr",
                "description": "...",
                "is_active": true,
                "system_required": true,
                "creation_form_instance_id": 1,
                "profile_form_instance_id": 1
              }
            }
          ],
          "privacy_level": {
            "id": 123,
            "alias": "public",
            "name": "Not Sensitive",
            "level": 100
          },
          "pso_type": {
            "id": 56,
            "name": "User",
            "alias": "usr",
            "description": "...",
            "is_active": true,
            "system_required": true,
            "creation_form_instance_id": 1,
            "profile_form_instance_id": 1
          },
          "items": [
            {}
          ],
          "options": [
            {
              "id": 198,
              "name": "Choose me!",
              "position": 9,
              "value": "198",
              "is_active": true,
              "is_selectable": true
            }
          ],
          "settings": [],
          "validation": {
            "type": "regexp",
            "attributes": {},
            "value_example": "string",
            "error_message": {
              "en": "Some text",
              "fr": "Du texte",
              "de": "Setwas Text",
              "es": "Algún texto"
            }
          },
          "has_autocomplete_settings": true,
          "autocomplete_settings": {
            "allow_extra_values": true,
            "autofill": true,
            "provider": {
              "name": {
                "en": "Some text",
                "fr": "Du texte",
                "de": "Setwas Text",
                "es": "Algún texto"
              },
              "alias": "string",
              "base_url": "https://exmaple.com/",
              "single_value_supported": true,
              "parameters": [
                {
                  "name": "Name",
                  "key": "alias",
                  "required": true
                }
              ]
            },
            "parameters": [
              {
                "name": "Name",
                "key": "alias",
                "required": true,
                "value": "value",
                "field": {
                  "id": 1,
                  "name": "Field Name",
                  "alias": "usr_first_name",
                  "value": "RU",
                  "root_field": {
                    "id": 1,
                    "name": "Field Name",
                    "alias": "usr_first_name",
                    "value": "RU",
                    "root_field": "null"
                  }
                }
              }
            ]
          }
        }
      ],
      "pso_type": {
        "id": 56,
        "name": "User",
        "alias": "usr",
        "description": "...",
        "is_active": true,
        "system_required": true,
        "creation_form_instance_id": 1,
        "profile_form_instance_id": 1
      }
    },
    "language": {
      "id": 1,
      "alias": "en",
      "name": "English"
    },
    "files": [],
    "owner": {
      "id": 1,
      "external_id": 1,
      "first_name": "John",
      "last_name": "Snow",
      "username": "john_snow",
      "professional_email": "jsnow@example.com",
      "professional_mobile_phone": "00 33 1 40 00 00 00",
      "professional_phone": "00 33 1 40 00 00 00",
      "role": [
        "bastard",
        "king"
      ],
      "is_active": true,
      "status": "remote",
      "settings": [
        "[]"
      ],
      "user_photo": "http://example.com/images/1.jpg"
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "is_active": {
          "type": "boolean"
        },
        "status": {
          "type": "string",
          "enum": [
            "pending",
            "validation_in_progress",
            "validation_success",
            "validation_failed",
            "validation_warning",
            "import_in_progress",
            "import_success",
            "import_failed",
            "import_warning"
          ]
        },
        "strategies": {
          "type": "object",
          "properties": {
            "list_of": {
              "type": "string",
              "enum": [
                "add",
                "replace"
              ]
            },
            "empty_values": {
              "type": "string",
              "enum": [
                "erase",
                "ignore"
              ]
            }
          },
          "required": [
            "list_of",
            "empty_values"
          ],
          "additionalProperties": false
        },
        "form": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "name": {
              "type": "string"
            },
            "description": {
              "type": "string"
            },
            "is_active": {
              "type": "boolean"
            },
            "removable": {
              "type": "boolean"
            },
            "has_assigned": {
              "type": "boolean"
            },
            "fields": {
              "type": "array"
            },
            "pso_type": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number"
                },
                "name": {
                  "type": "string"
                },
                "alias": {
                  "type": "string"
                },
                "description": {
                  "type": "string"
                },
                "is_active": {
                  "type": "boolean"
                },
                "system_required": {
                  "type": "boolean"
                },
                "creation_form_instance_id": {
                  "type": "number"
                },
                "profile_form_instance_id": {
                  "type": "number"
                }
              },
              "required": [
                "id",
                "name",
                "alias",
                "description",
                "is_active",
                "system_required",
                "creation_form_instance_id",
                "profile_form_instance_id"
              ]
            }
          },
          "required": [
            "id",
            "name",
            "description",
            "is_active",
            "removable",
            "has_assigned"
          ]
        },
        "language": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "alias": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          },
          "required": [
            "id",
            "alias",
            "name"
          ]
        },
        "files": {
          "type": "array"
        },
        "owner": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "external_id": {
              "type": "number"
            },
            "first_name": {
              "type": "string"
            },
            "last_name": {
              "type": "string"
            },
            "username": {
              "type": "string"
            },
            "professional_email": {
              "type": "string"
            },
            "professional_mobile_phone": {
              "type": "string"
            },
            "professional_phone": {
              "type": "string"
            },
            "role": {
              "type": "array"
            },
            "is_active": {
              "type": "boolean"
            },
            "status": {
              "type": "string"
            },
            "settings": {
              "type": "array"
            },
            "user_photo": {
              "type": "string"
            }
          },
          "required": [
            "id",
            "external_id",
            "first_name",
            "last_name",
            "username",
            "professional_email",
            "professional_mobile_phone",
            "professional_phone",
            "role",
            "is_active",
            "status",
            "settings",
            "user_photo"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "id",
        "name",
        "description",
        "is_active",
        "status",
        "strategies"
      ],
      "additionalProperties": false
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Run import
POST/connector-builder/imports/{id}/run

Run import process

It plans import data from last valid(success or warning) file.

Example URI

POST https://rest.monportailrh.com/connector-builder/imports/1/run
URI Parameters
HideShow
id
number (required) Example: 1

Id of the Data Import.

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <comma separated features>
Response  204
HideShow
Headers
Content-Type: application/json
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Download Import files
GET/connector-builder/imports/{id}/download/{type}/{filename}

Example URI

GET https://rest.monportailrh.com/connector-builder/imports/1/download/data_file/import_source_02_location_import_base_06092020184859.xlsx
URI Parameters
HideShow
id
number (required) Example: 1

Import id

type
data_file,validation_file,execution_file (required) Example: data_file

Type of file to download, it can be log or source file

filename
string (required) Example: import_source_02_location_import_base_06092020184859.xlsx

File name, can be found in import responses with files include

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <comma separated features>
Response  200
HideShow
Headers
Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Response  200
HideShow
Headers
Content-Type: text/plain
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Document Generators

Document Generators generate pdf files via specified document templates and store them in specified user profile fields

Document Generators

Common List
GET/document-generators{?title,pso-type,active,sort-by,sort-direction,page,per-page,no-pagination,should-be-signed}

Get list of document generators matches specified filters

Example URI

GET https://rest.monportailrh.com/document-generators?title=Document generator name to search&pso-type=usr&active=true&sort-by=name&sort-direction=asc&page=1&per-page=10&no-pagination=false&should-be-signed=false
URI Parameters
HideShow
title
string (optional) Example: Document generator name to search

Search by title. Non strict, case-insensitive.

pso-type
string (optional) Example: usr

Pso Type trigram to filter document generators

active
boolean (optional) Example: true

Field for filter exports by is_active column

sort-by
name, created_at (required) Example: name
sort-direction
asc, desc (required) Example: asc
page
number (required) Example: 1

Page number. 1 by default

per-page
number (required) Example: 10

Number of items per page, 25 by default

no-pagination
boolean (required) Example: false

if presented and positive pagination will not be applied. All available items will be returned.

Note: it may have significant impact on the performance

Note: once this option positive and presented - meta attribute with pagination data will be omit in response

should-be-signed
boolean (optional) Example: false
Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": 0,
      "title": "document generator name",
      "description": "document generator description",
      "is_active": true,
      "status": "new",
      "should_be_signed": false,
      "is_processing": false,
      "excluded_block_ids": [
        "block001",
        "block002"
      ],
      "signature_expiration_date": "2019",
      "effective_date": "2019",
      "pso_type": {
        "id": 56,
        "name": "User",
        "alias": "usr",
        "description": "...",
        "is_active": true,
        "system_required": true,
        "creation_form_instance_id": 1,
        "profile_form_instance_id": 1
      },
      "template": {
        "title": "document template name",
        "description": "document template description",
        "is_active": true,
        "pso_type": {
          "id": 56,
          "name": "User",
          "alias": "usr",
          "description": "...",
          "is_active": true,
          "system_required": true,
          "creation_form_instance_id": 1,
          "profile_form_instance_id": 1
        },
        "blocks": [
          {
            "id": "block001",
            "content": "Some stuff with <b>html</b>",
            "conditions": [
              {
                "field": "employment_contract_type",
                "comparison": "=",
                "value": "internship"
              }
            ],
            "type": "common",
            "position": 1,
            "is_customized": false,
            "substitutions": [
              "Variables, that used in template"
            ],
            "original_block_id": "redefined block"
          }
        ]
      },
      "target_population": [
        {
          "type": "all",
          "details": {
            "dynamic": true,
            "includes": [
              "group_a"
            ],
            "excludes": [
              "group_b",
              "group_c"
            ]
          }
        }
      ],
      "storage_field": "alias of field",
      "blocks": [
        {
          "id": "block001",
          "content": "Some stuff with <b>html</b>",
          "conditions": [
            {
              "field": "employment_contract_type",
              "comparison": "=",
              "value": "internship"
            }
          ],
          "type": "common",
          "position": 1,
          "is_customized": false,
          "substitutions": [
            "Variables, that used in template"
          ],
          "original_block_id": "redefined block"
        }
      ],
      "signature_workflow": [
        {
          "entity_id": 0,
          "title": "Self",
          "type": "relation",
          "step": 1
        },
        {
          "entity_id": 123,
          "title": "John Snow",
          "type": "user",
          "step": 2
        }
      ]
    }
  ],
  "meta": {
    "pagination": {
      "total": 238,
      "count": 25,
      "per_page": 25,
      "current_page": 2,
      "total_pages": 10,
      "links": {
        "previous": "http://example.com/api/<endpoint>?page=1",
        "next": "http://example.com/api/<endpoint>?page=3"
      }
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number"
          },
          "title": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "is_active": {
            "type": "boolean"
          },
          "status": {
            "type": "string",
            "enum": [
              "new",
              "processing",
              "requires_signature",
              "signing_doc",
              "failed",
              "done"
            ]
          },
          "should_be_signed": {
            "type": "boolean"
          },
          "is_processing": {
            "type": "boolean"
          },
          "excluded_block_ids": {
            "type": "array"
          },
          "signature_expiration_date": {
            "type": "string",
            "description": "01-01 (date)"
          },
          "effective_date": {
            "type": "string",
            "description": "01-01 (date)"
          },
          "pso_type": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number"
              },
              "name": {
                "type": "string"
              },
              "alias": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "is_active": {
                "type": "boolean"
              },
              "system_required": {
                "type": "boolean"
              },
              "creation_form_instance_id": {
                "type": "number"
              },
              "profile_form_instance_id": {
                "type": "number"
              }
            },
            "required": [
              "id",
              "name",
              "alias",
              "description",
              "is_active",
              "system_required",
              "creation_form_instance_id",
              "profile_form_instance_id"
            ],
            "additionalProperties": false
          },
          "template": {
            "type": "object",
            "properties": {
              "title": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "is_active": {
                "type": "boolean"
              },
              "pso_type": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "number"
                  },
                  "name": {
                    "type": "string"
                  },
                  "alias": {
                    "type": "string"
                  },
                  "description": {
                    "type": "string"
                  },
                  "is_active": {
                    "type": "boolean"
                  },
                  "system_required": {
                    "type": "boolean"
                  },
                  "creation_form_instance_id": {
                    "type": "number"
                  },
                  "profile_form_instance_id": {
                    "type": "number"
                  }
                },
                "required": [
                  "id",
                  "name",
                  "alias",
                  "description",
                  "is_active",
                  "system_required",
                  "creation_form_instance_id",
                  "profile_form_instance_id"
                ],
                "additionalProperties": false
              },
              "blocks": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string",
                      "enum": [
                        "block001"
                      ]
                    },
                    "content": {
                      "type": "string",
                      "enum": [
                        "Some stuff with <b>html</b>"
                      ]
                    },
                    "conditions": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "field": {
                            "type": "string",
                            "enum": [
                              "employment_contract_type"
                            ]
                          },
                          "comparison": {
                            "type": "string",
                            "enum": [
                              "="
                            ]
                          },
                          "value": {
                            "type": "string",
                            "enum": [
                              "internship"
                            ]
                          }
                        },
                        "required": [
                          "field",
                          "comparison",
                          "value"
                        ],
                        "additionalProperties": false
                      }
                    },
                    "type": {
                      "type": "string",
                      "enum": [
                        "common",
                        "header",
                        "footer"
                      ]
                    },
                    "position": {
                      "type": "number",
                      "enum": [
                        1
                      ]
                    },
                    "is_customized": {
                      "type": "boolean",
                      "enum": [
                        false
                      ]
                    },
                    "substitutions": {
                      "type": "array",
                      "items": {
                        "type": "string",
                        "enum": [
                          "Variables, that used in template"
                        ]
                      }
                    },
                    "original_block_id": {
                      "type": "string",
                      "enum": [
                        "redefined block"
                      ]
                    }
                  },
                  "required": [
                    "id",
                    "content",
                    "conditions",
                    "type",
                    "position",
                    "is_customized",
                    "substitutions",
                    "original_block_id"
                  ],
                  "additionalProperties": false
                }
              }
            },
            "required": [
              "title",
              "description",
              "is_active",
              "pso_type",
              "blocks"
            ]
          },
          "target_population": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "type": {
                  "type": "string",
                  "enum": [
                    "all",
                    "group",
                    "pso",
                    "relation",
                    "self"
                  ]
                },
                "details": {
                  "anyOf": [
                    {
                      "type": "object",
                      "properties": {
                        "dynamic": {
                          "type": "boolean"
                        },
                        "includes": {
                          "type": "array"
                        },
                        "excludes": {
                          "type": "array"
                        }
                      },
                      "required": [
                        "dynamic",
                        "includes",
                        "excludes"
                      ]
                    },
                    {
                      "type": "array",
                      "enum": [
                        [],
                        []
                      ]
                    }
                  ],
                  "type": "null"
                }
              },
              "required": [
                "type",
                "details"
              ]
            }
          },
          "storage_field": {
            "type": "string"
          },
          "blocks": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "enum": [
                    "block001"
                  ]
                },
                "content": {
                  "type": "string",
                  "enum": [
                    "Some stuff with <b>html</b>"
                  ]
                },
                "conditions": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "field": {
                        "type": "string",
                        "enum": [
                          "employment_contract_type"
                        ]
                      },
                      "comparison": {
                        "type": "string",
                        "enum": [
                          "="
                        ]
                      },
                      "value": {
                        "type": "string",
                        "enum": [
                          "internship"
                        ]
                      }
                    },
                    "required": [
                      "field",
                      "comparison",
                      "value"
                    ],
                    "additionalProperties": false
                  }
                },
                "type": {
                  "type": "string",
                  "enum": [
                    "common",
                    "header",
                    "footer"
                  ]
                },
                "position": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "is_customized": {
                  "type": "boolean",
                  "enum": [
                    false
                  ]
                },
                "substitutions": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "enum": [
                      "Variables, that used in template"
                    ]
                  }
                },
                "original_block_id": {
                  "type": "string",
                  "enum": [
                    "redefined block"
                  ]
                }
              },
              "required": [
                "id",
                "content",
                "conditions",
                "type",
                "position",
                "is_customized",
                "substitutions",
                "original_block_id"
              ],
              "additionalProperties": false
            }
          },
          "signature_workflow": {
            "type": "array"
          }
        },
        "required": [
          "id",
          "title",
          "description",
          "is_active",
          "should_be_signed",
          "is_processing",
          "template",
          "storage_field",
          "blocks"
        ]
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number"
            },
            "count": {
              "type": "number"
            },
            "per_page": {
              "type": "number"
            },
            "current_page": {
              "type": "number"
            },
            "total_pages": {
              "type": "number"
            },
            "links": {
              "type": "object",
              "properties": {
                "previous": {
                  "type": "string"
                },
                "next": {
                  "type": "string"
                }
              },
              "required": [
                "previous",
                "next"
              ]
            }
          },
          "required": [
            "total",
            "count",
            "per_page",
            "current_page",
            "total_pages",
            "links"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "pagination"
      ]
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/document-generators/{id}

Fetch single document generator

Example URI

GET https://rest.monportailrh.com/document-generators/query
URI Parameters
HideShow
id
number (required) Example: query

Id of the Document Generator.

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: '*'
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 0,
    "title": "document generator name",
    "description": "document generator description",
    "is_active": true,
    "status": "new",
    "should_be_signed": false,
    "is_processing": false,
    "excluded_block_ids": [
      "block001",
      "block002"
    ],
    "signature_expiration_date": "2019",
    "effective_date": "2019",
    "pso_type": {
      "id": 56,
      "name": "User",
      "alias": "usr",
      "description": "...",
      "is_active": true,
      "system_required": true,
      "creation_form_instance_id": 1,
      "profile_form_instance_id": 1
    },
    "template": {
      "title": "document template name",
      "description": "document template description",
      "is_active": true,
      "pso_type": {
        "id": 56,
        "name": "User",
        "alias": "usr",
        "description": "...",
        "is_active": true,
        "system_required": true,
        "creation_form_instance_id": 1,
        "profile_form_instance_id": 1
      },
      "blocks": [
        {
          "id": "block001",
          "content": "Some stuff with <b>html</b>",
          "conditions": [
            {
              "field": "employment_contract_type",
              "comparison": "=",
              "value": "internship"
            }
          ],
          "type": "common",
          "position": 1,
          "is_customized": false,
          "substitutions": [
            "Variables, that used in template"
          ],
          "original_block_id": "redefined block"
        }
      ]
    },
    "target_population": [
      {
        "type": "all",
        "details": {
          "dynamic": true,
          "includes": [
            "group_a"
          ],
          "excludes": [
            "group_b",
            "group_c"
          ]
        }
      }
    ],
    "storage_field": "alias of field",
    "blocks": [
      {
        "id": "block001",
        "content": "Some stuff with <b>html</b>",
        "conditions": [
          {
            "field": "employment_contract_type",
            "comparison": "=",
            "value": "internship"
          }
        ],
        "type": "common",
        "position": 1,
        "is_customized": false,
        "substitutions": [
          "Variables, that used in template"
        ],
        "original_block_id": "redefined block"
      }
    ],
    "signature_workflow": [
      {
        "entity_id": 0,
        "title": "Self",
        "type": "relation",
        "step": 1
      },
      {
        "entity_id": 123,
        "title": "John Snow",
        "type": "user",
        "step": 2
      }
    ]
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "title": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "is_active": {
          "type": "boolean"
        },
        "status": {
          "type": "string",
          "enum": [
            "new",
            "processing",
            "requires_signature",
            "signing_doc",
            "failed",
            "done"
          ]
        },
        "should_be_signed": {
          "type": "boolean"
        },
        "is_processing": {
          "type": "boolean"
        },
        "excluded_block_ids": {
          "type": "array"
        },
        "signature_expiration_date": {
          "type": "string",
          "description": "01-01 (date)"
        },
        "effective_date": {
          "type": "string",
          "description": "01-01 (date)"
        },
        "pso_type": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "name": {
              "type": "string"
            },
            "alias": {
              "type": "string"
            },
            "description": {
              "type": "string"
            },
            "is_active": {
              "type": "boolean"
            },
            "system_required": {
              "type": "boolean"
            },
            "creation_form_instance_id": {
              "type": "number"
            },
            "profile_form_instance_id": {
              "type": "number"
            }
          },
          "required": [
            "id",
            "name",
            "alias",
            "description",
            "is_active",
            "system_required",
            "creation_form_instance_id",
            "profile_form_instance_id"
          ],
          "additionalProperties": false
        },
        "template": {
          "type": "object",
          "properties": {
            "title": {
              "type": "string"
            },
            "description": {
              "type": "string"
            },
            "is_active": {
              "type": "boolean"
            },
            "pso_type": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number"
                },
                "name": {
                  "type": "string"
                },
                "alias": {
                  "type": "string"
                },
                "description": {
                  "type": "string"
                },
                "is_active": {
                  "type": "boolean"
                },
                "system_required": {
                  "type": "boolean"
                },
                "creation_form_instance_id": {
                  "type": "number"
                },
                "profile_form_instance_id": {
                  "type": "number"
                }
              },
              "required": [
                "id",
                "name",
                "alias",
                "description",
                "is_active",
                "system_required",
                "creation_form_instance_id",
                "profile_form_instance_id"
              ],
              "additionalProperties": false
            },
            "blocks": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string",
                    "enum": [
                      "block001"
                    ]
                  },
                  "content": {
                    "type": "string",
                    "enum": [
                      "Some stuff with <b>html</b>"
                    ]
                  },
                  "conditions": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "field": {
                          "type": "string",
                          "enum": [
                            "employment_contract_type"
                          ]
                        },
                        "comparison": {
                          "type": "string",
                          "enum": [
                            "="
                          ]
                        },
                        "value": {
                          "type": "string",
                          "enum": [
                            "internship"
                          ]
                        }
                      },
                      "required": [
                        "field",
                        "comparison",
                        "value"
                      ],
                      "additionalProperties": false
                    }
                  },
                  "type": {
                    "type": "string",
                    "enum": [
                      "common",
                      "header",
                      "footer"
                    ]
                  },
                  "position": {
                    "type": "number",
                    "enum": [
                      1
                    ]
                  },
                  "is_customized": {
                    "type": "boolean",
                    "enum": [
                      false
                    ]
                  },
                  "substitutions": {
                    "type": "array",
                    "items": {
                      "type": "string",
                      "enum": [
                        "Variables, that used in template"
                      ]
                    }
                  },
                  "original_block_id": {
                    "type": "string",
                    "enum": [
                      "redefined block"
                    ]
                  }
                },
                "required": [
                  "id",
                  "content",
                  "conditions",
                  "type",
                  "position",
                  "is_customized",
                  "substitutions",
                  "original_block_id"
                ],
                "additionalProperties": false
              }
            }
          },
          "required": [
            "title",
            "description",
            "is_active",
            "pso_type",
            "blocks"
          ]
        },
        "target_population": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "type": {
                "type": "string",
                "enum": [
                  "all",
                  "group",
                  "pso",
                  "relation",
                  "self"
                ]
              },
              "details": {
                "anyOf": [
                  {
                    "type": "object",
                    "properties": {
                      "dynamic": {
                        "type": "boolean"
                      },
                      "includes": {
                        "type": "array"
                      },
                      "excludes": {
                        "type": "array"
                      }
                    },
                    "required": [
                      "dynamic",
                      "includes",
                      "excludes"
                    ]
                  },
                  {
                    "type": "array",
                    "enum": [
                      [],
                      []
                    ]
                  }
                ],
                "type": "null"
              }
            },
            "required": [
              "type",
              "details"
            ]
          }
        },
        "storage_field": {
          "type": "string"
        },
        "blocks": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "enum": [
                  "block001"
                ]
              },
              "content": {
                "type": "string",
                "enum": [
                  "Some stuff with <b>html</b>"
                ]
              },
              "conditions": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "field": {
                      "type": "string",
                      "enum": [
                        "employment_contract_type"
                      ]
                    },
                    "comparison": {
                      "type": "string",
                      "enum": [
                        "="
                      ]
                    },
                    "value": {
                      "type": "string",
                      "enum": [
                        "internship"
                      ]
                    }
                  },
                  "required": [
                    "field",
                    "comparison",
                    "value"
                  ],
                  "additionalProperties": false
                }
              },
              "type": {
                "type": "string",
                "enum": [
                  "common",
                  "header",
                  "footer"
                ]
              },
              "position": {
                "type": "number",
                "enum": [
                  1
                ]
              },
              "is_customized": {
                "type": "boolean",
                "enum": [
                  false
                ]
              },
              "substitutions": {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "Variables, that used in template"
                  ]
                }
              },
              "original_block_id": {
                "type": "string",
                "enum": [
                  "redefined block"
                ]
              }
            },
            "required": [
              "id",
              "content",
              "conditions",
              "type",
              "position",
              "is_customized",
              "substitutions",
              "original_block_id"
            ],
            "additionalProperties": false
          }
        },
        "signature_workflow": {
          "type": "array"
        }
      },
      "required": [
        "id",
        "title",
        "description",
        "is_active",
        "status",
        "should_be_signed",
        "is_processing",
        "signature_expiration_date",
        "effective_date",
        "pso_type",
        "template",
        "target_population",
        "storage_field",
        "blocks"
      ],
      "additionalProperties": false
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Create
POST/document-generators

Create Document Generator

Example URI

POST https://rest.monportailrh.com/document-generators
Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: '*'
Body
{
  "title": {
    "en": "Some text",
    "fr": "Du texte",
    "de": "Setwas Text",
    "es": "Algún texto"
  },
  "description": {
    "en": "Some text",
    "fr": "Du texte",
    "de": "Setwas Text",
    "es": "Algún texto"
  },
  "is_active": true,
  "should_be_signed": false,
  "storage_field": "alias of field",
  "target_population": [
    {
      "type": "group",
      "details": {
        "dynamic": false,
        "includes": [
          "group_a"
        ],
        "excludes": [
          "group_b",
          "group_c"
        ]
      }
    }
  ],
  "effective_date": "2019-01-01",
  "template_id": 0,
  "pso_type": {
    "id": 56,
    "name": "User",
    "alias": "usr",
    "description": "...",
    "is_active": true,
    "system_required": true,
    "creation_form_instance_id": 1,
    "profile_form_instance_id": 1
  },
  "signature_workflow": [
    {
      "entity_id": 0,
      "type": "relation",
      "step": 1
    }
  ],
  "blocks": [
    {
      "id": 0,
      "is_active": false,
      "is_customized": false,
      "original_block_id": 0,
      "content": "Some stuff with <b>html</b>",
      "substitutions": [
        "Variables, that used in template"
      ]
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "title": {
      "type": "object",
      "properties": {
        "en": {
          "type": "string"
        },
        "fr": {
          "type": "string"
        },
        "de": {
          "type": "string"
        },
        "es": {
          "type": "string"
        }
      },
      "required": [
        "en",
        "fr",
        "de",
        "es"
      ]
    },
    "description": {
      "type": "object",
      "properties": {
        "en": {
          "type": "string"
        },
        "fr": {
          "type": "string"
        },
        "de": {
          "type": "string"
        },
        "es": {
          "type": "string"
        }
      },
      "required": [
        "en",
        "fr",
        "de",
        "es"
      ]
    },
    "is_active": {
      "type": "boolean"
    },
    "should_be_signed": {
      "type": "boolean"
    },
    "storage_field": {
      "type": "string"
    },
    "target_population": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "all",
              "group",
              "pso",
              "relation",
              "self"
            ]
          },
          "details": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "dynamic": {
                    "type": "boolean"
                  },
                  "includes": {
                    "type": "array"
                  },
                  "excludes": {
                    "type": "array"
                  }
                },
                "required": [
                  "dynamic",
                  "includes",
                  "excludes"
                ]
              },
              {
                "type": "array",
                "enum": [
                  [],
                  []
                ]
              }
            ],
            "type": "null"
          }
        },
        "required": [
          "type",
          "details"
        ]
      }
    },
    "effective_date": {
      "type": "string"
    },
    "template_id": {
      "type": "number"
    },
    "pso_type": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        },
        "alias": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "is_active": {
          "type": "boolean"
        },
        "system_required": {
          "type": "boolean"
        },
        "creation_form_instance_id": {
          "type": "number"
        },
        "profile_form_instance_id": {
          "type": "number"
        }
      },
      "required": [
        "id",
        "name",
        "alias",
        "description",
        "is_active",
        "system_required",
        "creation_form_instance_id",
        "profile_form_instance_id"
      ],
      "additionalProperties": false
    },
    "signature_workflow": {
      "type": "array"
    },
    "blocks": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "enum": [
              0
            ]
          },
          "is_active": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "is_customized": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "original_block_id": {
            "type": "number",
            "enum": [
              0
            ]
          },
          "content": {
            "type": "string",
            "enum": [
              "Some stuff with <b>html</b>"
            ]
          },
          "substitutions": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "Variables, that used in template"
              ]
            }
          }
        },
        "required": [
          "id",
          "is_active",
          "is_customized",
          "original_block_id",
          "content",
          "substitutions"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "title",
    "description",
    "is_active",
    "should_be_signed",
    "storage_field",
    "template_id",
    "signature_workflow",
    "blocks"
  ]
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 0,
    "title": "document generator name",
    "description": "document generator description",
    "is_active": true,
    "status": "new",
    "should_be_signed": false,
    "is_processing": false,
    "excluded_block_ids": [
      "block001",
      "block002"
    ],
    "signature_expiration_date": "2019",
    "effective_date": "2019",
    "pso_type": {
      "id": 56,
      "name": "User",
      "alias": "usr",
      "description": "...",
      "is_active": true,
      "system_required": true,
      "creation_form_instance_id": 1,
      "profile_form_instance_id": 1
    },
    "template": {
      "title": "document template name",
      "description": "document template description",
      "is_active": true,
      "pso_type": {
        "id": 56,
        "name": "User",
        "alias": "usr",
        "description": "...",
        "is_active": true,
        "system_required": true,
        "creation_form_instance_id": 1,
        "profile_form_instance_id": 1
      },
      "blocks": [
        {
          "id": "block001",
          "content": "Some stuff with <b>html</b>",
          "conditions": [
            {
              "field": "employment_contract_type",
              "comparison": "=",
              "value": "internship"
            }
          ],
          "type": "common",
          "position": 1,
          "is_customized": false,
          "substitutions": [
            "Variables, that used in template"
          ],
          "original_block_id": "redefined block"
        }
      ]
    },
    "target_population": [
      {
        "type": "all",
        "details": {
          "dynamic": true,
          "includes": [
            "group_a"
          ],
          "excludes": [
            "group_b",
            "group_c"
          ]
        }
      }
    ],
    "storage_field": "alias of field",
    "blocks": [
      {
        "id": "block001",
        "content": "Some stuff with <b>html</b>",
        "conditions": [
          {
            "field": "employment_contract_type",
            "comparison": "=",
            "value": "internship"
          }
        ],
        "type": "common",
        "position": 1,
        "is_customized": false,
        "substitutions": [
          "Variables, that used in template"
        ],
        "original_block_id": "redefined block"
      }
    ],
    "signature_workflow": [
      {
        "entity_id": 0,
        "title": "Self",
        "type": "relation",
        "step": 1
      },
      {
        "entity_id": 123,
        "title": "John Snow",
        "type": "user",
        "step": 2
      }
    ]
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "title": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "is_active": {
          "type": "boolean"
        },
        "status": {
          "type": "string",
          "enum": [
            "new",
            "processing",
            "requires_signature",
            "signing_doc",
            "failed",
            "done"
          ]
        },
        "should_be_signed": {
          "type": "boolean"
        },
        "is_processing": {
          "type": "boolean"
        },
        "excluded_block_ids": {
          "type": "array"
        },
        "signature_expiration_date": {
          "type": "string",
          "description": "01-01 (date)"
        },
        "effective_date": {
          "type": "string",
          "description": "01-01 (date)"
        },
        "pso_type": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "name": {
              "type": "string"
            },
            "alias": {
              "type": "string"
            },
            "description": {
              "type": "string"
            },
            "is_active": {
              "type": "boolean"
            },
            "system_required": {
              "type": "boolean"
            },
            "creation_form_instance_id": {
              "type": "number"
            },
            "profile_form_instance_id": {
              "type": "number"
            }
          },
          "required": [
            "id",
            "name",
            "alias",
            "description",
            "is_active",
            "system_required",
            "creation_form_instance_id",
            "profile_form_instance_id"
          ],
          "additionalProperties": false
        },
        "template": {
          "type": "object",
          "properties": {
            "title": {
              "type": "string"
            },
            "description": {
              "type": "string"
            },
            "is_active": {
              "type": "boolean"
            },
            "pso_type": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number"
                },
                "name": {
                  "type": "string"
                },
                "alias": {
                  "type": "string"
                },
                "description": {
                  "type": "string"
                },
                "is_active": {
                  "type": "boolean"
                },
                "system_required": {
                  "type": "boolean"
                },
                "creation_form_instance_id": {
                  "type": "number"
                },
                "profile_form_instance_id": {
                  "type": "number"
                }
              },
              "required": [
                "id",
                "name",
                "alias",
                "description",
                "is_active",
                "system_required",
                "creation_form_instance_id",
                "profile_form_instance_id"
              ],
              "additionalProperties": false
            },
            "blocks": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string",
                    "enum": [
                      "block001"
                    ]
                  },
                  "content": {
                    "type": "string",
                    "enum": [
                      "Some stuff with <b>html</b>"
                    ]
                  },
                  "conditions": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "field": {
                          "type": "string",
                          "enum": [
                            "employment_contract_type"
                          ]
                        },
                        "comparison": {
                          "type": "string",
                          "enum": [
                            "="
                          ]
                        },
                        "value": {
                          "type": "string",
                          "enum": [
                            "internship"
                          ]
                        }
                      },
                      "required": [
                        "field",
                        "comparison",
                        "value"
                      ],
                      "additionalProperties": false
                    }
                  },
                  "type": {
                    "type": "string",
                    "enum": [
                      "common",
                      "header",
                      "footer"
                    ]
                  },
                  "position": {
                    "type": "number",
                    "enum": [
                      1
                    ]
                  },
                  "is_customized": {
                    "type": "boolean",
                    "enum": [
                      false
                    ]
                  },
                  "substitutions": {
                    "type": "array",
                    "items": {
                      "type": "string",
                      "enum": [
                        "Variables, that used in template"
                      ]
                    }
                  },
                  "original_block_id": {
                    "type": "string",
                    "enum": [
                      "redefined block"
                    ]
                  }
                },
                "required": [
                  "id",
                  "content",
                  "conditions",
                  "type",
                  "position",
                  "is_customized",
                  "substitutions",
                  "original_block_id"
                ],
                "additionalProperties": false
              }
            }
          },
          "required": [
            "title",
            "description",
            "is_active",
            "pso_type",
            "blocks"
          ]
        },
        "target_population": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "type": {
                "type": "string",
                "enum": [
                  "all",
                  "group",
                  "pso",
                  "relation",
                  "self"
                ]
              },
              "details": {
                "anyOf": [
                  {
                    "type": "object",
                    "properties": {
                      "dynamic": {
                        "type": "boolean"
                      },
                      "includes": {
                        "type": "array"
                      },
                      "excludes": {
                        "type": "array"
                      }
                    },
                    "required": [
                      "dynamic",
                      "includes",
                      "excludes"
                    ]
                  },
                  {
                    "type": "array",
                    "enum": [
                      [],
                      []
                    ]
                  }
                ],
                "type": "null"
              }
            },
            "required": [
              "type",
              "details"
            ]
          }
        },
        "storage_field": {
          "type": "string"
        },
        "blocks": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "enum": [
                  "block001"
                ]
              },
              "content": {
                "type": "string",
                "enum": [
                  "Some stuff with <b>html</b>"
                ]
              },
              "conditions": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "field": {
                      "type": "string",
                      "enum": [
                        "employment_contract_type"
                      ]
                    },
                    "comparison": {
                      "type": "string",
                      "enum": [
                        "="
                      ]
                    },
                    "value": {
                      "type": "string",
                      "enum": [
                        "internship"
                      ]
                    }
                  },
                  "required": [
                    "field",
                    "comparison",
                    "value"
                  ],
                  "additionalProperties": false
                }
              },
              "type": {
                "type": "string",
                "enum": [
                  "common",
                  "header",
                  "footer"
                ]
              },
              "position": {
                "type": "number",
                "enum": [
                  1
                ]
              },
              "is_customized": {
                "type": "boolean",
                "enum": [
                  false
                ]
              },
              "substitutions": {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "Variables, that used in template"
                  ]
                }
              },
              "original_block_id": {
                "type": "string",
                "enum": [
                  "redefined block"
                ]
              }
            },
            "required": [
              "id",
              "content",
              "conditions",
              "type",
              "position",
              "is_customized",
              "substitutions",
              "original_block_id"
            ],
            "additionalProperties": false
          }
        },
        "signature_workflow": {
          "type": "array"
        }
      },
      "required": [
        "id",
        "title",
        "description",
        "is_active",
        "status",
        "should_be_signed",
        "is_processing",
        "signature_expiration_date",
        "effective_date",
        "pso_type",
        "template",
        "target_population",
        "storage_field",
        "blocks"
      ],
      "additionalProperties": false
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 400
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/document-generators/{id}

Update Document Generator

Example URI

PATCH https://rest.monportailrh.com/document-generators/123
URI Parameters
HideShow
id
number (required) Example: 123

Id of the Document Generator.

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Body
{
  "title": {
    "en": "Some text",
    "fr": "Du texte",
    "de": "Setwas Text",
    "es": "Algún texto"
  },
  "description": {
    "en": "Some text",
    "fr": "Du texte",
    "de": "Setwas Text",
    "es": "Algún texto"
  },
  "is_active": true,
  "should_be_signed": false,
  "storage_field": "alias of field",
  "target_population": [
    {
      "type": "group",
      "details": {
        "dynamic": false,
        "includes": [
          "group_a"
        ],
        "excludes": [
          "group_b",
          "group_c"
        ]
      }
    }
  ],
  "effective_date": "2019-01-01",
  "template_id": 0,
  "signature_workflow": [
    {
      "entity_id": 0,
      "type": "relation",
      "step": 1
    }
  ],
  "blocks": [
    {
      "id": 0,
      "is_active": false,
      "is_customized": false,
      "original_block_id": 0,
      "content": "Some stuff with <b>html</b>",
      "substitutions": [
        "Variables, that used in template"
      ]
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "title": {
      "type": "object",
      "properties": {
        "en": {
          "type": "string"
        },
        "fr": {
          "type": "string"
        },
        "de": {
          "type": "string"
        },
        "es": {
          "type": "string"
        }
      },
      "required": [
        "en",
        "fr",
        "de",
        "es"
      ]
    },
    "description": {
      "type": "object",
      "properties": {
        "en": {
          "type": "string"
        },
        "fr": {
          "type": "string"
        },
        "de": {
          "type": "string"
        },
        "es": {
          "type": "string"
        }
      },
      "required": [
        "en",
        "fr",
        "de",
        "es"
      ]
    },
    "is_active": {
      "type": "boolean"
    },
    "should_be_signed": {
      "type": "boolean"
    },
    "storage_field": {
      "type": "string"
    },
    "target_population": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "all",
              "group",
              "pso",
              "relation",
              "self"
            ]
          },
          "details": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "dynamic": {
                    "type": "boolean"
                  },
                  "includes": {
                    "type": "array"
                  },
                  "excludes": {
                    "type": "array"
                  }
                },
                "required": [
                  "dynamic",
                  "includes",
                  "excludes"
                ]
              },
              {
                "type": "array",
                "enum": [
                  [],
                  []
                ]
              }
            ],
            "type": "null"
          }
        },
        "required": [
          "type",
          "details"
        ]
      }
    },
    "effective_date": {
      "type": "string"
    },
    "template_id": {
      "type": "number"
    },
    "signature_workflow": {
      "type": "array"
    },
    "blocks": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "enum": [
              0
            ]
          },
          "is_active": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "is_customized": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "original_block_id": {
            "type": "number",
            "enum": [
              0
            ]
          },
          "content": {
            "type": "string",
            "enum": [
              "Some stuff with <b>html</b>"
            ]
          },
          "substitutions": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "Variables, that used in template"
              ]
            }
          }
        },
        "required": [
          "id",
          "is_active",
          "is_customized",
          "original_block_id",
          "content",
          "substitutions"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "title",
    "description",
    "is_active",
    "should_be_signed",
    "storage_field",
    "template_id",
    "signature_workflow",
    "blocks"
  ]
}
Response  202
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 0,
    "title": "document generator name",
    "description": "document generator description",
    "is_active": true,
    "status": "new",
    "should_be_signed": false,
    "is_processing": false,
    "excluded_block_ids": [
      "block001",
      "block002"
    ],
    "signature_expiration_date": "2019",
    "effective_date": "2019",
    "pso_type": {
      "id": 56,
      "name": "User",
      "alias": "usr",
      "description": "...",
      "is_active": true,
      "system_required": true,
      "creation_form_instance_id": 1,
      "profile_form_instance_id": 1
    },
    "template": {
      "title": "document template name",
      "description": "document template description",
      "is_active": true,
      "pso_type": {
        "id": 56,
        "name": "User",
        "alias": "usr",
        "description": "...",
        "is_active": true,
        "system_required": true,
        "creation_form_instance_id": 1,
        "profile_form_instance_id": 1
      },
      "blocks": [
        {
          "id": "block001",
          "content": "Some stuff with <b>html</b>",
          "conditions": [
            {
              "field": "employment_contract_type",
              "comparison": "=",
              "value": "internship"
            }
          ],
          "type": "common",
          "position": 1,
          "is_customized": false,
          "substitutions": [
            "Variables, that used in template"
          ],
          "original_block_id": "redefined block"
        }
      ]
    },
    "target_population": [
      {
        "type": "all",
        "details": {
          "dynamic": true,
          "includes": [
            "group_a"
          ],
          "excludes": [
            "group_b",
            "group_c"
          ]
        }
      }
    ],
    "storage_field": "alias of field",
    "blocks": [
      {
        "id": "block001",
        "content": "Some stuff with <b>html</b>",
        "conditions": [
          {
            "field": "employment_contract_type",
            "comparison": "=",
            "value": "internship"
          }
        ],
        "type": "common",
        "position": 1,
        "is_customized": false,
        "substitutions": [
          "Variables, that used in template"
        ],
        "original_block_id": "redefined block"
      }
    ],
    "signature_workflow": [
      {
        "entity_id": 0,
        "title": "Self",
        "type": "relation",
        "step": 1
      },
      {
        "entity_id": 123,
        "title": "John Snow",
        "type": "user",
        "step": 2
      }
    ]
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "title": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "is_active": {
          "type": "boolean"
        },
        "status": {
          "type": "string",
          "enum": [
            "new",
            "processing",
            "requires_signature",
            "signing_doc",
            "failed",
            "done"
          ]
        },
        "should_be_signed": {
          "type": "boolean"
        },
        "is_processing": {
          "type": "boolean"
        },
        "excluded_block_ids": {
          "type": "array"
        },
        "signature_expiration_date": {
          "type": "string",
          "description": "01-01 (date)"
        },
        "effective_date": {
          "type": "string",
          "description": "01-01 (date)"
        },
        "pso_type": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "name": {
              "type": "string"
            },
            "alias": {
              "type": "string"
            },
            "description": {
              "type": "string"
            },
            "is_active": {
              "type": "boolean"
            },
            "system_required": {
              "type": "boolean"
            },
            "creation_form_instance_id": {
              "type": "number"
            },
            "profile_form_instance_id": {
              "type": "number"
            }
          },
          "required": [
            "id",
            "name",
            "alias",
            "description",
            "is_active",
            "system_required",
            "creation_form_instance_id",
            "profile_form_instance_id"
          ],
          "additionalProperties": false
        },
        "template": {
          "type": "object",
          "properties": {
            "title": {
              "type": "string"
            },
            "description": {
              "type": "string"
            },
            "is_active": {
              "type": "boolean"
            },
            "pso_type": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number"
                },
                "name": {
                  "type": "string"
                },
                "alias": {
                  "type": "string"
                },
                "description": {
                  "type": "string"
                },
                "is_active": {
                  "type": "boolean"
                },
                "system_required": {
                  "type": "boolean"
                },
                "creation_form_instance_id": {
                  "type": "number"
                },
                "profile_form_instance_id": {
                  "type": "number"
                }
              },
              "required": [
                "id",
                "name",
                "alias",
                "description",
                "is_active",
                "system_required",
                "creation_form_instance_id",
                "profile_form_instance_id"
              ],
              "additionalProperties": false
            },
            "blocks": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string",
                    "enum": [
                      "block001"
                    ]
                  },
                  "content": {
                    "type": "string",
                    "enum": [
                      "Some stuff with <b>html</b>"
                    ]
                  },
                  "conditions": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "field": {
                          "type": "string",
                          "enum": [
                            "employment_contract_type"
                          ]
                        },
                        "comparison": {
                          "type": "string",
                          "enum": [
                            "="
                          ]
                        },
                        "value": {
                          "type": "string",
                          "enum": [
                            "internship"
                          ]
                        }
                      },
                      "required": [
                        "field",
                        "comparison",
                        "value"
                      ],
                      "additionalProperties": false
                    }
                  },
                  "type": {
                    "type": "string",
                    "enum": [
                      "common",
                      "header",
                      "footer"
                    ]
                  },
                  "position": {
                    "type": "number",
                    "enum": [
                      1
                    ]
                  },
                  "is_customized": {
                    "type": "boolean",
                    "enum": [
                      false
                    ]
                  },
                  "substitutions": {
                    "type": "array",
                    "items": {
                      "type": "string",
                      "enum": [
                        "Variables, that used in template"
                      ]
                    }
                  },
                  "original_block_id": {
                    "type": "string",
                    "enum": [
                      "redefined block"
                    ]
                  }
                },
                "required": [
                  "id",
                  "content",
                  "conditions",
                  "type",
                  "position",
                  "is_customized",
                  "substitutions",
                  "original_block_id"
                ],
                "additionalProperties": false
              }
            }
          },
          "required": [
            "title",
            "description",
            "is_active",
            "pso_type",
            "blocks"
          ]
        },
        "target_population": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "type": {
                "type": "string",
                "enum": [
                  "all",
                  "group",
                  "pso",
                  "relation",
                  "self"
                ]
              },
              "details": {
                "anyOf": [
                  {
                    "type": "object",
                    "properties": {
                      "dynamic": {
                        "type": "boolean"
                      },
                      "includes": {
                        "type": "array"
                      },
                      "excludes": {
                        "type": "array"
                      }
                    },
                    "required": [
                      "dynamic",
                      "includes",
                      "excludes"
                    ]
                  },
                  {
                    "type": "array",
                    "enum": [
                      [],
                      []
                    ]
                  }
                ],
                "type": "null"
              }
            },
            "required": [
              "type",
              "details"
            ]
          }
        },
        "storage_field": {
          "type": "string"
        },
        "blocks": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "enum": [
                  "block001"
                ]
              },
              "content": {
                "type": "string",
                "enum": [
                  "Some stuff with <b>html</b>"
                ]
              },
              "conditions": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "field": {
                      "type": "string",
                      "enum": [
                        "employment_contract_type"
                      ]
                    },
                    "comparison": {
                      "type": "string",
                      "enum": [
                        "="
                      ]
                    },
                    "value": {
                      "type": "string",
                      "enum": [
                        "internship"
                      ]
                    }
                  },
                  "required": [
                    "field",
                    "comparison",
                    "value"
                  ],
                  "additionalProperties": false
                }
              },
              "type": {
                "type": "string",
                "enum": [
                  "common",
                  "header",
                  "footer"
                ]
              },
              "position": {
                "type": "number",
                "enum": [
                  1
                ]
              },
              "is_customized": {
                "type": "boolean",
                "enum": [
                  false
                ]
              },
              "substitutions": {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "Variables, that used in template"
                  ]
                }
              },
              "original_block_id": {
                "type": "string",
                "enum": [
                  "redefined block"
                ]
              }
            },
            "required": [
              "id",
              "content",
              "conditions",
              "type",
              "position",
              "is_customized",
              "substitutions",
              "original_block_id"
            ],
            "additionalProperties": false
          }
        },
        "signature_workflow": {
          "type": "array"
        }
      },
      "required": [
        "id",
        "title",
        "description",
        "is_active",
        "status",
        "should_be_signed",
        "is_processing",
        "signature_expiration_date",
        "effective_date",
        "pso_type",
        "template",
        "target_population",
        "storage_field",
        "blocks"
      ],
      "additionalProperties": false
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 400
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete
DELETE/document-generators/{id}

Delete Document Generator

Example URI

DELETE https://rest.monportailrh.com/document-generators/123
URI Parameters
HideShow
id
number (required) Example: 123

Id of the Document Generator

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: '*'
Response  204
HideShow
Headers
Content-Type: application/json
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Generate
POST/document-generators/{id}/generate

Generate document from Document Generator

Example URI

POST https://rest.monportailrh.com/document-generators/123/generate
URI Parameters
HideShow
id
number (required) Example: 123

Id of the Document Generator.

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: '*'
Response  202
HideShow
Headers
Content-Type: application/json
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 400
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Copy
POST/document-generators/{id}/copy

Copy Document Generator

Example URI

POST https://rest.monportailrh.com/document-generators/123/copy
URI Parameters
HideShow
id
number (required) Example: 123

Id of the Document Generator.

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Body
{
  "title": {
    "en": "Some text",
    "fr": "Du texte",
    "de": "Setwas Text",
    "es": "Algún texto"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "title": {
      "type": "object",
      "properties": {
        "en": {
          "type": "string"
        },
        "fr": {
          "type": "string"
        },
        "de": {
          "type": "string"
        },
        "es": {
          "type": "string"
        }
      },
      "required": [
        "en",
        "fr",
        "de",
        "es"
      ]
    }
  }
}
Response  202
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 0,
    "title": "document generator name",
    "description": "document generator description",
    "is_active": true,
    "status": "new",
    "should_be_signed": false,
    "is_processing": false,
    "excluded_block_ids": [
      "block001",
      "block002"
    ],
    "signature_expiration_date": "2019",
    "effective_date": "2019",
    "pso_type": {
      "id": 56,
      "name": "User",
      "alias": "usr",
      "description": "...",
      "is_active": true,
      "system_required": true,
      "creation_form_instance_id": 1,
      "profile_form_instance_id": 1
    },
    "template": {
      "title": "document template name",
      "description": "document template description",
      "is_active": true,
      "pso_type": {
        "id": 56,
        "name": "User",
        "alias": "usr",
        "description": "...",
        "is_active": true,
        "system_required": true,
        "creation_form_instance_id": 1,
        "profile_form_instance_id": 1
      },
      "blocks": [
        {
          "id": "block001",
          "content": "Some stuff with <b>html</b>",
          "conditions": [
            {
              "field": "employment_contract_type",
              "comparison": "=",
              "value": "internship"
            }
          ],
          "type": "common",
          "position": 1,
          "is_customized": false,
          "substitutions": [
            "Variables, that used in template"
          ],
          "original_block_id": "redefined block"
        }
      ]
    },
    "target_population": [
      {
        "type": "all",
        "details": {
          "dynamic": true,
          "includes": [
            "group_a"
          ],
          "excludes": [
            "group_b",
            "group_c"
          ]
        }
      }
    ],
    "storage_field": "alias of field",
    "blocks": [
      {
        "id": "block001",
        "content": "Some stuff with <b>html</b>",
        "conditions": [
          {
            "field": "employment_contract_type",
            "comparison": "=",
            "value": "internship"
          }
        ],
        "type": "common",
        "position": 1,
        "is_customized": false,
        "substitutions": [
          "Variables, that used in template"
        ],
        "original_block_id": "redefined block"
      }
    ],
    "signature_workflow": [
      {
        "entity_id": 0,
        "title": "Self",
        "type": "relation",
        "step": 1
      },
      {
        "entity_id": 123,
        "title": "John Snow",
        "type": "user",
        "step": 2
      }
    ]
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "title": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "is_active": {
          "type": "boolean"
        },
        "status": {
          "type": "string",
          "enum": [
            "new",
            "processing",
            "requires_signature",
            "signing_doc",
            "failed",
            "done"
          ]
        },
        "should_be_signed": {
          "type": "boolean"
        },
        "is_processing": {
          "type": "boolean"
        },
        "excluded_block_ids": {
          "type": "array"
        },
        "signature_expiration_date": {
          "type": "string",
          "description": "01-01 (date)"
        },
        "effective_date": {
          "type": "string",
          "description": "01-01 (date)"
        },
        "pso_type": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "name": {
              "type": "string"
            },
            "alias": {
              "type": "string"
            },
            "description": {
              "type": "string"
            },
            "is_active": {
              "type": "boolean"
            },
            "system_required": {
              "type": "boolean"
            },
            "creation_form_instance_id": {
              "type": "number"
            },
            "profile_form_instance_id": {
              "type": "number"
            }
          },
          "required": [
            "id",
            "name",
            "alias",
            "description",
            "is_active",
            "system_required",
            "creation_form_instance_id",
            "profile_form_instance_id"
          ],
          "additionalProperties": false
        },
        "template": {
          "type": "object",
          "properties": {
            "title": {
              "type": "string"
            },
            "description": {
              "type": "string"
            },
            "is_active": {
              "type": "boolean"
            },
            "pso_type": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number"
                },
                "name": {
                  "type": "string"
                },
                "alias": {
                  "type": "string"
                },
                "description": {
                  "type": "string"
                },
                "is_active": {
                  "type": "boolean"
                },
                "system_required": {
                  "type": "boolean"
                },
                "creation_form_instance_id": {
                  "type": "number"
                },
                "profile_form_instance_id": {
                  "type": "number"
                }
              },
              "required": [
                "id",
                "name",
                "alias",
                "description",
                "is_active",
                "system_required",
                "creation_form_instance_id",
                "profile_form_instance_id"
              ],
              "additionalProperties": false
            },
            "blocks": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string",
                    "enum": [
                      "block001"
                    ]
                  },
                  "content": {
                    "type": "string",
                    "enum": [
                      "Some stuff with <b>html</b>"
                    ]
                  },
                  "conditions": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "field": {
                          "type": "string",
                          "enum": [
                            "employment_contract_type"
                          ]
                        },
                        "comparison": {
                          "type": "string",
                          "enum": [
                            "="
                          ]
                        },
                        "value": {
                          "type": "string",
                          "enum": [
                            "internship"
                          ]
                        }
                      },
                      "required": [
                        "field",
                        "comparison",
                        "value"
                      ],
                      "additionalProperties": false
                    }
                  },
                  "type": {
                    "type": "string",
                    "enum": [
                      "common",
                      "header",
                      "footer"
                    ]
                  },
                  "position": {
                    "type": "number",
                    "enum": [
                      1
                    ]
                  },
                  "is_customized": {
                    "type": "boolean",
                    "enum": [
                      false
                    ]
                  },
                  "substitutions": {
                    "type": "array",
                    "items": {
                      "type": "string",
                      "enum": [
                        "Variables, that used in template"
                      ]
                    }
                  },
                  "original_block_id": {
                    "type": "string",
                    "enum": [
                      "redefined block"
                    ]
                  }
                },
                "required": [
                  "id",
                  "content",
                  "conditions",
                  "type",
                  "position",
                  "is_customized",
                  "substitutions",
                  "original_block_id"
                ],
                "additionalProperties": false
              }
            }
          },
          "required": [
            "title",
            "description",
            "is_active",
            "pso_type",
            "blocks"
          ]
        },
        "target_population": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "type": {
                "type": "string",
                "enum": [
                  "all",
                  "group",
                  "pso",
                  "relation",
                  "self"
                ]
              },
              "details": {
                "anyOf": [
                  {
                    "type": "object",
                    "properties": {
                      "dynamic": {
                        "type": "boolean"
                      },
                      "includes": {
                        "type": "array"
                      },
                      "excludes": {
                        "type": "array"
                      }
                    },
                    "required": [
                      "dynamic",
                      "includes",
                      "excludes"
                    ]
                  },
                  {
                    "type": "array",
                    "enum": [
                      [],
                      []
                    ]
                  }
                ],
                "type": "null"
              }
            },
            "required": [
              "type",
              "details"
            ]
          }
        },
        "storage_field": {
          "type": "string"
        },
        "blocks": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "enum": [
                  "block001"
                ]
              },
              "content": {
                "type": "string",
                "enum": [
                  "Some stuff with <b>html</b>"
                ]
              },
              "conditions": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "field": {
                      "type": "string",
                      "enum": [
                        "employment_contract_type"
                      ]
                    },
                    "comparison": {
                      "type": "string",
                      "enum": [
                        "="
                      ]
                    },
                    "value": {
                      "type": "string",
                      "enum": [
                        "internship"
                      ]
                    }
                  },
                  "required": [
                    "field",
                    "comparison",
                    "value"
                  ],
                  "additionalProperties": false
                }
              },
              "type": {
                "type": "string",
                "enum": [
                  "common",
                  "header",
                  "footer"
                ]
              },
              "position": {
                "type": "number",
                "enum": [
                  1
                ]
              },
              "is_customized": {
                "type": "boolean",
                "enum": [
                  false
                ]
              },
              "substitutions": {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "Variables, that used in template"
                  ]
                }
              },
              "original_block_id": {
                "type": "string",
                "enum": [
                  "redefined block"
                ]
              }
            },
            "required": [
              "id",
              "content",
              "conditions",
              "type",
              "position",
              "is_customized",
              "substitutions",
              "original_block_id"
            ],
            "additionalProperties": false
          }
        },
        "signature_workflow": {
          "type": "array"
        }
      },
      "required": [
        "id",
        "title",
        "description",
        "is_active",
        "status",
        "should_be_signed",
        "is_processing",
        "signature_expiration_date",
        "effective_date",
        "pso_type",
        "template",
        "target_population",
        "storage_field",
        "blocks"
      ],
      "additionalProperties": false
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 400
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Toggle active
PATCH/document-generators/{id}/toggle-active

Toggle active of the Document Generator

Example URI

PATCH https://rest.monportailrh.com/document-generators/123/toggle-active
URI Parameters
HideShow
id
number (required) Example: 123

Id of the Document Generator.

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Response  202
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 0,
    "title": "document generator name",
    "description": "document generator description",
    "is_active": true,
    "status": "new",
    "should_be_signed": false,
    "is_processing": false,
    "excluded_block_ids": [
      "block001",
      "block002"
    ],
    "signature_expiration_date": "2019",
    "effective_date": "2019",
    "pso_type": {
      "id": 56,
      "name": "User",
      "alias": "usr",
      "description": "...",
      "is_active": true,
      "system_required": true,
      "creation_form_instance_id": 1,
      "profile_form_instance_id": 1
    },
    "template": {
      "title": "document template name",
      "description": "document template description",
      "is_active": true,
      "pso_type": {
        "id": 56,
        "name": "User",
        "alias": "usr",
        "description": "...",
        "is_active": true,
        "system_required": true,
        "creation_form_instance_id": 1,
        "profile_form_instance_id": 1
      },
      "blocks": [
        {
          "id": "block001",
          "content": "Some stuff with <b>html</b>",
          "conditions": [
            {
              "field": "employment_contract_type",
              "comparison": "=",
              "value": "internship"
            }
          ],
          "type": "common",
          "position": 1,
          "is_customized": false,
          "substitutions": [
            "Variables, that used in template"
          ],
          "original_block_id": "redefined block"
        }
      ]
    },
    "target_population": [
      {
        "type": "all",
        "details": {
          "dynamic": true,
          "includes": [
            "group_a"
          ],
          "excludes": [
            "group_b",
            "group_c"
          ]
        }
      }
    ],
    "storage_field": "alias of field",
    "blocks": [
      {
        "id": "block001",
        "content": "Some stuff with <b>html</b>",
        "conditions": [
          {
            "field": "employment_contract_type",
            "comparison": "=",
            "value": "internship"
          }
        ],
        "type": "common",
        "position": 1,
        "is_customized": false,
        "substitutions": [
          "Variables, that used in template"
        ],
        "original_block_id": "redefined block"
      }
    ],
    "signature_workflow": [
      {
        "entity_id": 0,
        "title": "Self",
        "type": "relation",
        "step": 1
      },
      {
        "entity_id": 123,
        "title": "John Snow",
        "type": "user",
        "step": 2
      }
    ]
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "title": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "is_active": {
          "type": "boolean"
        },
        "status": {
          "type": "string",
          "enum": [
            "new",
            "processing",
            "requires_signature",
            "signing_doc",
            "failed",
            "done"
          ]
        },
        "should_be_signed": {
          "type": "boolean"
        },
        "is_processing": {
          "type": "boolean"
        },
        "excluded_block_ids": {
          "type": "array"
        },
        "signature_expiration_date": {
          "type": "string",
          "description": "01-01 (date)"
        },
        "effective_date": {
          "type": "string",
          "description": "01-01 (date)"
        },
        "pso_type": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "name": {
              "type": "string"
            },
            "alias": {
              "type": "string"
            },
            "description": {
              "type": "string"
            },
            "is_active": {
              "type": "boolean"
            },
            "system_required": {
              "type": "boolean"
            },
            "creation_form_instance_id": {
              "type": "number"
            },
            "profile_form_instance_id": {
              "type": "number"
            }
          },
          "required": [
            "id",
            "name",
            "alias",
            "description",
            "is_active",
            "system_required",
            "creation_form_instance_id",
            "profile_form_instance_id"
          ],
          "additionalProperties": false
        },
        "template": {
          "type": "object",
          "properties": {
            "title": {
              "type": "string"
            },
            "description": {
              "type": "string"
            },
            "is_active": {
              "type": "boolean"
            },
            "pso_type": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number"
                },
                "name": {
                  "type": "string"
                },
                "alias": {
                  "type": "string"
                },
                "description": {
                  "type": "string"
                },
                "is_active": {
                  "type": "boolean"
                },
                "system_required": {
                  "type": "boolean"
                },
                "creation_form_instance_id": {
                  "type": "number"
                },
                "profile_form_instance_id": {
                  "type": "number"
                }
              },
              "required": [
                "id",
                "name",
                "alias",
                "description",
                "is_active",
                "system_required",
                "creation_form_instance_id",
                "profile_form_instance_id"
              ],
              "additionalProperties": false
            },
            "blocks": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string",
                    "enum": [
                      "block001"
                    ]
                  },
                  "content": {
                    "type": "string",
                    "enum": [
                      "Some stuff with <b>html</b>"
                    ]
                  },
                  "conditions": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "field": {
                          "type": "string",
                          "enum": [
                            "employment_contract_type"
                          ]
                        },
                        "comparison": {
                          "type": "string",
                          "enum": [
                            "="
                          ]
                        },
                        "value": {
                          "type": "string",
                          "enum": [
                            "internship"
                          ]
                        }
                      },
                      "required": [
                        "field",
                        "comparison",
                        "value"
                      ],
                      "additionalProperties": false
                    }
                  },
                  "type": {
                    "type": "string",
                    "enum": [
                      "common",
                      "header",
                      "footer"
                    ]
                  },
                  "position": {
                    "type": "number",
                    "enum": [
                      1
                    ]
                  },
                  "is_customized": {
                    "type": "boolean",
                    "enum": [
                      false
                    ]
                  },
                  "substitutions": {
                    "type": "array",
                    "items": {
                      "type": "string",
                      "enum": [
                        "Variables, that used in template"
                      ]
                    }
                  },
                  "original_block_id": {
                    "type": "string",
                    "enum": [
                      "redefined block"
                    ]
                  }
                },
                "required": [
                  "id",
                  "content",
                  "conditions",
                  "type",
                  "position",
                  "is_customized",
                  "substitutions",
                  "original_block_id"
                ],
                "additionalProperties": false
              }
            }
          },
          "required": [
            "title",
            "description",
            "is_active",
            "pso_type",
            "blocks"
          ]
        },
        "target_population": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "type": {
                "type": "string",
                "enum": [
                  "all",
                  "group",
                  "pso",
                  "relation",
                  "self"
                ]
              },
              "details": {
                "anyOf": [
                  {
                    "type": "object",
                    "properties": {
                      "dynamic": {
                        "type": "boolean"
                      },
                      "includes": {
                        "type": "array"
                      },
                      "excludes": {
                        "type": "array"
                      }
                    },
                    "required": [
                      "dynamic",
                      "includes",
                      "excludes"
                    ]
                  },
                  {
                    "type": "array",
                    "enum": [
                      [],
                      []
                    ]
                  }
                ],
                "type": "null"
              }
            },
            "required": [
              "type",
              "details"
            ]
          }
        },
        "storage_field": {
          "type": "string"
        },
        "blocks": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "enum": [
                  "block001"
                ]
              },
              "content": {
                "type": "string",
                "enum": [
                  "Some stuff with <b>html</b>"
                ]
              },
              "conditions": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "field": {
                      "type": "string",
                      "enum": [
                        "employment_contract_type"
                      ]
                    },
                    "comparison": {
                      "type": "string",
                      "enum": [
                        "="
                      ]
                    },
                    "value": {
                      "type": "string",
                      "enum": [
                        "internship"
                      ]
                    }
                  },
                  "required": [
                    "field",
                    "comparison",
                    "value"
                  ],
                  "additionalProperties": false
                }
              },
              "type": {
                "type": "string",
                "enum": [
                  "common",
                  "header",
                  "footer"
                ]
              },
              "position": {
                "type": "number",
                "enum": [
                  1
                ]
              },
              "is_customized": {
                "type": "boolean",
                "enum": [
                  false
                ]
              },
              "substitutions": {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "Variables, that used in template"
                  ]
                }
              },
              "original_block_id": {
                "type": "string",
                "enum": [
                  "redefined block"
                ]
              }
            },
            "required": [
              "id",
              "content",
              "conditions",
              "type",
              "position",
              "is_customized",
              "substitutions",
              "original_block_id"
            ],
            "additionalProperties": false
          }
        },
        "signature_workflow": {
          "type": "array"
        }
      },
      "required": [
        "id",
        "title",
        "description",
        "is_active",
        "status",
        "should_be_signed",
        "is_processing",
        "signature_expiration_date",
        "effective_date",
        "pso_type",
        "template",
        "target_population",
        "storage_field",
        "blocks"
      ],
      "additionalProperties": false
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 400
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Document Templates

Document Templates used by document generators. It may include simple text or data from fields (field aliases wraped by bracers, ex: {usr_first_name})

Document Templates

Common List
GET/document-templates{?title,pso-type,active,sort-by,sort-direction,page,per-page,no-pagination}

Get list of document templates matches specified filters

Example URI

GET https://rest.monportailrh.com/document-templates?title=Document template name to search&pso-type=usr&active=true&sort-by=name&sort-direction=asc&page=1&per-page=10&no-pagination=false
URI Parameters
HideShow
title
string (optional) Example: Document template name to search

Search by title. Non strict, case-insensitive.

pso-type
string (optional) Example: usr

Pso Type trigram to filter document templates

active
boolean (optional) Example: true

Field for filter exports by is_active column

sort-by
name, created_at (required) Example: name
sort-direction
asc, desc (required) Example: asc
page
number (required) Example: 1

Page number. 1 by default

per-page
number (required) Example: 10

Number of items per page, 25 by default

no-pagination
boolean (required) Example: false

if presented and positive pagination will not be applied. All available items will be returned.

Note: it may have significant impact on the performance

Note: once this option positive and presented - meta attribute with pagination data will be omit in response

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "title": "document template name",
      "description": "document template description",
      "is_active": true,
      "pso_type": {
        "id": 56,
        "name": "User",
        "alias": "usr",
        "description": "...",
        "is_active": true,
        "system_required": true,
        "creation_form_instance_id": 1,
        "profile_form_instance_id": 1
      },
      "blocks": [
        {
          "id": "block001",
          "content": "Some stuff with <b>html</b>",
          "conditions": [
            {
              "field": "employment_contract_type",
              "comparison": "=",
              "value": "internship"
            }
          ],
          "type": "common",
          "position": 1,
          "is_customized": false,
          "substitutions": [
            "Variables, that used in template"
          ],
          "original_block_id": "redefined block"
        }
      ]
    }
  ],
  "meta": {
    "pagination": {
      "total": 238,
      "count": 25,
      "per_page": 25,
      "current_page": 2,
      "total_pages": 10,
      "links": {
        "previous": "http://example.com/api/<endpoint>?page=1",
        "next": "http://example.com/api/<endpoint>?page=3"
      }
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "title": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "is_active": {
            "type": "boolean"
          },
          "pso_type": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number"
              },
              "name": {
                "type": "string"
              },
              "alias": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "is_active": {
                "type": "boolean"
              },
              "system_required": {
                "type": "boolean"
              },
              "creation_form_instance_id": {
                "type": "number"
              },
              "profile_form_instance_id": {
                "type": "number"
              }
            },
            "required": [
              "id",
              "name",
              "alias",
              "description",
              "is_active",
              "system_required",
              "creation_form_instance_id",
              "profile_form_instance_id"
            ],
            "additionalProperties": false
          },
          "blocks": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "enum": [
                    "block001"
                  ]
                },
                "content": {
                  "type": "string",
                  "enum": [
                    "Some stuff with <b>html</b>"
                  ]
                },
                "conditions": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "field": {
                        "type": "string",
                        "enum": [
                          "employment_contract_type"
                        ]
                      },
                      "comparison": {
                        "type": "string",
                        "enum": [
                          "="
                        ]
                      },
                      "value": {
                        "type": "string",
                        "enum": [
                          "internship"
                        ]
                      }
                    },
                    "required": [
                      "field",
                      "comparison",
                      "value"
                    ],
                    "additionalProperties": false
                  }
                },
                "type": {
                  "type": "string",
                  "enum": [
                    "common",
                    "header",
                    "footer"
                  ]
                },
                "position": {
                  "type": "number",
                  "enum": [
                    1
                  ]
                },
                "is_customized": {
                  "type": "boolean",
                  "enum": [
                    false
                  ]
                },
                "substitutions": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "enum": [
                      "Variables, that used in template"
                    ]
                  }
                },
                "original_block_id": {
                  "type": "string",
                  "enum": [
                    "redefined block"
                  ]
                }
              },
              "required": [
                "id",
                "content",
                "conditions",
                "type",
                "position",
                "is_customized",
                "substitutions",
                "original_block_id"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "title",
          "description",
          "is_active",
          "pso_type",
          "blocks"
        ]
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number"
            },
            "count": {
              "type": "number"
            },
            "per_page": {
              "type": "number"
            },
            "current_page": {
              "type": "number"
            },
            "total_pages": {
              "type": "number"
            },
            "links": {
              "type": "object",
              "properties": {
                "previous": {
                  "type": "string"
                },
                "next": {
                  "type": "string"
                }
              },
              "required": [
                "previous",
                "next"
              ]
            }
          },
          "required": [
            "total",
            "count",
            "per_page",
            "current_page",
            "total_pages",
            "links"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "pagination"
      ]
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/document-templates/{id}

Fetch single document template

Example URI

GET https://rest.monportailrh.com/document-templates/query
URI Parameters
HideShow
id
number (required) Example: query

Id of the Document Template.

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: '*'
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "title": "document template name",
    "description": "document template description",
    "is_active": true,
    "pso_type": {
      "id": 56,
      "name": "User",
      "alias": "usr",
      "description": "...",
      "is_active": true,
      "system_required": true,
      "creation_form_instance_id": 1,
      "profile_form_instance_id": 1
    },
    "blocks": [
      {
        "id": "block001",
        "content": "Some stuff with <b>html</b>",
        "conditions": [
          {
            "field": "employment_contract_type",
            "comparison": "=",
            "value": "internship"
          }
        ],
        "type": "common",
        "position": 1,
        "is_customized": false,
        "substitutions": [
          "Variables, that used in template"
        ],
        "original_block_id": "redefined block"
      }
    ]
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "title": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "is_active": {
          "type": "boolean"
        },
        "pso_type": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "name": {
              "type": "string"
            },
            "alias": {
              "type": "string"
            },
            "description": {
              "type": "string"
            },
            "is_active": {
              "type": "boolean"
            },
            "system_required": {
              "type": "boolean"
            },
            "creation_form_instance_id": {
              "type": "number"
            },
            "profile_form_instance_id": {
              "type": "number"
            }
          },
          "required": [
            "id",
            "name",
            "alias",
            "description",
            "is_active",
            "system_required",
            "creation_form_instance_id",
            "profile_form_instance_id"
          ],
          "additionalProperties": false
        },
        "blocks": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "enum": [
                  "block001"
                ]
              },
              "content": {
                "type": "string",
                "enum": [
                  "Some stuff with <b>html</b>"
                ]
              },
              "conditions": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "field": {
                      "type": "string",
                      "enum": [
                        "employment_contract_type"
                      ]
                    },
                    "comparison": {
                      "type": "string",
                      "enum": [
                        "="
                      ]
                    },
                    "value": {
                      "type": "string",
                      "enum": [
                        "internship"
                      ]
                    }
                  },
                  "required": [
                    "field",
                    "comparison",
                    "value"
                  ],
                  "additionalProperties": false
                }
              },
              "type": {
                "type": "string",
                "enum": [
                  "common",
                  "header",
                  "footer"
                ]
              },
              "position": {
                "type": "number",
                "enum": [
                  1
                ]
              },
              "is_customized": {
                "type": "boolean",
                "enum": [
                  false
                ]
              },
              "substitutions": {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "Variables, that used in template"
                  ]
                }
              },
              "original_block_id": {
                "type": "string",
                "enum": [
                  "redefined block"
                ]
              }
            },
            "required": [
              "id",
              "content",
              "conditions",
              "type",
              "position",
              "is_customized",
              "substitutions",
              "original_block_id"
            ],
            "additionalProperties": false
          }
        }
      },
      "required": [
        "title",
        "description",
        "is_active",
        "pso_type",
        "blocks"
      ],
      "additionalProperties": false
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Create
POST/document-templates

Create Document Template

Example URI

POST https://rest.monportailrh.com/document-templates
Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: '*'
Body
{
  "title": {
    "en": "Some text",
    "fr": "Du texte",
    "de": "Setwas Text",
    "es": "Algún texto"
  },
  "description": {
    "en": "Some text",
    "fr": "Du texte",
    "de": "Setwas Text",
    "es": "Algún texto"
  },
  "is_active": true,
  "blocks": [
    {
      "id": "block001",
      "content": "Some stuff with <b>html</b>",
      "conditions": [
        {
          "field": "employment_contract_type",
          "comparison": "=",
          "value": "internship"
        }
      ],
      "type": "common",
      "position": 1,
      "is_customized": false,
      "substitutions": [
        "Variables, that used in template"
      ],
      "original_block_id": "redefined block"
    }
  ],
  "pso_type": {
    "id": 56,
    "name": "User",
    "alias": "usr",
    "description": "...",
    "is_active": true,
    "system_required": true,
    "creation_form_instance_id": 1,
    "profile_form_instance_id": 1
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "title": {
      "type": "object",
      "properties": {
        "en": {
          "type": "string"
        },
        "fr": {
          "type": "string"
        },
        "de": {
          "type": "string"
        },
        "es": {
          "type": "string"
        }
      },
      "required": [
        "en",
        "fr",
        "de",
        "es"
      ]
    },
    "description": {
      "type": "object",
      "properties": {
        "en": {
          "type": "string"
        },
        "fr": {
          "type": "string"
        },
        "de": {
          "type": "string"
        },
        "es": {
          "type": "string"
        }
      },
      "required": [
        "en",
        "fr",
        "de",
        "es"
      ]
    },
    "is_active": {
      "type": "boolean"
    },
    "blocks": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "enum": [
              "block001"
            ]
          },
          "content": {
            "type": "string",
            "enum": [
              "Some stuff with <b>html</b>"
            ]
          },
          "conditions": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "field": {
                  "type": "string",
                  "enum": [
                    "employment_contract_type"
                  ]
                },
                "comparison": {
                  "type": "string",
                  "enum": [
                    "="
                  ]
                },
                "value": {
                  "type": "string",
                  "enum": [
                    "internship"
                  ]
                }
              },
              "required": [
                "field",
                "comparison",
                "value"
              ],
              "additionalProperties": false
            }
          },
          "type": {
            "type": "string",
            "enum": [
              "common",
              "header",
              "footer"
            ]
          },
          "position": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "is_customized": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "substitutions": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "Variables, that used in template"
              ]
            }
          },
          "original_block_id": {
            "type": "string",
            "enum": [
              "redefined block"
            ]
          }
        },
        "required": [
          "id",
          "content",
          "conditions",
          "type",
          "position",
          "is_customized",
          "substitutions",
          "original_block_id"
        ],
        "additionalProperties": false
      }
    },
    "pso_type": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        },
        "alias": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "is_active": {
          "type": "boolean"
        },
        "system_required": {
          "type": "boolean"
        },
        "creation_form_instance_id": {
          "type": "number"
        },
        "profile_form_instance_id": {
          "type": "number"
        }
      },
      "required": [
        "id",
        "name",
        "alias",
        "description",
        "is_active",
        "system_required",
        "creation_form_instance_id",
        "profile_form_instance_id"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "title",
    "description",
    "is_active",
    "blocks",
    "pso_type"
  ]
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "title": "document template name",
    "description": "document template description",
    "is_active": true,
    "pso_type": {
      "id": 56,
      "name": "User",
      "alias": "usr",
      "description": "...",
      "is_active": true,
      "system_required": true,
      "creation_form_instance_id": 1,
      "profile_form_instance_id": 1
    },
    "blocks": [
      {
        "id": "block001",
        "content": "Some stuff with <b>html</b>",
        "conditions": [
          {
            "field": "employment_contract_type",
            "comparison": "=",
            "value": "internship"
          }
        ],
        "type": "common",
        "position": 1,
        "is_customized": false,
        "substitutions": [
          "Variables, that used in template"
        ],
        "original_block_id": "redefined block"
      }
    ]
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "title": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "is_active": {
          "type": "boolean"
        },
        "pso_type": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "name": {
              "type": "string"
            },
            "alias": {
              "type": "string"
            },
            "description": {
              "type": "string"
            },
            "is_active": {
              "type": "boolean"
            },
            "system_required": {
              "type": "boolean"
            },
            "creation_form_instance_id": {
              "type": "number"
            },
            "profile_form_instance_id": {
              "type": "number"
            }
          },
          "required": [
            "id",
            "name",
            "alias",
            "description",
            "is_active",
            "system_required",
            "creation_form_instance_id",
            "profile_form_instance_id"
          ],
          "additionalProperties": false
        },
        "blocks": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "enum": [
                  "block001"
                ]
              },
              "content": {
                "type": "string",
                "enum": [
                  "Some stuff with <b>html</b>"
                ]
              },
              "conditions": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "field": {
                      "type": "string",
                      "enum": [
                        "employment_contract_type"
                      ]
                    },
                    "comparison": {
                      "type": "string",
                      "enum": [
                        "="
                      ]
                    },
                    "value": {
                      "type": "string",
                      "enum": [
                        "internship"
                      ]
                    }
                  },
                  "required": [
                    "field",
                    "comparison",
                    "value"
                  ],
                  "additionalProperties": false
                }
              },
              "type": {
                "type": "string",
                "enum": [
                  "common",
                  "header",
                  "footer"
                ]
              },
              "position": {
                "type": "number",
                "enum": [
                  1
                ]
              },
              "is_customized": {
                "type": "boolean",
                "enum": [
                  false
                ]
              },
              "substitutions": {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "Variables, that used in template"
                  ]
                }
              },
              "original_block_id": {
                "type": "string",
                "enum": [
                  "redefined block"
                ]
              }
            },
            "required": [
              "id",
              "content",
              "conditions",
              "type",
              "position",
              "is_customized",
              "substitutions",
              "original_block_id"
            ],
            "additionalProperties": false
          }
        }
      },
      "required": [
        "title",
        "description",
        "is_active",
        "pso_type",
        "blocks"
      ],
      "additionalProperties": false
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 400
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/document-templates/{id}

Update Document Generator

Example URI

PATCH https://rest.monportailrh.com/document-templates/123
URI Parameters
HideShow
id
number (required) Example: 123

Id of the Document Generator.

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Body
{
  "title": {
    "en": "Some text",
    "fr": "Du texte",
    "de": "Setwas Text",
    "es": "Algún texto"
  },
  "description": {
    "en": "Some text",
    "fr": "Du texte",
    "de": "Setwas Text",
    "es": "Algún texto"
  },
  "is_active": true,
  "blocks": [
    {
      "id": "block001",
      "content": "Some stuff with <b>html</b>",
      "conditions": [
        {
          "field": "employment_contract_type",
          "comparison": "=",
          "value": "internship"
        }
      ],
      "type": "common",
      "position": 1,
      "substitutions": [
        "Variables, that used in template in {var} format"
      ]
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "title": {
      "type": "object",
      "properties": {
        "en": {
          "type": "string"
        },
        "fr": {
          "type": "string"
        },
        "de": {
          "type": "string"
        },
        "es": {
          "type": "string"
        }
      },
      "required": [
        "en",
        "fr",
        "de",
        "es"
      ]
    },
    "description": {
      "type": "object",
      "properties": {
        "en": {
          "type": "string"
        },
        "fr": {
          "type": "string"
        },
        "de": {
          "type": "string"
        },
        "es": {
          "type": "string"
        }
      },
      "required": [
        "en",
        "fr",
        "de",
        "es"
      ]
    },
    "is_active": {
      "type": "boolean"
    },
    "blocks": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "enum": [
              "block001"
            ]
          },
          "content": {
            "type": "string",
            "enum": [
              "Some stuff with <b>html</b>"
            ]
          },
          "conditions": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "field": {
                  "type": "string",
                  "enum": [
                    "employment_contract_type"
                  ]
                },
                "comparison": {
                  "type": "string",
                  "enum": [
                    "="
                  ]
                },
                "value": {
                  "type": "string",
                  "enum": [
                    "internship"
                  ]
                }
              },
              "required": [
                "field",
                "comparison",
                "value"
              ],
              "additionalProperties": false
            }
          },
          "type": {
            "type": "string",
            "enum": [
              "common",
              "header",
              "footer"
            ]
          },
          "position": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "substitutions": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "Variables, that used in template in {var} format"
              ]
            }
          }
        },
        "required": [
          "id",
          "content",
          "conditions",
          "type",
          "position",
          "substitutions"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "title",
    "description",
    "is_active",
    "blocks"
  ]
}
Response  202
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "title": "document template name",
    "description": "document template description",
    "is_active": true,
    "pso_type": {
      "id": 56,
      "name": "User",
      "alias": "usr",
      "description": "...",
      "is_active": true,
      "system_required": true,
      "creation_form_instance_id": 1,
      "profile_form_instance_id": 1
    },
    "blocks": [
      {
        "id": "block001",
        "content": "Some stuff with <b>html</b>",
        "conditions": [
          {
            "field": "employment_contract_type",
            "comparison": "=",
            "value": "internship"
          }
        ],
        "type": "common",
        "position": 1,
        "is_customized": false,
        "substitutions": [
          "Variables, that used in template"
        ],
        "original_block_id": "redefined block"
      }
    ]
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "title": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "is_active": {
          "type": "boolean"
        },
        "pso_type": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "name": {
              "type": "string"
            },
            "alias": {
              "type": "string"
            },
            "description": {
              "type": "string"
            },
            "is_active": {
              "type": "boolean"
            },
            "system_required": {
              "type": "boolean"
            },
            "creation_form_instance_id": {
              "type": "number"
            },
            "profile_form_instance_id": {
              "type": "number"
            }
          },
          "required": [
            "id",
            "name",
            "alias",
            "description",
            "is_active",
            "system_required",
            "creation_form_instance_id",
            "profile_form_instance_id"
          ],
          "additionalProperties": false
        },
        "blocks": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "enum": [
                  "block001"
                ]
              },
              "content": {
                "type": "string",
                "enum": [
                  "Some stuff with <b>html</b>"
                ]
              },
              "conditions": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "field": {
                      "type": "string",
                      "enum": [
                        "employment_contract_type"
                      ]
                    },
                    "comparison": {
                      "type": "string",
                      "enum": [
                        "="
                      ]
                    },
                    "value": {
                      "type": "string",
                      "enum": [
                        "internship"
                      ]
                    }
                  },
                  "required": [
                    "field",
                    "comparison",
                    "value"
                  ],
                  "additionalProperties": false
                }
              },
              "type": {
                "type": "string",
                "enum": [
                  "common",
                  "header",
                  "footer"
                ]
              },
              "position": {
                "type": "number",
                "enum": [
                  1
                ]
              },
              "is_customized": {
                "type": "boolean",
                "enum": [
                  false
                ]
              },
              "substitutions": {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "Variables, that used in template"
                  ]
                }
              },
              "original_block_id": {
                "type": "string",
                "enum": [
                  "redefined block"
                ]
              }
            },
            "required": [
              "id",
              "content",
              "conditions",
              "type",
              "position",
              "is_customized",
              "substitutions",
              "original_block_id"
            ],
            "additionalProperties": false
          }
        }
      },
      "required": [
        "title",
        "description",
        "is_active",
        "pso_type",
        "blocks"
      ],
      "additionalProperties": false
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 400
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete
DELETE/document-templates/{id}

Delete Document Template

Example URI

DELETE https://rest.monportailrh.com/document-templates/123
URI Parameters
HideShow
id
number (required) Example: 123

Id of the Document Template

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: '*'
Response  204
HideShow
Headers
Content-Type: application/json
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Copy
POST/document-templates/{id}/copy

Copy Document Template

Example URI

POST https://rest.monportailrh.com/document-templates/123/copy
URI Parameters
HideShow
id
number (required) Example: 123

Id of the Document Template.

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Body
{
  "title": {
    "en": "Some text",
    "fr": "Du texte",
    "de": "Setwas Text",
    "es": "Algún texto"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "title": {
      "type": "object",
      "properties": {
        "en": {
          "type": "string"
        },
        "fr": {
          "type": "string"
        },
        "de": {
          "type": "string"
        },
        "es": {
          "type": "string"
        }
      },
      "required": [
        "en",
        "fr",
        "de",
        "es"
      ]
    }
  }
}
Response  202
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "title": "document template name",
    "description": "document template description",
    "is_active": true,
    "pso_type": {
      "id": 56,
      "name": "User",
      "alias": "usr",
      "description": "...",
      "is_active": true,
      "system_required": true,
      "creation_form_instance_id": 1,
      "profile_form_instance_id": 1
    },
    "blocks": [
      {
        "id": "block001",
        "content": "Some stuff with <b>html</b>",
        "conditions": [
          {
            "field": "employment_contract_type",
            "comparison": "=",
            "value": "internship"
          }
        ],
        "type": "common",
        "position": 1,
        "is_customized": false,
        "substitutions": [
          "Variables, that used in template"
        ],
        "original_block_id": "redefined block"
      }
    ]
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "title": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "is_active": {
          "type": "boolean"
        },
        "pso_type": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "name": {
              "type": "string"
            },
            "alias": {
              "type": "string"
            },
            "description": {
              "type": "string"
            },
            "is_active": {
              "type": "boolean"
            },
            "system_required": {
              "type": "boolean"
            },
            "creation_form_instance_id": {
              "type": "number"
            },
            "profile_form_instance_id": {
              "type": "number"
            }
          },
          "required": [
            "id",
            "name",
            "alias",
            "description",
            "is_active",
            "system_required",
            "creation_form_instance_id",
            "profile_form_instance_id"
          ],
          "additionalProperties": false
        },
        "blocks": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "enum": [
                  "block001"
                ]
              },
              "content": {
                "type": "string",
                "enum": [
                  "Some stuff with <b>html</b>"
                ]
              },
              "conditions": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "field": {
                      "type": "string",
                      "enum": [
                        "employment_contract_type"
                      ]
                    },
                    "comparison": {
                      "type": "string",
                      "enum": [
                        "="
                      ]
                    },
                    "value": {
                      "type": "string",
                      "enum": [
                        "internship"
                      ]
                    }
                  },
                  "required": [
                    "field",
                    "comparison",
                    "value"
                  ],
                  "additionalProperties": false
                }
              },
              "type": {
                "type": "string",
                "enum": [
                  "common",
                  "header",
                  "footer"
                ]
              },
              "position": {
                "type": "number",
                "enum": [
                  1
                ]
              },
              "is_customized": {
                "type": "boolean",
                "enum": [
                  false
                ]
              },
              "substitutions": {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "Variables, that used in template"
                  ]
                }
              },
              "original_block_id": {
                "type": "string",
                "enum": [
                  "redefined block"
                ]
              }
            },
            "required": [
              "id",
              "content",
              "conditions",
              "type",
              "position",
              "is_customized",
              "substitutions",
              "original_block_id"
            ],
            "additionalProperties": false
          }
        }
      },
      "required": [
        "title",
        "description",
        "is_active",
        "pso_type",
        "blocks"
      ],
      "additionalProperties": false
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 400
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Toggle active
PATCH/document-templates/{id}/toggle-active

Toggle active of the Document Template

Example URI

PATCH https://rest.monportailrh.com/document-templates/123/toggle-active
URI Parameters
HideShow
id
number (required) Example: 123

Id of the Document Templates.

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Response  202
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "title": "document template name",
    "description": "document template description",
    "is_active": true,
    "pso_type": {
      "id": 56,
      "name": "User",
      "alias": "usr",
      "description": "...",
      "is_active": true,
      "system_required": true,
      "creation_form_instance_id": 1,
      "profile_form_instance_id": 1
    },
    "blocks": [
      {
        "id": "block001",
        "content": "Some stuff with <b>html</b>",
        "conditions": [
          {
            "field": "employment_contract_type",
            "comparison": "=",
            "value": "internship"
          }
        ],
        "type": "common",
        "position": 1,
        "is_customized": false,
        "substitutions": [
          "Variables, that used in template"
        ],
        "original_block_id": "redefined block"
      }
    ]
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "title": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "is_active": {
          "type": "boolean"
        },
        "pso_type": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "name": {
              "type": "string"
            },
            "alias": {
              "type": "string"
            },
            "description": {
              "type": "string"
            },
            "is_active": {
              "type": "boolean"
            },
            "system_required": {
              "type": "boolean"
            },
            "creation_form_instance_id": {
              "type": "number"
            },
            "profile_form_instance_id": {
              "type": "number"
            }
          },
          "required": [
            "id",
            "name",
            "alias",
            "description",
            "is_active",
            "system_required",
            "creation_form_instance_id",
            "profile_form_instance_id"
          ],
          "additionalProperties": false
        },
        "blocks": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "enum": [
                  "block001"
                ]
              },
              "content": {
                "type": "string",
                "enum": [
                  "Some stuff with <b>html</b>"
                ]
              },
              "conditions": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "field": {
                      "type": "string",
                      "enum": [
                        "employment_contract_type"
                      ]
                    },
                    "comparison": {
                      "type": "string",
                      "enum": [
                        "="
                      ]
                    },
                    "value": {
                      "type": "string",
                      "enum": [
                        "internship"
                      ]
                    }
                  },
                  "required": [
                    "field",
                    "comparison",
                    "value"
                  ],
                  "additionalProperties": false
                }
              },
              "type": {
                "type": "string",
                "enum": [
                  "common",
                  "header",
                  "footer"
                ]
              },
              "position": {
                "type": "number",
                "enum": [
                  1
                ]
              },
              "is_customized": {
                "type": "boolean",
                "enum": [
                  false
                ]
              },
              "substitutions": {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "Variables, that used in template"
                  ]
                }
              },
              "original_block_id": {
                "type": "string",
                "enum": [
                  "redefined block"
                ]
              }
            },
            "required": [
              "id",
              "content",
              "conditions",
              "type",
              "position",
              "is_customized",
              "substitutions",
              "original_block_id"
            ],
            "additionalProperties": false
          }
        }
      },
      "required": [
        "title",
        "description",
        "is_active",
        "pso_type",
        "blocks"
      ],
      "additionalProperties": false
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 400
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Preview
POST/document-templates/preview

Preview Document Generation

Example URI

POST https://rest.monportailrh.com/document-templates/preview
Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
Body
{
  "data": [
    {
      "id": "block001",
      "content": "Some stuff with <b>html</b>",
      "conditions": [
        {
          "field": "employment_contract_type",
          "comparison": "=",
          "value": "internship"
        }
      ],
      "type": "common",
      "position": 1,
      "substitutions": [
        "Variables, that used in template in {var} format"
      ]
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "enum": [
              "block001"
            ]
          },
          "content": {
            "type": "string",
            "enum": [
              "Some stuff with <b>html</b>"
            ]
          },
          "conditions": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "field": {
                  "type": "string",
                  "enum": [
                    "employment_contract_type"
                  ]
                },
                "comparison": {
                  "type": "string",
                  "enum": [
                    "="
                  ]
                },
                "value": {
                  "type": "string",
                  "enum": [
                    "internship"
                  ]
                }
              },
              "required": [
                "field",
                "comparison",
                "value"
              ],
              "additionalProperties": false
            }
          },
          "type": {
            "type": "string",
            "enum": [
              "common",
              "header",
              "footer"
            ]
          },
          "position": {
            "type": "number",
            "enum": [
              1
            ]
          },
          "substitutions": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "Variables, that used in template in {var} format"
              ]
            }
          }
        },
        "required": [
          "id",
          "content",
          "conditions",
          "type",
          "position",
          "substitutions"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "data"
  ]
}
Response  200
HideShow
Headers
Content-Type: application/pdf
Content-Description: File Transfer
Content-Length: 7827858787
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Domains

Fields domains.

Domains

List
GET/domains{?pso-type,active,search,sort-by,sort-direction}

Fetch list of domains

Example URI

GET https://rest.monportailrh.com/domains?pso-type=123&active=true&search=Domains to search&sort-by=name&sort-direction=asc
URI Parameters
HideShow
pso-type
number (optional) Example: 123

PSO type ID to filtering.

active
boolean (optional) Example: true

To filtering domains by active state

search
string (optional) Example: Domains to search

Search by domain title. Non strict, case-insensitive.

sort-by
name, pso-type (optional) Default: name Example: name

Field to sort domains by.

sort-direction
asc, desc (optional) Default: asc Example: asc

Direction to order domains by.

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": 46,
      "alias": "usr_global",
      "name": "User Global",
      "description": "...",
      "is_editable": false,
      "is_removable": false,
      "is_active": true,
      "pso_type": {
        "id": 56,
        "name": "User",
        "alias": "usr",
        "description": "...",
        "is_active": true,
        "system_required": true,
        "creation_form_instance_id": 1,
        "profile_form_instance_id": 1
      }
    }
  ],
  "meta": {
    "pagination": {
      "total": 238,
      "count": 25,
      "per_page": 25,
      "current_page": 2,
      "total_pages": 10,
      "links": {
        "previous": "http://example.com/api/<endpoint>?page=1",
        "next": "http://example.com/api/<endpoint>?page=3"
      }
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number"
          },
          "alias": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "is_editable": {
            "type": "boolean"
          },
          "is_removable": {
            "type": "boolean"
          },
          "is_active": {
            "type": "boolean"
          },
          "pso_type": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number"
              },
              "name": {
                "type": "string"
              },
              "alias": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "is_active": {
                "type": "boolean"
              },
              "system_required": {
                "type": "boolean"
              },
              "creation_form_instance_id": {
                "type": "number"
              },
              "profile_form_instance_id": {
                "type": "number"
              }
            },
            "required": [
              "id",
              "name",
              "alias",
              "description",
              "is_active",
              "system_required",
              "creation_form_instance_id",
              "profile_form_instance_id"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "id",
          "alias",
          "name",
          "description",
          "is_editable",
          "is_removable",
          "is_active"
        ]
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number"
            },
            "count": {
              "type": "number"
            },
            "per_page": {
              "type": "number"
            },
            "current_page": {
              "type": "number"
            },
            "total_pages": {
              "type": "number"
            },
            "links": {
              "type": "object",
              "properties": {
                "previous": {
                  "type": "string"
                },
                "next": {
                  "type": "string"
                }
              },
              "required": [
                "previous",
                "next"
              ]
            }
          },
          "required": [
            "total",
            "count",
            "per_page",
            "current_page",
            "total_pages",
            "links"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "pagination"
      ]
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Create
POST/domains

Create new domain item

Example URI

POST https://rest.monportailrh.com/domains
Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Body
{
  "pso_type": "usr",
  "name": {
    "en": "Some text",
    "fr": "Du texte",
    "de": "Setwas Text",
    "es": "Algún texto"
  },
  "description": {
    "en": "Some text",
    "fr": "Du texte",
    "de": "Setwas Text",
    "es": "Algún texto"
  },
  "alias": "usr_global",
  "is_editable": false,
  "is_removable": false,
  "is_active": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "pso_type": {
      "type": "string"
    },
    "name": {
      "type": "object",
      "properties": {
        "en": {
          "type": "string"
        },
        "fr": {
          "type": "string"
        },
        "de": {
          "type": "string"
        },
        "es": {
          "type": "string"
        }
      },
      "required": [
        "en",
        "fr",
        "de",
        "es"
      ]
    },
    "description": {
      "type": "object",
      "properties": {
        "en": {
          "type": "string"
        },
        "fr": {
          "type": "string"
        },
        "de": {
          "type": "string"
        },
        "es": {
          "type": "string"
        }
      },
      "required": [
        "en",
        "fr",
        "de",
        "es"
      ]
    },
    "alias": {
      "type": "string"
    },
    "is_editable": {
      "type": "boolean"
    },
    "is_removable": {
      "type": "boolean"
    },
    "is_active": {
      "type": "boolean"
    }
  },
  "required": [
    "pso_type",
    "name"
  ]
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 46,
    "alias": "usr_global",
    "name": "User Global",
    "description": "...",
    "is_editable": false,
    "is_removable": false,
    "is_active": true,
    "pso_type": {
      "id": 56,
      "name": "User",
      "alias": "usr",
      "description": "...",
      "is_active": true,
      "system_required": true,
      "creation_form_instance_id": 1,
      "profile_form_instance_id": 1
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "alias": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "is_editable": {
          "type": "boolean"
        },
        "is_removable": {
          "type": "boolean"
        },
        "is_active": {
          "type": "boolean"
        },
        "pso_type": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "name": {
              "type": "string"
            },
            "alias": {
              "type": "string"
            },
            "description": {
              "type": "string"
            },
            "is_active": {
              "type": "boolean"
            },
            "system_required": {
              "type": "boolean"
            },
            "creation_form_instance_id": {
              "type": "number"
            },
            "profile_form_instance_id": {
              "type": "number"
            }
          },
          "required": [
            "id",
            "name",
            "alias",
            "description",
            "is_active",
            "system_required",
            "creation_form_instance_id",
            "profile_form_instance_id"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "id",
        "alias",
        "name",
        "description",
        "is_editable",
        "is_removable",
        "is_active"
      ],
      "additionalProperties": false
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 400
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/domains/{alias}

Fetch single domain item

Example URI

GET https://rest.monportailrh.com/domains/somedomain
URI Parameters
HideShow
alias
string (required) Example: somedomain

Alias of the Domain item.

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 46,
    "alias": "usr_global",
    "name": "User Global",
    "description": "...",
    "is_editable": false,
    "is_removable": false,
    "is_active": true,
    "pso_type": {
      "id": 56,
      "name": "User",
      "alias": "usr",
      "description": "...",
      "is_active": true,
      "system_required": true,
      "creation_form_instance_id": 1,
      "profile_form_instance_id": 1
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "alias": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "is_editable": {
          "type": "boolean"
        },
        "is_removable": {
          "type": "boolean"
        },
        "is_active": {
          "type": "boolean"
        },
        "pso_type": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "name": {
              "type": "string"
            },
            "alias": {
              "type": "string"
            },
            "description": {
              "type": "string"
            },
            "is_active": {
              "type": "boolean"
            },
            "system_required": {
              "type": "boolean"
            },
            "creation_form_instance_id": {
              "type": "number"
            },
            "profile_form_instance_id": {
              "type": "number"
            }
          },
          "required": [
            "id",
            "name",
            "alias",
            "description",
            "is_active",
            "system_required",
            "creation_form_instance_id",
            "profile_form_instance_id"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "id",
        "alias",
        "name",
        "description",
        "is_editable",
        "is_removable",
        "is_active"
      ],
      "additionalProperties": false
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete
DELETE/domains/{alias}

Delete domain item

Example URI

DELETE https://rest.monportailrh.com/domains/somedomain
URI Parameters
HideShow
alias
string (required) Example: somedomain

Alias of the Domain item.

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Response  204
HideShow
Headers
Content-Type: application/json
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/domains/{alias}

Update domain item

Example URI

PATCH https://rest.monportailrh.com/domains/somedomain
URI Parameters
HideShow
alias
string (required) Example: somedomain

Alias of the Domain item.

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Body
{
  "name": {
    "en": "Some text",
    "fr": "Du texte",
    "de": "Setwas Text",
    "es": "Algún texto"
  },
  "description": {
    "en": "Some text",
    "fr": "Du texte",
    "de": "Setwas Text",
    "es": "Algún texto"
  },
  "is_editable": false,
  "is_removable": false,
  "is_active": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "object",
      "properties": {
        "en": {
          "type": "string"
        },
        "fr": {
          "type": "string"
        },
        "de": {
          "type": "string"
        },
        "es": {
          "type": "string"
        }
      },
      "required": [
        "en",
        "fr",
        "de",
        "es"
      ]
    },
    "description": {
      "type": "object",
      "properties": {
        "en": {
          "type": "string"
        },
        "fr": {
          "type": "string"
        },
        "de": {
          "type": "string"
        },
        "es": {
          "type": "string"
        }
      },
      "required": [
        "en",
        "fr",
        "de",
        "es"
      ]
    },
    "is_editable": {
      "type": "boolean"
    },
    "is_removable": {
      "type": "boolean"
    },
    "is_active": {
      "type": "boolean"
    }
  }
}
Response  202
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 46,
    "alias": "usr_global",
    "name": "User Global",
    "description": "...",
    "is_editable": false,
    "is_removable": false,
    "is_active": true,
    "pso_type": {
      "id": 56,
      "name": "User",
      "alias": "usr",
      "description": "...",
      "is_active": true,
      "system_required": true,
      "creation_form_instance_id": 1,
      "profile_form_instance_id": 1
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "alias": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "is_editable": {
          "type": "boolean"
        },
        "is_removable": {
          "type": "boolean"
        },
        "is_active": {
          "type": "boolean"
        },
        "pso_type": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "name": {
              "type": "string"
            },
            "alias": {
              "type": "string"
            },
            "description": {
              "type": "string"
            },
            "is_active": {
              "type": "boolean"
            },
            "system_required": {
              "type": "boolean"
            },
            "creation_form_instance_id": {
              "type": "number"
            },
            "profile_form_instance_id": {
              "type": "number"
            }
          },
          "required": [
            "id",
            "name",
            "alias",
            "description",
            "is_active",
            "system_required",
            "creation_form_instance_id",
            "profile_form_instance_id"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "id",
        "alias",
        "name",
        "description",
        "is_editable",
        "is_removable",
        "is_active"
      ],
      "additionalProperties": false
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 400
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Fields

Fields instances data.

Validation attribute

Fields can handle basic data validation via attribute validation. System can handle 3 type validation: regexp , predefined and builder.

RegExp example 

{
  "type": "regexp",
  "attributes": {
    "expression": "reg-exp expression"
  },
  "value_example": "some string",
  "error_message": {
    "en": "En translation",
    "fr": "Fr translation",
    "es": "Es translation",
    "de": "De translation"
  }
}

Predefined example 

{
  "type": "predefined",
  "attributes": {
    "rule_alias": "some-rule-alias"
  },
  "value_example": "some string",
  "error_message": {
    "en": "En translation",
    "fr": "Fr translation",
    "es": "Es translation",
    "de": "De translation"
  }
}

Fields

List
GET/fields{?name,active,category,privacy-level,pso-type,data-type,append_profile,target-pso-type,allow-inactive-options,sort-by,sort-direction,role-driven,effective_date}

Fetch list of fields

Permission required: fields.index

Example URI

GET https://rest.monportailrh.com/fields?name=Field to search&active=true&category=usr_category&privacy-level=public&pso-type=usr&data-type=string&append_profile=true&target-pso-type=usr&allow-inactive-options=true&sort-by=name&sort-direction=asc&role-driven=false&effective_date=2020
URI Parameters
HideShow
name
string (optional) Example: Field to search

Search by fields title. Non strict, case-insensitive. Max Length: 255

active
boolean (optional) Example: true

To filtering fields by active state.

category
string (optional) Example: usr_category

Get only fields related to selected category. Fields category aliases used.

privacy-level
public, encrypted, extreme (optional) Example: public

To filtering fields by privacy level.

pso-type
string (optional) Example: usr

PSO type alias to filtering.

data-type
array[string] (optional) Example: string

Array of data types aliases to filtering.

append_profile
boolean (optional) Example: true

Get only fields, appended to pso profile forms.

target-pso-type
string (optional) Example: usr

Get only related fields which link to selected pso type(alias should be provided).

allow-inactive-options
boolean (optional) Example: true

Return only active option items(for datatypes which supports options).

sort-by
name, pso-type, data-type, category, privacy-level, active (optional) Default: name Example: name

Column to sort fields by.

sort-direction
asc, desc (optional) Default: asc Example: asc

Direction to order fields categories by.

effective_date
string (required) Example: 2020

12-31 (optional, date) Filter by effective date

role-driven
boolean (optional) Example: false

Role driven filter

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": 1,
      "name": "Field Name",
      "position": 5,
      "alias": "usr_first_name",
      "has_unique_data": false,
      "has_value": true,
      "removable": false,
      "is_active": true,
      "list": false,
      "read_only": false,
      "required": true,
      "user_required": true,
      "system_required": true,
      "type": {
        "id": 1,
        "name": "Data Type Name",
        "alias": "data_type_alias",
        "settings": [
          {
            "id": 1,
            "name": "Data Type Setting Name",
            "alias": "data_type_setting_alias",
            "is_required": true
          }
        ],
        "supports_collection": false,
        "supports_read_only": false,
        "supports_unique": false
      },
      "category": {
        "id": 32,
        "alias": "usr_identity",
        "position": 5,
        "system_required": true,
        "name": "Identity",
        "description": "...",
        "is_active": true,
        "pso_type": {
          "id": 56,
          "name": "User",
          "alias": "usr",
          "description": "...",
          "is_active": true,
          "system_required": true,
          "creation_form_instance_id": 1,
          "profile_form_instance_id": 1
        }
      },
      "domains": [
        {
          "id": 46,
          "alias": "usr_global",
          "name": "User Global",
          "description": "...",
          "is_editable": false,
          "is_removable": false,
          "is_active": true,
          "pso_type": {
            "id": 56,
            "name": "User",
            "alias": "usr",
            "description": "...",
            "is_active": true,
            "system_required": true,
            "creation_form_instance_id": 1,
            "profile_form_instance_id": 1
          }
        }
      ],
      "privacy_level": {
        "id": 123,
        "alias": "public",
        "name": "Not Sensitive",
        "level": 100
      },
      "pso_type": {
        "id": 56,
        "name": "User",
        "alias": "usr",
        "description": "...",
        "is_active": true,
        "system_required": true,
        "creation_form_instance_id": 1,
        "profile_form_instance_id": 1
      },
      "items": [
        {}
      ],
      "options": [
        {
          "id": 198,
          "name": "Choose me!",
          "position": 9,
          "value": "198",
          "is_active": true,
          "is_selectable": true
        }
      ],
      "settings": [],
      "validation": {
        "type": "regexp",
        "attributes": {},
        "value_example": "string",
        "error_message": {
          "en": "Some text",
          "fr": "Du texte",
          "de": "Setwas Text",
          "es": "Algún texto"
        }
      },
      "has_autocomplete_settings": true,
      "autocomplete_settings": {
        "allow_extra_values": true,
        "autofill": true,
        "provider": {
          "name": {
            "en": "Some text",
            "fr": "Du texte",
            "de": "Setwas Text",
            "es": "Algún texto"
          },
          "alias": "string",
          "base_url": "https://exmaple.com/",
          "single_value_supported": true,
          "parameters": [
            {
              "name": "Name",
              "key": "alias",
              "required": true
            }
          ]
        },
        "parameters": [
          {
            "name": "Name",
            "key": "alias",
            "required": true,
            "value": "value",
            "field": {
              "id": 1,
              "name": "Field Name",
              "alias": "usr_first_name",
              "value": "RU",
              "root_field": {
                "id": 1,
                "name": "Field Name",
                "alias": "usr_first_name",
                "value": "RU",
                "root_field": "null"
              }
            }
          }
        ]
      }
    }
  ],
  "meta": {
    "pagination": {
      "total": 238,
      "count": 25,
      "per_page": 25,
      "current_page": 2,
      "total_pages": 10,
      "links": {
        "previous": "http://example.com/api/<endpoint>?page=1",
        "next": "http://example.com/api/<endpoint>?page=3"
      }
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number"
          },
          "name": {
            "type": "string"
          },
          "position": {
            "type": "number"
          },
          "alias": {
            "type": "string"
          },
          "has_unique_data": {
            "type": "boolean",
            "description": "whether field requires values to be unique across system"
          },
          "has_value": {
            "type": "boolean",
            "description": "whether field has at least one value submitted"
          },
          "removable": {
            "type": "boolean",
            "description": "whether field can be removed from system"
          },
          "is_active": {
            "type": "boolean"
          },
          "list": {
            "type": "boolean",
            "description": "whether field can handle collection of values"
          },
          "read_only": {
            "type": "boolean",
            "description": "whether field value can be changed"
          },
          "required": {
            "type": "boolean",
            "description": "deprecated setting"
          },
          "user_required": {
            "type": "boolean",
            "description": "whether field value required by user"
          },
          "system_required": {
            "type": "boolean",
            "description": "whether field value required by system"
          },
          "type": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number"
              },
              "name": {
                "type": "string"
              },
              "alias": {
                "type": "string"
              },
              "settings": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "number"
                    },
                    "name": {
                      "type": "string"
                    },
                    "alias": {
                      "type": "string"
                    },
                    "is_required": {
                      "type": "boolean"
                    }
                  },
                  "required": [
                    "id",
                    "name",
                    "alias",
                    "is_required"
                  ]
                }
              },
              "supports_collection": {
                "type": "boolean"
              },
              "supports_read_only": {
                "type": "boolean"
              },
              "supports_unique": {
                "type": "boolean"
              }
            },
            "required": [
              "id",
              "name",
              "alias",
              "settings",
              "supports_collection",
              "supports_read_only",
              "supports_unique"
            ],
            "additionalProperties": false
          },
          "category": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number"
              },
              "alias": {
                "type": "string"
              },
              "position": {
                "type": "number"
              },
              "system_required": {
                "type": "boolean"
              },
              "name": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "is_active": {
                "type": "boolean"
              },
              "pso_type": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "number"
                  },
                  "name": {
                    "type": "string"
                  },
                  "alias": {
                    "type": "string"
                  },
                  "description": {
                    "type": "string"
                  },
                  "is_active": {
                    "type": "boolean"
                  },
                  "system_required": {
                    "type": "boolean"
                  },
                  "creation_form_instance_id": {
                    "type": "number"
                  },
                  "profile_form_instance_id": {
                    "type": "number"
                  }
                },
                "required": [
                  "id",
                  "name",
                  "alias",
                  "description",
                  "is_active",
                  "system_required",
                  "creation_form_instance_id",
                  "profile_form_instance_id"
                ],
                "additionalProperties": false,
                "description": "Presented only if `include` was send"
              }
            },
            "required": [
              "id",
              "alias",
              "position",
              "system_required",
              "name",
              "description",
              "is_active"
            ],
            "additionalProperties": false
          },
          "domains": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number"
                },
                "alias": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "description": {
                  "type": "string"
                },
                "is_editable": {
                  "type": "boolean"
                },
                "is_removable": {
                  "type": "boolean"
                },
                "is_active": {
                  "type": "boolean"
                },
                "pso_type": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "number"
                    },
                    "name": {
                      "type": "string"
                    },
                    "alias": {
                      "type": "string"
                    },
                    "description": {
                      "type": "string"
                    },
                    "is_active": {
                      "type": "boolean"
                    },
                    "system_required": {
                      "type": "boolean"
                    },
                    "creation_form_instance_id": {
                      "type": "number"
                    },
                    "profile_form_instance_id": {
                      "type": "number"
                    }
                  },
                  "required": [
                    "id",
                    "name",
                    "alias",
                    "description",
                    "is_active",
                    "system_required",
                    "creation_form_instance_id",
                    "profile_form_instance_id"
                  ],
                  "additionalProperties": false
                }
              },
              "required": [
                "id",
                "alias",
                "name",
                "description",
                "is_editable",
                "is_removable",
                "is_active"
              ]
            }
          },
          "privacy_level": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number"
              },
              "alias": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "level": {
                "type": "number"
              }
            },
            "required": [
              "id",
              "alias",
              "name",
              "level"
            ],
            "additionalProperties": false
          },
          "pso_type": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number"
              },
              "name": {
                "type": "string"
              },
              "alias": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "is_active": {
                "type": "boolean"
              },
              "system_required": {
                "type": "boolean"
              },
              "creation_form_instance_id": {
                "type": "number"
              },
              "profile_form_instance_id": {
                "type": "number"
              }
            },
            "required": [
              "id",
              "name",
              "alias",
              "description",
              "is_active",
              "system_required",
              "creation_form_instance_id",
              "profile_form_instance_id"
            ],
            "additionalProperties": false
          },
          "items": {
            "type": [
              "array",
              "null"
            ],
            "items": {
              "type": "object",
              "properties": {}
            }
          },
          "options": {
            "type": [
              "array",
              "null"
            ],
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number"
                },
                "name": {
                  "type": "string"
                },
                "position": {
                  "type": "number"
                },
                "value": {
                  "type": "string"
                },
                "is_active": {
                  "type": "boolean"
                },
                "is_selectable": {
                  "type": "boolean",
                  "description": "Can select on front this option (Using only in Hierarchy field))"
                }
              },
              "required": [
                "id",
                "name",
                "position",
                "value",
                "is_active",
                "is_selectable"
              ]
            },
            "description": "List of options with possible (allowed) values."
          },
          "settings": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Common field settings"
          },
          "validation": {
            "type": "object",
            "properties": {
              "type": {
                "type": "string"
              },
              "attributes": {
                "type": "object",
                "properties": {}
              },
              "value_example": {
                "type": "string"
              },
              "error_message": {
                "type": "object",
                "properties": {
                  "en": {
                    "type": "string"
                  },
                  "fr": {
                    "type": "string"
                  },
                  "de": {
                    "type": "string"
                  },
                  "es": {
                    "type": "string"
                  }
                },
                "required": [
                  "en",
                  "fr",
                  "de",
                  "es"
                ]
              }
            },
            "required": [
              "type",
              "value_example",
              "error_message"
            ]
          },
          "has_autocomplete_settings": {
            "type": "boolean"
          },
          "autocomplete_settings": {
            "type": "object",
            "properties": {
              "allow_extra_values": {
                "type": "boolean"
              },
              "autofill": {
                "type": "boolean"
              },
              "provider": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "object",
                    "properties": {
                      "en": {
                        "type": "string"
                      },
                      "fr": {
                        "type": "string"
                      },
                      "de": {
                        "type": "string"
                      },
                      "es": {
                        "type": "string"
                      }
                    },
                    "required": [
                      "en",
                      "fr",
                      "de",
                      "es"
                    ]
                  },
                  "alias": {
                    "type": "string"
                  },
                  "base_url": {
                    "type": "string"
                  },
                  "single_value_supported": {
                    "type": "boolean"
                  },
                  "parameters": {
                    "type": "array"
                  }
                },
                "required": [
                  "name",
                  "alias",
                  "base_url",
                  "single_value_supported",
                  "parameters"
                ]
              },
              "parameters": {
                "type": "array"
              }
            },
            "required": [
              "allow_extra_values",
              "autofill",
              "provider",
              "parameters"
            ]
          }
        },
        "required": [
          "id",
          "name",
          "position",
          "alias",
          "has_unique_data",
          "has_value",
          "removable",
          "is_active",
          "list",
          "read_only",
          "required",
          "user_required",
          "system_required",
          "validation",
          "has_autocomplete_settings",
          "autocomplete_settings"
        ]
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number"
            },
            "count": {
              "type": "number"
            },
            "per_page": {
              "type": "number"
            },
            "current_page": {
              "type": "number"
            },
            "total_pages": {
              "type": "number"
            },
            "links": {
              "type": "object",
              "properties": {
                "previous": {
                  "type": "string"
                },
                "next": {
                  "type": "string"
                }
              },
              "required": [
                "previous",
                "next"
              ]
            }
          },
          "required": [
            "total",
            "count",
            "per_page",
            "current_page",
            "total_pages",
            "links"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "pagination"
      ]
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Create
POST/fields

Create new field item.

Permission required: fields.create

Example URI

POST https://rest.monportailrh.com/fields
Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Body
{
  "name": {
    "en": "Some text",
    "fr": "Du texte",
    "de": "Setwas Text",
    "es": "Algún texto"
  },
  "type": "string",
  "privacy_level": "public",
  "category": "usr_first_name",
  "is_active": true,
  "list": true,
  "read_only": false,
  "pso_type": "usr",
  "options": [
    {
      "name": {
        "en": "Some text",
        "fr": "Du texte",
        "de": "Setwas Text",
        "es": "Algún texto"
      },
      "position": 1,
      "is_active": true
    }
  ],
  "items": [
    {}
  ],
  "settings": [
    {
      "setting_id": 123,
      "value": "text"
    }
  ],
  "position": 5,
  "alias": "usr_first_name",
  "domains": [
    "usr_global"
  ],
  "validation": {
    "type": "regexp",
    "attributes": {},
    "value_example": "string",
    "error_message": {
      "en": "Some text",
      "fr": "Du texte",
      "de": "Setwas Text",
      "es": "Algún texto"
    }
  },
  "autocomplete_settings": {
    "allow_extra_values": true,
    "autofill": true,
    "provider": "provider_alias",
    "parameters": [
      {
        "name": "Name",
        "key": "alias",
        "required": true,
        "value": "value",
        "field": "field_alias"
      }
    ]
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "object",
      "properties": {
        "en": {
          "type": "string"
        },
        "fr": {
          "type": "string"
        },
        "de": {
          "type": "string"
        },
        "es": {
          "type": "string"
        }
      },
      "required": [
        "en",
        "fr",
        "de",
        "es"
      ],
      "description": "Name of field"
    },
    "type": {
      "type": "string",
      "description": "Data Type of field"
    },
    "privacy_level": {
      "type": "string",
      "enum": [
        "public",
        "encrypted",
        "extreme"
      ],
      "description": "Privacy Level of field"
    },
    "category": {
      "type": "string",
      "description": "Category alias of field"
    },
    "is_active": {
      "type": "boolean",
      "description": "Active flag of field"
    },
    "list": {
      "type": "boolean",
      "description": "should it be \"list of\" field"
    },
    "read_only": {
      "type": "boolean",
      "description": "Read Only flag of field"
    },
    "pso_type": {
      "type": "string",
      "description": "Pso Type of field"
    },
    "options": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "object",
            "properties": {
              "en": {
                "type": "string"
              },
              "fr": {
                "type": "string"
              },
              "de": {
                "type": "string"
              },
              "es": {
                "type": "string"
              }
            },
            "required": [
              "en",
              "fr",
              "de",
              "es"
            ]
          },
          "position": {
            "type": "number"
          },
          "is_active": {
            "type": "boolean"
          }
        },
        "required": [
          "name",
          "position",
          "is_active"
        ]
      },
      "description": "Options of field"
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {}
      },
      "description": "Children fields of composite field"
    },
    "settings": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "setting_id": {
            "type": "number"
          },
          "value": {
            "type": "string"
          }
        },
        "required": [
          "setting_id",
          "value"
        ]
      },
      "description": "Settings of composite"
    },
    "position": {
      "type": "number",
      "description": "Positions of field"
    },
    "alias": {
      "type": "string",
      "description": "Unique alias of field"
    },
    "domains": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "array of domain aliases"
    },
    "validation": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string"
        },
        "attributes": {
          "type": "object",
          "properties": {}
        },
        "value_example": {
          "type": "string"
        },
        "error_message": {
          "type": "object",
          "properties": {
            "en": {
              "type": "string"
            },
            "fr": {
              "type": "string"
            },
            "de": {
              "type": "string"
            },
            "es": {
              "type": "string"
            }
          },
          "required": [
            "en",
            "fr",
            "de",
            "es"
          ]
        }
      },
      "required": [
        "type",
        "value_example",
        "error_message"
      ]
    },
    "autocomplete_settings": {
      "type": "object",
      "properties": {
        "allow_extra_values": {
          "type": "boolean"
        },
        "autofill": {
          "type": "boolean"
        },
        "provider": {
          "type": "string"
        },
        "parameters": {
          "type": "array"
        }
      },
      "required": [
        "allow_extra_values",
        "autofill",
        "provider",
        "parameters"
      ]
    }
  },
  "required": [
    "name",
    "type",
    "privacy_level",
    "category",
    "is_active",
    "list",
    "read_only",
    "pso_type",
    "validation",
    "autocomplete_settings"
  ]
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
{}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {},
      "additionalProperties": false
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 400
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/fields/{id}

Fetch single field item

Permission required: fields.view

Example URI

GET https://rest.monportailrh.com/fields/123
URI Parameters
HideShow
id
string (required) Example: 123

Alias of the Category item.

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 1,
    "name": "Field Name",
    "position": 5,
    "alias": "usr_first_name",
    "has_unique_data": false,
    "has_value": true,
    "removable": false,
    "is_active": true,
    "list": false,
    "read_only": false,
    "required": true,
    "user_required": true,
    "system_required": true,
    "type": {
      "id": 1,
      "name": "Data Type Name",
      "alias": "data_type_alias",
      "settings": [
        {
          "id": 1,
          "name": "Data Type Setting Name",
          "alias": "data_type_setting_alias",
          "is_required": true
        }
      ],
      "supports_collection": false,
      "supports_read_only": false,
      "supports_unique": false
    },
    "category": {
      "id": 32,
      "alias": "usr_identity",
      "position": 5,
      "system_required": true,
      "name": "Identity",
      "description": "...",
      "is_active": true,
      "pso_type": {
        "id": 56,
        "name": "User",
        "alias": "usr",
        "description": "...",
        "is_active": true,
        "system_required": true,
        "creation_form_instance_id": 1,
        "profile_form_instance_id": 1
      }
    },
    "domains": [
      {
        "id": 46,
        "alias": "usr_global",
        "name": "User Global",
        "description": "...",
        "is_editable": false,
        "is_removable": false,
        "is_active": true,
        "pso_type": {
          "id": 56,
          "name": "User",
          "alias": "usr",
          "description": "...",
          "is_active": true,
          "system_required": true,
          "creation_form_instance_id": 1,
          "profile_form_instance_id": 1
        }
      }
    ],
    "privacy_level": {
      "id": 123,
      "alias": "public",
      "name": "Not Sensitive",
      "level": 100
    },
    "pso_type": {
      "id": 56,
      "name": "User",
      "alias": "usr",
      "description": "...",
      "is_active": true,
      "system_required": true,
      "creation_form_instance_id": 1,
      "profile_form_instance_id": 1
    },
    "items": [
      {}
    ],
    "options": [
      {
        "id": 198,
        "name": "Choose me!",
        "position": 9,
        "value": "198",
        "is_active": true,
        "is_selectable": true
      }
    ],
    "settings": [],
    "validation": {
      "type": "regexp",
      "attributes": {},
      "value_example": "string",
      "error_message": {
        "en": "Some text",
        "fr": "Du texte",
        "de": "Setwas Text",
        "es": "Algún texto"
      }
    },
    "has_autocomplete_settings": true,
    "autocomplete_settings": {
      "allow_extra_values": true,
      "autofill": true,
      "provider": {
        "name": {
          "en": "Some text",
          "fr": "Du texte",
          "de": "Setwas Text",
          "es": "Algún texto"
        },
        "alias": "string",
        "base_url": "https://exmaple.com/",
        "single_value_supported": true,
        "parameters": [
          {
            "name": "Name",
            "key": "alias",
            "required": true
          }
        ]
      },
      "parameters": [
        {
          "name": "Name",
          "key": "alias",
          "required": true,
          "value": "value",
          "field": {
            "id": 1,
            "name": "Field Name",
            "alias": "usr_first_name",
            "value": "RU",
            "root_field": {
              "id": 1,
              "name": "Field Name",
              "alias": "usr_first_name",
              "value": "RU",
              "root_field": "null"
            }
          }
        }
      ]
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        },
        "position": {
          "type": "number"
        },
        "alias": {
          "type": "string"
        },
        "has_unique_data": {
          "type": "boolean",
          "description": "whether field requires values to be unique across system"
        },
        "has_value": {
          "type": "boolean",
          "description": "whether field has at least one value submitted"
        },
        "removable": {
          "type": "boolean",
          "description": "whether field can be removed from system"
        },
        "is_active": {
          "type": "boolean"
        },
        "list": {
          "type": "boolean",
          "description": "whether field can handle collection of values"
        },
        "read_only": {
          "type": "boolean",
          "description": "whether field value can be changed"
        },
        "required": {
          "type": "boolean",
          "description": "deprecated setting"
        },
        "user_required": {
          "type": "boolean",
          "description": "whether field value required by user"
        },
        "system_required": {
          "type": "boolean",
          "description": "whether field value required by system"
        },
        "type": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "name": {
              "type": "string"
            },
            "alias": {
              "type": "string"
            },
            "settings": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "number"
                  },
                  "name": {
                    "type": "string"
                  },
                  "alias": {
                    "type": "string"
                  },
                  "is_required": {
                    "type": "boolean"
                  }
                },
                "required": [
                  "id",
                  "name",
                  "alias",
                  "is_required"
                ]
              }
            },
            "supports_collection": {
              "type": "boolean"
            },
            "supports_read_only": {
              "type": "boolean"
            },
            "supports_unique": {
              "type": "boolean"
            }
          },
          "required": [
            "id",
            "name",
            "alias",
            "settings",
            "supports_collection",
            "supports_read_only",
            "supports_unique"
          ],
          "additionalProperties": false
        },
        "category": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "alias": {
              "type": "string"
            },
            "position": {
              "type": "number"
            },
            "system_required": {
              "type": "boolean"
            },
            "name": {
              "type": "string"
            },
            "description": {
              "type": "string"
            },
            "is_active": {
              "type": "boolean"
            },
            "pso_type": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number"
                },
                "name": {
                  "type": "string"
                },
                "alias": {
                  "type": "string"
                },
                "description": {
                  "type": "string"
                },
                "is_active": {
                  "type": "boolean"
                },
                "system_required": {
                  "type": "boolean"
                },
                "creation_form_instance_id": {
                  "type": "number"
                },
                "profile_form_instance_id": {
                  "type": "number"
                }
              },
              "required": [
                "id",
                "name",
                "alias",
                "description",
                "is_active",
                "system_required",
                "creation_form_instance_id",
                "profile_form_instance_id"
              ],
              "additionalProperties": false,
              "description": "Presented only if `include` was send"
            }
          },
          "required": [
            "id",
            "alias",
            "position",
            "system_required",
            "name",
            "description",
            "is_active"
          ],
          "additionalProperties": false
        },
        "domains": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number"
              },
              "alias": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "is_editable": {
                "type": "boolean"
              },
              "is_removable": {
                "type": "boolean"
              },
              "is_active": {
                "type": "boolean"
              },
              "pso_type": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "number"
                  },
                  "name": {
                    "type": "string"
                  },
                  "alias": {
                    "type": "string"
                  },
                  "description": {
                    "type": "string"
                  },
                  "is_active": {
                    "type": "boolean"
                  },
                  "system_required": {
                    "type": "boolean"
                  },
                  "creation_form_instance_id": {
                    "type": "number"
                  },
                  "profile_form_instance_id": {
                    "type": "number"
                  }
                },
                "required": [
                  "id",
                  "name",
                  "alias",
                  "description",
                  "is_active",
                  "system_required",
                  "creation_form_instance_id",
                  "profile_form_instance_id"
                ],
                "additionalProperties": false
              }
            },
            "required": [
              "id",
              "alias",
              "name",
              "description",
              "is_editable",
              "is_removable",
              "is_active"
            ]
          }
        },
        "privacy_level": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "alias": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "level": {
              "type": "number"
            }
          },
          "required": [
            "id",
            "alias",
            "name",
            "level"
          ],
          "additionalProperties": false
        },
        "pso_type": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "name": {
              "type": "string"
            },
            "alias": {
              "type": "string"
            },
            "description": {
              "type": "string"
            },
            "is_active": {
              "type": "boolean"
            },
            "system_required": {
              "type": "boolean"
            },
            "creation_form_instance_id": {
              "type": "number"
            },
            "profile_form_instance_id": {
              "type": "number"
            }
          },
          "required": [
            "id",
            "name",
            "alias",
            "description",
            "is_active",
            "system_required",
            "creation_form_instance_id",
            "profile_form_instance_id"
          ],
          "additionalProperties": false
        },
        "items": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "object",
            "properties": {}
          }
        },
        "options": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number"
              },
              "name": {
                "type": "string"
              },
              "position": {
                "type": "number"
              },
              "value": {
                "type": "string"
              },
              "is_active": {
                "type": "boolean"
              },
              "is_selectable": {
                "type": "boolean",
                "description": "Can select on front this option (Using only in Hierarchy field))"
              }
            },
            "required": [
              "id",
              "name",
              "position",
              "value",
              "is_active",
              "is_selectable"
            ]
          },
          "description": "List of options with possible (allowed) values."
        },
        "settings": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Common field settings"
        },
        "validation": {
          "type": "object",
          "properties": {
            "type": {
              "type": "string"
            },
            "attributes": {
              "type": "object",
              "properties": {}
            },
            "value_example": {
              "type": "string"
            },
            "error_message": {
              "type": "object",
              "properties": {
                "en": {
                  "type": "string"
                },
                "fr": {
                  "type": "string"
                },
                "de": {
                  "type": "string"
                },
                "es": {
                  "type": "string"
                }
              },
              "required": [
                "en",
                "fr",
                "de",
                "es"
              ]
            }
          },
          "required": [
            "type",
            "value_example",
            "error_message"
          ]
        },
        "has_autocomplete_settings": {
          "type": "boolean"
        },
        "autocomplete_settings": {
          "type": "object",
          "properties": {
            "allow_extra_values": {
              "type": "boolean"
            },
            "autofill": {
              "type": "boolean"
            },
            "provider": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "object",
                  "properties": {
                    "en": {
                      "type": "string"
                    },
                    "fr": {
                      "type": "string"
                    },
                    "de": {
                      "type": "string"
                    },
                    "es": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "en",
                    "fr",
                    "de",
                    "es"
                  ]
                },
                "alias": {
                  "type": "string"
                },
                "base_url": {
                  "type": "string"
                },
                "single_value_supported": {
                  "type": "boolean"
                },
                "parameters": {
                  "type": "array"
                }
              },
              "required": [
                "name",
                "alias",
                "base_url",
                "single_value_supported",
                "parameters"
              ]
            },
            "parameters": {
              "type": "array"
            }
          },
          "required": [
            "allow_extra_values",
            "autofill",
            "provider",
            "parameters"
          ]
        }
      },
      "required": [
        "id",
        "name",
        "position",
        "alias",
        "has_unique_data",
        "has_value",
        "removable",
        "is_active",
        "list",
        "read_only",
        "required",
        "user_required",
        "system_required",
        "items",
        "options",
        "validation",
        "has_autocomplete_settings",
        "autocomplete_settings"
      ],
      "additionalProperties": false
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete
DELETE/fields/{id}

Delete field after check where field using.

Example URI

DELETE https://rest.monportailrh.com/fields/123
URI Parameters
HideShow
id
number (required) Example: 123

Alias of the Field.

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Response  204
HideShow
Headers
Content-Type: application/json
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    [
      "Error message"
    ]
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/category/{id}

Update field item

Permission required: fields.edit

Example URI

PATCH https://rest.monportailrh.com/category/123
URI Parameters
HideShow
id
string (required) Example: 123

Alias of the Category item.

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Body
{
  "id": 1,
  "name": "Field Name",
  "position": 5,
  "alias": "usr_first_name",
  "has_unique_data": false,
  "has_value": true,
  "removable": false,
  "is_active": true,
  "list": false,
  "read_only": false,
  "required": true,
  "user_required": true,
  "system_required": true,
  "type": {
    "id": 1,
    "name": "Data Type Name",
    "alias": "data_type_alias",
    "settings": [
      {
        "id": 1,
        "name": "Data Type Setting Name",
        "alias": "data_type_setting_alias",
        "is_required": true
      }
    ],
    "supports_collection": false,
    "supports_read_only": false,
    "supports_unique": false
  },
  "category": {
    "id": 32,
    "alias": "usr_identity",
    "position": 5,
    "system_required": true,
    "name": "Identity",
    "description": "...",
    "is_active": true,
    "pso_type": {
      "id": 56,
      "name": "User",
      "alias": "usr",
      "description": "...",
      "is_active": true,
      "system_required": true,
      "creation_form_instance_id": 1,
      "profile_form_instance_id": 1
    }
  },
  "domains": [
    {
      "id": 46,
      "alias": "usr_global",
      "name": "User Global",
      "description": "...",
      "is_editable": false,
      "is_removable": false,
      "is_active": true,
      "pso_type": {
        "id": 56,
        "name": "User",
        "alias": "usr",
        "description": "...",
        "is_active": true,
        "system_required": true,
        "creation_form_instance_id": 1,
        "profile_form_instance_id": 1
      }
    }
  ],
  "privacy_level": {
    "id": 123,
    "alias": "public",
    "name": "Not Sensitive",
    "level": 100
  },
  "pso_type": {
    "id": 56,
    "name": "User",
    "alias": "usr",
    "description": "...",
    "is_active": true,
    "system_required": true,
    "creation_form_instance_id": 1,
    "profile_form_instance_id": 1
  },
  "items": [
    {}
  ],
  "options": [
    {
      "id": 198,
      "name": "Choose me!",
      "position": 9,
      "value": "198",
      "is_active": true,
      "is_selectable": true
    }
  ],
  "settings": [],
  "validation": {
    "type": "regexp",
    "attributes": {},
    "value_example": "string",
    "error_message": {
      "en": "Some text",
      "fr": "Du texte",
      "de": "Setwas Text",
      "es": "Algún texto"
    }
  },
  "has_autocomplete_settings": true,
  "autocomplete_settings": {
    "allow_extra_values": true,
    "autofill": true,
    "provider": {
      "name": {
        "en": "Some text",
        "fr": "Du texte",
        "de": "Setwas Text",
        "es": "Algún texto"
      },
      "alias": "string",
      "base_url": "https://exmaple.com/",
      "single_value_supported": true,
      "parameters": [
        {
          "name": "Name",
          "key": "alias",
          "required": true
        }
      ]
    },
    "parameters": [
      {
        "name": "Name",
        "key": "alias",
        "required": true,
        "value": "value",
        "field": {
          "id": 1,
          "name": "Field Name",
          "alias": "usr_first_name",
          "value": "RU",
          "root_field": {
            "id": 1,
            "name": "Field Name",
            "alias": "usr_first_name",
            "value": "RU",
            "root_field": "null"
          }
        }
      }
    ]
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "name": {
      "type": "string"
    },
    "position": {
      "type": "number"
    },
    "alias": {
      "type": "string"
    },
    "has_unique_data": {
      "type": "boolean",
      "description": "whether field requires values to be unique across system"
    },
    "has_value": {
      "type": "boolean",
      "description": "whether field has at least one value submitted"
    },
    "removable": {
      "type": "boolean",
      "description": "whether field can be removed from system"
    },
    "is_active": {
      "type": "boolean"
    },
    "list": {
      "type": "boolean",
      "description": "whether field can handle collection of values"
    },
    "read_only": {
      "type": "boolean",
      "description": "whether field value can be changed"
    },
    "required": {
      "type": "boolean",
      "description": "deprecated setting"
    },
    "user_required": {
      "type": "boolean",
      "description": "whether field value required by user"
    },
    "system_required": {
      "type": "boolean",
      "description": "whether field value required by system"
    },
    "type": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        },
        "alias": {
          "type": "string"
        },
        "settings": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number"
              },
              "name": {
                "type": "string"
              },
              "alias": {
                "type": "string"
              },
              "is_required": {
                "type": "boolean"
              }
            },
            "required": [
              "id",
              "name",
              "alias",
              "is_required"
            ]
          }
        },
        "supports_collection": {
          "type": "boolean"
        },
        "supports_read_only": {
          "type": "boolean"
        },
        "supports_unique": {
          "type": "boolean"
        }
      },
      "required": [
        "id",
        "name",
        "alias",
        "settings",
        "supports_collection",
        "supports_read_only",
        "supports_unique"
      ],
      "additionalProperties": false
    },
    "category": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "alias": {
          "type": "string"
        },
        "position": {
          "type": "number"
        },
        "system_required": {
          "type": "boolean"
        },
        "name": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "is_active": {
          "type": "boolean"
        },
        "pso_type": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "name": {
              "type": "string"
            },
            "alias": {
              "type": "string"
            },
            "description": {
              "type": "string"
            },
            "is_active": {
              "type": "boolean"
            },
            "system_required": {
              "type": "boolean"
            },
            "creation_form_instance_id": {
              "type": "number"
            },
            "profile_form_instance_id": {
              "type": "number"
            }
          },
          "required": [
            "id",
            "name",
            "alias",
            "description",
            "is_active",
            "system_required",
            "creation_form_instance_id",
            "profile_form_instance_id"
          ],
          "additionalProperties": false,
          "description": "Presented only if `include` was send"
        }
      },
      "required": [
        "id",
        "alias",
        "position",
        "system_required",
        "name",
        "description",
        "is_active"
      ],
      "additionalProperties": false
    },
    "domains": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number"
          },
          "alias": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "is_editable": {
            "type": "boolean"
          },
          "is_removable": {
            "type": "boolean"
          },
          "is_active": {
            "type": "boolean"
          },
          "pso_type": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number"
              },
              "name": {
                "type": "string"
              },
              "alias": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "is_active": {
                "type": "boolean"
              },
              "system_required": {
                "type": "boolean"
              },
              "creation_form_instance_id": {
                "type": "number"
              },
              "profile_form_instance_id": {
                "type": "number"
              }
            },
            "required": [
              "id",
              "name",
              "alias",
              "description",
              "is_active",
              "system_required",
              "creation_form_instance_id",
              "profile_form_instance_id"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "id",
          "alias",
          "name",
          "description",
          "is_editable",
          "is_removable",
          "is_active"
        ]
      }
    },
    "privacy_level": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "alias": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "level": {
          "type": "number"
        }
      },
      "required": [
        "id",
        "alias",
        "name",
        "level"
      ],
      "additionalProperties": false
    },
    "pso_type": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        },
        "alias": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "is_active": {
          "type": "boolean"
        },
        "system_required": {
          "type": "boolean"
        },
        "creation_form_instance_id": {
          "type": "number"
        },
        "profile_form_instance_id": {
          "type": "number"
        }
      },
      "required": [
        "id",
        "name",
        "alias",
        "description",
        "is_active",
        "system_required",
        "creation_form_instance_id",
        "profile_form_instance_id"
      ],
      "additionalProperties": false
    },
    "items": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": "object",
        "properties": {}
      }
    },
    "options": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number"
          },
          "name": {
            "type": "string"
          },
          "position": {
            "type": "number"
          },
          "value": {
            "type": "string"
          },
          "is_active": {
            "type": "boolean"
          },
          "is_selectable": {
            "type": "boolean",
            "description": "Can select on front this option (Using only in Hierarchy field))"
          }
        },
        "required": [
          "id",
          "name",
          "position",
          "value",
          "is_active",
          "is_selectable"
        ]
      },
      "description": "List of options with possible (allowed) values."
    },
    "settings": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Common field settings"
    },
    "validation": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string"
        },
        "attributes": {
          "type": "object",
          "properties": {}
        },
        "value_example": {
          "type": "string"
        },
        "error_message": {
          "type": "object",
          "properties": {
            "en": {
              "type": "string"
            },
            "fr": {
              "type": "string"
            },
            "de": {
              "type": "string"
            },
            "es": {
              "type": "string"
            }
          },
          "required": [
            "en",
            "fr",
            "de",
            "es"
          ]
        }
      },
      "required": [
        "type",
        "value_example",
        "error_message"
      ]
    },
    "has_autocomplete_settings": {
      "type": "boolean"
    },
    "autocomplete_settings": {
      "type": "object",
      "properties": {
        "allow_extra_values": {
          "type": "boolean"
        },
        "autofill": {
          "type": "boolean"
        },
        "provider": {
          "type": "object",
          "properties": {
            "name": {
              "type": "object",
              "properties": {
                "en": {
                  "type": "string"
                },
                "fr": {
                  "type": "string"
                },
                "de": {
                  "type": "string"
                },
                "es": {
                  "type": "string"
                }
              },
              "required": [
                "en",
                "fr",
                "de",
                "es"
              ]
            },
            "alias": {
              "type": "string"
            },
            "base_url": {
              "type": "string"
            },
            "single_value_supported": {
              "type": "boolean"
            },
            "parameters": {
              "type": "array"
            }
          },
          "required": [
            "name",
            "alias",
            "base_url",
            "single_value_supported",
            "parameters"
          ]
        },
        "parameters": {
          "type": "array"
        }
      },
      "required": [
        "allow_extra_values",
        "autofill",
        "provider",
        "parameters"
      ]
    }
  },
  "required": [
    "id",
    "name",
    "position",
    "alias",
    "has_unique_data",
    "has_value",
    "removable",
    "is_active",
    "list",
    "read_only",
    "required",
    "user_required",
    "system_required",
    "validation",
    "has_autocomplete_settings",
    "autocomplete_settings"
  ]
}
Response  202
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 32,
    "alias": "usr_identity",
    "position": 5,
    "system_required": true,
    "name": "Identity",
    "description": "...",
    "is_active": true,
    "pso_type": {
      "id": 56,
      "name": "User",
      "alias": "usr",
      "description": "...",
      "is_active": true,
      "system_required": true,
      "creation_form_instance_id": 1,
      "profile_form_instance_id": 1
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "alias": {
          "type": "string"
        },
        "position": {
          "type": "number"
        },
        "system_required": {
          "type": "boolean"
        },
        "name": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "is_active": {
          "type": "boolean"
        },
        "pso_type": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "name": {
              "type": "string"
            },
            "alias": {
              "type": "string"
            },
            "description": {
              "type": "string"
            },
            "is_active": {
              "type": "boolean"
            },
            "system_required": {
              "type": "boolean"
            },
            "creation_form_instance_id": {
              "type": "number"
            },
            "profile_form_instance_id": {
              "type": "number"
            }
          },
          "required": [
            "id",
            "name",
            "alias",
            "description",
            "is_active",
            "system_required",
            "creation_form_instance_id",
            "profile_form_instance_id"
          ],
          "additionalProperties": false,
          "description": "Presented only if `include` was send"
        }
      },
      "required": [
        "id",
        "alias",
        "position",
        "system_required",
        "name",
        "description",
        "is_active"
      ],
      "additionalProperties": false
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 400
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List of option
GET/fields/{field}/options?values[field_alias]=123{&pso-id,name,parent}

Get option list available for field

For conditional fields, preliminary values can be passed, otherwise the values are taken from the database

Example URI

GET https://rest.monportailrh.com/fields/123/options?values[field_alias]=123&pso-id=321&name=some-option-name&parent=123
URI Parameters
HideShow
field
number (required) Example: 123

ID of the field

pso-id
number (optional) Example: 321

ID of the pso. Needed to get the options of a conditional field for a specific pso

name
string (optional) Example: some-option-name

String for search by option name

parent
number (optional) Example: 123

ID of the parent field (available for field with hierarchy type)

values
array (optional) 

Associative array, where key is the alias of the field, value is the new value of this field. Used for conditional fields, where the set of options depends on the value of other fields.

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": 123,
      "name": "Some option",
      "has_children": false,
      "is_selectable": true
    }
  ],
  "meta": {
    "pagination": {
      "total": 238,
      "count": 25,
      "per_page": 25,
      "current_page": 2,
      "total_pages": 10,
      "links": {
        "previous": "http://example.com/api/<endpoint>?page=1",
        "next": "http://example.com/api/<endpoint>?page=3"
      }
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number"
          },
          "name": {
            "type": "string"
          },
          "position": {
            "type": "number"
          },
          "value": {
            "type": "string"
          },
          "is_active": {
            "type": "boolean"
          },
          "is_selectable": {
            "type": "boolean",
            "description": "Can select on front this option (Using only in Hierarchy field))"
          }
        },
        "required": [
          "id",
          "name",
          "position",
          "value",
          "is_active",
          "is_selectable"
        ]
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number"
            },
            "count": {
              "type": "number"
            },
            "per_page": {
              "type": "number"
            },
            "current_page": {
              "type": "number"
            },
            "total_pages": {
              "type": "number"
            },
            "links": {
              "type": "object",
              "properties": {
                "previous": {
                  "type": "string"
                },
                "next": {
                  "type": "string"
                }
              },
              "required": [
                "previous",
                "next"
              ]
            }
          },
          "required": [
            "total",
            "count",
            "per_page",
            "current_page",
            "total_pages",
            "links"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "pagination"
      ]
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Fields Values

Fields values of a user for selected form instance.

Fields Values

Create
POST/psos/{dataOwner}/form-instances/{formInstance}/fields/{field}/values

Add new answer value on field in form by user.

Example URI

POST https://rest.monportailrh.com/psos/123/form-instances/123/fields/123/values
URI Parameters
HideShow
dataOwner
number (required) Example: 123

Id of PSO who will own the value.

formInstance
number (required) Example: 123

Id of Form Instance.

field
number (required) Example: 123

Id of Field.

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Body
{
  "data": [
    {
      "field_id": 123,
      "field_alias": "usr_first_name",
      "value": "some value",
      "answer_id": 123,
      "batch": "d9438793-ce22-483d-8a80-9250b7f341fd",
      "action": "create"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "field_id": {
            "type": "number",
            "description": "required without field_alias"
          },
          "field_alias": {
            "type": "string",
            "description": "required without field_id"
          },
          "value": {
            "type": "string",
            "description": "empty value will clear answer"
          },
          "answer_id": {
            "type": "number",
            "description": "needs if you try to update existed answer"
          },
          "batch": {
            "type": "string",
            "description": "needs if you works with composite list of fields"
          },
          "action": {
            "type": "string",
            "enum": [
              "create",
              "update",
              "delete"
            ]
          }
        },
        "required": [
          "action"
        ]
      }
    }
  }
}
Response  201
HideShow
Headers
Content-Type: application/json
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 400
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/psos/{dataOwner}/form-instances/{formInstance}/fields/{field}/values

Get values answered by user(data owner) on field in form.

Example URI

GET https://rest.monportailrh.com/psos/123/form-instances/123/fields/123/values
URI Parameters
HideShow
dataOwner
number (required) Example: 123

Id of PSO who will own the value.

formInstance
number (required) Example: 123

Id of Form Instance.

field
number (required) Example: 123

Id of Field.

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 1,
    "field": 123,
    "values": [
      "some value"
    ],
    "created_at": "2019-01-24 12:23:00",
    "updated_at": "2019-01-25 03:12:43",
    "value_details": "some value",
    "answers_count": 1,
    "batch": "d9438793-ce22-483d-8a80-9250b7f341fd"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "field": {
          "type": "number"
        },
        "values": {
          "type": "array"
        },
        "created_at": {
          "type": "string"
        },
        "updated_at": {
          "type": "string"
        },
        "value_details": {
          "type": "string"
        },
        "answers_count": {
          "type": "number",
          "description": "useful for \"list of\" fields"
        },
        "batch": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "field",
        "values",
        "created_at",
        "updated_at",
        "value_details",
        "answers_count"
      ],
      "additionalProperties": false
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete
DELETE/psos/{dataOwner}/form-instances/{formInstance}/fields/{field}/values

Clear value answered by user(dataOwner) on field in form.

Example URI

DELETE https://rest.monportailrh.com/psos/123/form-instances/123/fields/123/values
URI Parameters
HideShow
dataOwner
number (required) Example: 123

Id of PSO who will own the value.

formInstance
number (required) Example: 123

Id of Form Instance.

field
number (required) Example: 123

Id of Field.

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Response  204
HideShow
Headers
Content-Type: application/json
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/psos/{dataOwner}/form-instances/{formInstance}/fields/{field}/values

Update values of answers of user(data owner) on field in form.

Example URI

PATCH https://rest.monportailrh.com/psos/123/form-instances/123/fields/123/values
URI Parameters
HideShow
dataOwner
number (required) Example: 123

Id of PSO who will own the value.

formInstance
number (required) Example: 123

Id of Form Instance.

field
number (required) Example: 123

Id of Field.

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Body
{
  "id": 1,
  "name": "Field Name",
  "position": 5,
  "alias": "usr_first_name",
  "has_unique_data": false,
  "has_value": true,
  "removable": false,
  "is_active": true,
  "list": false,
  "read_only": false,
  "required": true,
  "user_required": true,
  "system_required": true,
  "type": {
    "id": 1,
    "name": "Data Type Name",
    "alias": "data_type_alias",
    "settings": [
      {
        "id": 1,
        "name": "Data Type Setting Name",
        "alias": "data_type_setting_alias",
        "is_required": true
      }
    ],
    "supports_collection": false,
    "supports_read_only": false,
    "supports_unique": false
  },
  "category": {
    "id": 32,
    "alias": "usr_identity",
    "position": 5,
    "system_required": true,
    "name": "Identity",
    "description": "...",
    "is_active": true,
    "pso_type": {
      "id": 56,
      "name": "User",
      "alias": "usr",
      "description": "...",
      "is_active": true,
      "system_required": true,
      "creation_form_instance_id": 1,
      "profile_form_instance_id": 1
    }
  },
  "domains": [
    {
      "id": 46,
      "alias": "usr_global",
      "name": "User Global",
      "description": "...",
      "is_editable": false,
      "is_removable": false,
      "is_active": true,
      "pso_type": {
        "id": 56,
        "name": "User",
        "alias": "usr",
        "description": "...",
        "is_active": true,
        "system_required": true,
        "creation_form_instance_id": 1,
        "profile_form_instance_id": 1
      }
    }
  ],
  "privacy_level": {
    "id": 123,
    "alias": "public",
    "name": "Not Sensitive",
    "level": 100
  },
  "pso_type": {
    "id": 56,
    "name": "User",
    "alias": "usr",
    "description": "...",
    "is_active": true,
    "system_required": true,
    "creation_form_instance_id": 1,
    "profile_form_instance_id": 1
  },
  "items": [
    {}
  ],
  "options": [
    {
      "id": 198,
      "name": "Choose me!",
      "position": 9,
      "value": "198",
      "is_active": true,
      "is_selectable": true
    }
  ],
  "settings": [],
  "validation": {
    "type": "regexp",
    "attributes": {},
    "value_example": "string",
    "error_message": {
      "en": "Some text",
      "fr": "Du texte",
      "de": "Setwas Text",
      "es": "Algún texto"
    }
  },
  "has_autocomplete_settings": true,
  "autocomplete_settings": {
    "allow_extra_values": true,
    "autofill": true,
    "provider": {
      "name": {
        "en": "Some text",
        "fr": "Du texte",
        "de": "Setwas Text",
        "es": "Algún texto"
      },
      "alias": "string",
      "base_url": "https://exmaple.com/",
      "single_value_supported": true,
      "parameters": [
        {
          "name": "Name",
          "key": "alias",
          "required": true
        }
      ]
    },
    "parameters": [
      {
        "name": "Name",
        "key": "alias",
        "required": true,
        "value": "value",
        "field": {
          "id": 1,
          "name": "Field Name",
          "alias": "usr_first_name",
          "value": "RU",
          "root_field": {
            "id": 1,
            "name": "Field Name",
            "alias": "usr_first_name",
            "value": "RU",
            "root_field": "null"
          }
        }
      }
    ]
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "name": {
      "type": "string"
    },
    "position": {
      "type": "number"
    },
    "alias": {
      "type": "string"
    },
    "has_unique_data": {
      "type": "boolean",
      "description": "whether field requires values to be unique across system"
    },
    "has_value": {
      "type": "boolean",
      "description": "whether field has at least one value submitted"
    },
    "removable": {
      "type": "boolean",
      "description": "whether field can be removed from system"
    },
    "is_active": {
      "type": "boolean"
    },
    "list": {
      "type": "boolean",
      "description": "whether field can handle collection of values"
    },
    "read_only": {
      "type": "boolean",
      "description": "whether field value can be changed"
    },
    "required": {
      "type": "boolean",
      "description": "deprecated setting"
    },
    "user_required": {
      "type": "boolean",
      "description": "whether field value required by user"
    },
    "system_required": {
      "type": "boolean",
      "description": "whether field value required by system"
    },
    "type": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        },
        "alias": {
          "type": "string"
        },
        "settings": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number"
              },
              "name": {
                "type": "string"
              },
              "alias": {
                "type": "string"
              },
              "is_required": {
                "type": "boolean"
              }
            },
            "required": [
              "id",
              "name",
              "alias",
              "is_required"
            ]
          }
        },
        "supports_collection": {
          "type": "boolean"
        },
        "supports_read_only": {
          "type": "boolean"
        },
        "supports_unique": {
          "type": "boolean"
        }
      },
      "required": [
        "id",
        "name",
        "alias",
        "settings",
        "supports_collection",
        "supports_read_only",
        "supports_unique"
      ],
      "additionalProperties": false
    },
    "category": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "alias": {
          "type": "string"
        },
        "position": {
          "type": "number"
        },
        "system_required": {
          "type": "boolean"
        },
        "name": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "is_active": {
          "type": "boolean"
        },
        "pso_type": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "name": {
              "type": "string"
            },
            "alias": {
              "type": "string"
            },
            "description": {
              "type": "string"
            },
            "is_active": {
              "type": "boolean"
            },
            "system_required": {
              "type": "boolean"
            },
            "creation_form_instance_id": {
              "type": "number"
            },
            "profile_form_instance_id": {
              "type": "number"
            }
          },
          "required": [
            "id",
            "name",
            "alias",
            "description",
            "is_active",
            "system_required",
            "creation_form_instance_id",
            "profile_form_instance_id"
          ],
          "additionalProperties": false,
          "description": "Presented only if `include` was send"
        }
      },
      "required": [
        "id",
        "alias",
        "position",
        "system_required",
        "name",
        "description",
        "is_active"
      ],
      "additionalProperties": false
    },
    "domains": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number"
          },
          "alias": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "is_editable": {
            "type": "boolean"
          },
          "is_removable": {
            "type": "boolean"
          },
          "is_active": {
            "type": "boolean"
          },
          "pso_type": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number"
              },
              "name": {
                "type": "string"
              },
              "alias": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "is_active": {
                "type": "boolean"
              },
              "system_required": {
                "type": "boolean"
              },
              "creation_form_instance_id": {
                "type": "number"
              },
              "profile_form_instance_id": {
                "type": "number"
              }
            },
            "required": [
              "id",
              "name",
              "alias",
              "description",
              "is_active",
              "system_required",
              "creation_form_instance_id",
              "profile_form_instance_id"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "id",
          "alias",
          "name",
          "description",
          "is_editable",
          "is_removable",
          "is_active"
        ]
      }
    },
    "privacy_level": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "alias": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "level": {
          "type": "number"
        }
      },
      "required": [
        "id",
        "alias",
        "name",
        "level"
      ],
      "additionalProperties": false
    },
    "pso_type": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        },
        "alias": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "is_active": {
          "type": "boolean"
        },
        "system_required": {
          "type": "boolean"
        },
        "creation_form_instance_id": {
          "type": "number"
        },
        "profile_form_instance_id": {
          "type": "number"
        }
      },
      "required": [
        "id",
        "name",
        "alias",
        "description",
        "is_active",
        "system_required",
        "creation_form_instance_id",
        "profile_form_instance_id"
      ],
      "additionalProperties": false
    },
    "items": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": "object",
        "properties": {}
      }
    },
    "options": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number"
          },
          "name": {
            "type": "string"
          },
          "position": {
            "type": "number"
          },
          "value": {
            "type": "string"
          },
          "is_active": {
            "type": "boolean"
          },
          "is_selectable": {
            "type": "boolean",
            "description": "Can select on front this option (Using only in Hierarchy field))"
          }
        },
        "required": [
          "id",
          "name",
          "position",
          "value",
          "is_active",
          "is_selectable"
        ]
      },
      "description": "List of options with possible (allowed) values."
    },
    "settings": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Common field settings"
    },
    "validation": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string"
        },
        "attributes": {
          "type": "object",
          "properties": {}
        },
        "value_example": {
          "type": "string"
        },
        "error_message": {
          "type": "object",
          "properties": {
            "en": {
              "type": "string"
            },
            "fr": {
              "type": "string"
            },
            "de": {
              "type": "string"
            },
            "es": {
              "type": "string"
            }
          },
          "required": [
            "en",
            "fr",
            "de",
            "es"
          ]
        }
      },
      "required": [
        "type",
        "value_example",
        "error_message"
      ]
    },
    "has_autocomplete_settings": {
      "type": "boolean"
    },
    "autocomplete_settings": {
      "type": "object",
      "properties": {
        "allow_extra_values": {
          "type": "boolean"
        },
        "autofill": {
          "type": "boolean"
        },
        "provider": {
          "type": "object",
          "properties": {
            "name": {
              "type": "object",
              "properties": {
                "en": {
                  "type": "string"
                },
                "fr": {
                  "type": "string"
                },
                "de": {
                  "type": "string"
                },
                "es": {
                  "type": "string"
                }
              },
              "required": [
                "en",
                "fr",
                "de",
                "es"
              ]
            },
            "alias": {
              "type": "string"
            },
            "base_url": {
              "type": "string"
            },
            "single_value_supported": {
              "type": "boolean"
            },
            "parameters": {
              "type": "array"
            }
          },
          "required": [
            "name",
            "alias",
            "base_url",
            "single_value_supported",
            "parameters"
          ]
        },
        "parameters": {
          "type": "array"
        }
      },
      "required": [
        "allow_extra_values",
        "autofill",
        "provider",
        "parameters"
      ]
    }
  },
  "required": [
    "id",
    "name",
    "position",
    "alias",
    "has_unique_data",
    "has_value",
    "removable",
    "is_active",
    "list",
    "read_only",
    "required",
    "user_required",
    "system_required",
    "validation",
    "has_autocomplete_settings",
    "autocomplete_settings"
  ]
}
Response  202
HideShow
Headers
Content-Type: application/json
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 400
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Files

Upload files to using it in answers.

Files

Create
POST/files/{type}

Upload a new file.

Example URI

POST https://rest.monportailrh.com/files/users
URI Parameters
HideShow
type
users, users_default, news, messages, logo (optional) Example: users

You could provide it to specify entity of file

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Body
{
  "name": "image.jpg",
  "file": {}
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "file": {
      "type": "object",
      "properties": {},
      "description": "file to upload. Max size 5 megabytes."
    }
  },
  "required": [
    "file"
  ]
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "name": "image.jpg",
    "url": "http://example.com/images/logo.jpg"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "url": {
          "type": "string"
        }
      },
      "required": [
        "name",
        "url"
      ],
      "additionalProperties": false
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 400
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Forms

Forms allow to group fields which is make them easy to use Forms also allows to set view/edit restriction on fields

Management Permissions:

  • forms.view - Allows to view forms

  • forms.create.* - Allows to create forms

  • forms.edit.* - Allows to update forms

  • forms.delete.* - Allows to delete forms

Forms

Common List
GET/forms{?name,pso-type,active,include-standard,sort-by,sort-direction,page,per-page,no-pagination}

Get list of forms matches specified filters

Example URI

GET https://rest.monportailrh.com/forms?name=form name to search on&pso-type=usr&active=true&include-standard=true&sort-by=name&sort-direction=asc&page=1&per-page=10&no-pagination=false
URI Parameters
HideShow
sort-by
name (optional) Example: name
sort-direction
asc, desc (optional) Example: asc
active
boolean (optional) Example: true
name
string (optional) Example: form name to search on
include-standard
boolean (optional) Example: true

Include creation and profile forms

pso-type
string (optional) Example: usr

PSO type alias to filtering

page
number (required) Example: 1

Page number. 1 by default

per-page
number (required) Example: 10

Number of items per page, 25 by default

no-pagination
boolean (required) Example: false

if presented and positive pagination will not be applied. All available items will be returned.

Note: it may have significant impact on the performance

Note: once this option positive and presented - meta attribute with pagination data will be omit in response

Request
HideShow
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": 1,
      "name": "Form Name",
      "description": "Form Description",
      "is_active": true,
      "removable": true,
      "has_assigned": true,
      "fields": [
        {
          "id": 1,
          "name": "Field Name",
          "position": 5,
          "alias": "usr_first_name",
          "has_unique_data": false,
          "has_value": true,
          "removable": false,
          "is_active": true,
          "list": false,
          "read_only": false,
          "required": true,
          "user_required": true,
          "system_required": true,
          "type": {
            "id": 1,
            "name": "Data Type Name",
            "alias": "data_type_alias",
            "settings": [
              {
                "id": 1,
                "name": "Data Type Setting Name",
                "alias": "data_type_setting_alias",
                "is_required": true
              }
            ],
            "supports_collection": false,
            "supports_read_only": false,
            "supports_unique": false
          },
          "category": {
            "id": 32,
            "alias": "usr_identity",
            "position": 5,
            "system_required": true,
            "name": "Identity",
            "description": "...",
            "is_active": true,
            "pso_type": {
              "id": 56,
              "name": "User",
              "alias": "usr",
              "description": "...",
              "is_active": true,
              "system_required": true,
              "creation_form_instance_id": 1,
              "profile_form_instance_id": 1
            }
          },
          "domains": [
            {
              "id": 46,
              "alias": "usr_global",
              "name": "User Global",
              "description": "...",
              "is_editable": false,
              "is_removable": false,
              "is_active": true,
              "pso_type": {
                "id": 56,
                "name": "User",
                "alias": "usr",
                "description": "...",
                "is_active": true,
                "system_required": true,
                "creation_form_instance_id": 1,
                "profile_form_instance_id": 1
              }
            }
          ],
          "privacy_level": {
            "id": 123,
            "alias": "public",
            "name": "Not Sensitive",
            "level": 100
          },
          "pso_type": {
            "id": 56,
            "name": "User",
            "alias": "usr",
            "description": "...",
            "is_active": true,
            "system_required": true,
            "creation_form_instance_id": 1,
            "profile_form_instance_id": 1
          },
          "items": [
            {}
          ],
          "options": [
            {
              "id": 198,
              "name": "Choose me!",
              "position": 9,
              "value": "198",
              "is_active": true,
              "is_selectable": true
            }
          ],
          "settings": [],
          "validation": {
            "type": "regexp",
            "attributes": {},
            "value_example": "string",
            "error_message": {
              "en": "Some text",
              "fr": "Du texte",
              "de": "Setwas Text",
              "es": "Algún texto"
            }
          },
          "has_autocomplete_settings": true,
          "autocomplete_settings": {
            "allow_extra_values": true,
            "autofill": true,
            "provider": {
              "name": {
                "en": "Some text",
                "fr": "Du texte",
                "de": "Setwas Text",
                "es": "Algún texto"
              },
              "alias": "string",
              "base_url": "https://exmaple.com/",
              "single_value_supported": true,
              "parameters": [
                {
                  "name": "Name",
                  "key": "alias",
                  "required": true
                }
              ]
            },
            "parameters": [
              {
                "name": "Name",
                "key": "alias",
                "required": true,
                "value": "value",
                "field": {
                  "id": 1,
                  "name": "Field Name",
                  "alias": "usr_first_name",
                  "value": "RU",
                  "root_field": {
                    "id": 1,
                    "name": "Field Name",
                    "alias": "usr_first_name",
                    "value": "RU",
                    "root_field": "null"
                  }
                }
              }
            ]
          }
        }
      ],
      "pso_type": {
        "id": 56,
        "name": "User",
        "alias": "usr",
        "description": "...",
        "is_active": true,
        "system_required": true,
        "creation_form_instance_id": 1,
        "profile_form_instance_id": 1
      }
    }
  ],
  "meta": {
    "pagination": {
      "total": 238,
      "count": 25,
      "per_page": 25,
      "current_page": 2,
      "total_pages": 10,
      "links": {
        "previous": "http://example.com/api/<endpoint>?page=1",
        "next": "http://example.com/api/<endpoint>?page=3"
      }
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number"
          },
          "name": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "is_active": {
            "type": "boolean"
          },
          "removable": {
            "type": "boolean"
          },
          "has_assigned": {
            "type": "boolean"
          },
          "fields": {
            "type": "array"
          },
          "pso_type": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number"
              },
              "name": {
                "type": "string"
              },
              "alias": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "is_active": {
                "type": "boolean"
              },
              "system_required": {
                "type": "boolean"
              },
              "creation_form_instance_id": {
                "type": "number"
              },
              "profile_form_instance_id": {
                "type": "number"
              }
            },
            "required": [
              "id",
              "name",
              "alias",
              "description",
              "is_active",
              "system_required",
              "creation_form_instance_id",
              "profile_form_instance_id"
            ]
          }
        },
        "required": [
          "id",
          "name",
          "description",
          "is_active",
          "removable",
          "has_assigned"
        ]
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number"
            },
            "count": {
              "type": "number"
            },
            "per_page": {
              "type": "number"
            },
            "current_page": {
              "type": "number"
            },
            "total_pages": {
              "type": "number"
            },
            "links": {
              "type": "object",
              "properties": {
                "previous": {
                  "type": "string"
                },
                "next": {
                  "type": "string"
                }
              },
              "required": [
                "previous",
                "next"
              ]
            }
          },
          "required": [
            "total",
            "count",
            "per_page",
            "current_page",
            "total_pages",
            "links"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "pagination"
      ]
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/forms/{id}

Get details for selected form

Example URI

GET https://rest.monportailrh.com/forms/123
URI Parameters
HideShow
id
string (required) Example: 123
Request
HideShow
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 1,
    "name": "Form Name",
    "description": "Form Description",
    "is_active": true,
    "removable": true,
    "has_assigned": true,
    "fields": [
      {
        "id": 1,
        "name": "Field Name",
        "position": 5,
        "alias": "usr_first_name",
        "has_unique_data": false,
        "has_value": true,
        "removable": false,
        "is_active": true,
        "list": false,
        "read_only": false,
        "required": true,
        "user_required": true,
        "system_required": true,
        "type": {
          "id": 1,
          "name": "Data Type Name",
          "alias": "data_type_alias",
          "settings": [
            {
              "id": 1,
              "name": "Data Type Setting Name",
              "alias": "data_type_setting_alias",
              "is_required": true
            }
          ],
          "supports_collection": false,
          "supports_read_only": false,
          "supports_unique": false
        },
        "category": {
          "id": 32,
          "alias": "usr_identity",
          "position": 5,
          "system_required": true,
          "name": "Identity",
          "description": "...",
          "is_active": true,
          "pso_type": {
            "id": 56,
            "name": "User",
            "alias": "usr",
            "description": "...",
            "is_active": true,
            "system_required": true,
            "creation_form_instance_id": 1,
            "profile_form_instance_id": 1
          }
        },
        "domains": [
          {
            "id": 46,
            "alias": "usr_global",
            "name": "User Global",
            "description": "...",
            "is_editable": false,
            "is_removable": false,
            "is_active": true,
            "pso_type": {
              "id": 56,
              "name": "User",
              "alias": "usr",
              "description": "...",
              "is_active": true,
              "system_required": true,
              "creation_form_instance_id": 1,
              "profile_form_instance_id": 1
            }
          }
        ],
        "privacy_level": {
          "id": 123,
          "alias": "public",
          "name": "Not Sensitive",
          "level": 100
        },
        "pso_type": {
          "id": 56,
          "name": "User",
          "alias": "usr",
          "description": "...",
          "is_active": true,
          "system_required": true,
          "creation_form_instance_id": 1,
          "profile_form_instance_id": 1
        },
        "items": [
          {}
        ],
        "options": [
          {
            "id": 198,
            "name": "Choose me!",
            "position": 9,
            "value": "198",
            "is_active": true,
            "is_selectable": true
          }
        ],
        "settings": [],
        "validation": {
          "type": "regexp",
          "attributes": {},
          "value_example": "string",
          "error_message": {
            "en": "Some text",
            "fr": "Du texte",
            "de": "Setwas Text",
            "es": "Algún texto"
          }
        },
        "has_autocomplete_settings": true,
        "autocomplete_settings": {
          "allow_extra_values": true,
          "autofill": true,
          "provider": {
            "name": {
              "en": "Some text",
              "fr": "Du texte",
              "de": "Setwas Text",
              "es": "Algún texto"
            },
            "alias": "string",
            "base_url": "https://exmaple.com/",
            "single_value_supported": true,
            "parameters": [
              {
                "name": "Name",
                "key": "alias",
                "required": true
              }
            ]
          },
          "parameters": [
            {
              "name": "Name",
              "key": "alias",
              "required": true,
              "value": "value",
              "field": {
                "id": 1,
                "name": "Field Name",
                "alias": "usr_first_name",
                "value": "RU",
                "root_field": {
                  "id": 1,
                  "name": "Field Name",
                  "alias": "usr_first_name",
                  "value": "RU",
                  "root_field": "null"
                }
              }
            }
          ]
        }
      }
    ],
    "pso_type": {
      "id": 56,
      "name": "User",
      "alias": "usr",
      "description": "...",
      "is_active": true,
      "system_required": true,
      "creation_form_instance_id": 1,
      "profile_form_instance_id": 1
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "is_active": {
          "type": "boolean"
        },
        "removable": {
          "type": "boolean"
        },
        "has_assigned": {
          "type": "boolean"
        },
        "fields": {
          "type": "array"
        },
        "pso_type": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "name": {
              "type": "string"
            },
            "alias": {
              "type": "string"
            },
            "description": {
              "type": "string"
            },
            "is_active": {
              "type": "boolean"
            },
            "system_required": {
              "type": "boolean"
            },
            "creation_form_instance_id": {
              "type": "number"
            },
            "profile_form_instance_id": {
              "type": "number"
            }
          },
          "required": [
            "id",
            "name",
            "alias",
            "description",
            "is_active",
            "system_required",
            "creation_form_instance_id",
            "profile_form_instance_id"
          ]
        }
      },
      "required": [
        "id",
        "name",
        "description",
        "is_active",
        "removable",
        "has_assigned"
      ]
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Create
POST/forms

Create new form

Example URI

POST https://rest.monportailrh.com/forms
Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Body
{
  "name": {
    "en": "Some text",
    "fr": "Du texte",
    "de": "Setwas Text",
    "es": "Algún texto"
  },
  "description": {
    "en": "Some text",
    "fr": "Du texte",
    "de": "Setwas Text",
    "es": "Algún texto"
  },
  "is_active": true,
  "pso_type": "usr",
  "fields": [
    {
      "field_id": 1,
      "field_alias": "1",
      "position": 1,
      "settings": [
        {
          "id": 1,
          "alias": "setting_alias",
          "name": "Setting Name"
        }
      ],
      "permissions": [
        {
          "id": 1,
          "alias": "feature_alias",
          "name": "Feature Name"
        }
      ],
      "user_required": true,
      "items": [
        {
          "field_id": 1,
          "field_alias": "1",
          "user_required": true
        }
      ]
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "object",
      "properties": {
        "en": {
          "type": "string"
        },
        "fr": {
          "type": "string"
        },
        "de": {
          "type": "string"
        },
        "es": {
          "type": "string"
        }
      },
      "required": [
        "en",
        "fr",
        "de",
        "es"
      ]
    },
    "description": {
      "type": "object",
      "properties": {
        "en": {
          "type": "string"
        },
        "fr": {
          "type": "string"
        },
        "de": {
          "type": "string"
        },
        "es": {
          "type": "string"
        }
      },
      "required": [
        "en",
        "fr",
        "de",
        "es"
      ]
    },
    "is_active": {
      "type": "boolean"
    },
    "pso_type": {
      "type": "string"
    },
    "fields": {
      "type": "array"
    }
  },
  "required": [
    "name",
    "description",
    "is_active",
    "pso_type",
    "fields"
  ]
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 1,
    "name": "Form Name",
    "description": "Form Description",
    "is_active": true,
    "removable": true,
    "has_assigned": true,
    "fields": [
      {
        "id": 1,
        "name": "Field Name",
        "position": 5,
        "alias": "usr_first_name",
        "has_unique_data": false,
        "has_value": true,
        "removable": false,
        "is_active": true,
        "list": false,
        "read_only": false,
        "required": true,
        "user_required": true,
        "system_required": true,
        "type": {
          "id": 1,
          "name": "Data Type Name",
          "alias": "data_type_alias",
          "settings": [
            {
              "id": 1,
              "name": "Data Type Setting Name",
              "alias": "data_type_setting_alias",
              "is_required": true
            }
          ],
          "supports_collection": false,
          "supports_read_only": false,
          "supports_unique": false
        },
        "category": {
          "id": 32,
          "alias": "usr_identity",
          "position": 5,
          "system_required": true,
          "name": "Identity",
          "description": "...",
          "is_active": true,
          "pso_type": {
            "id": 56,
            "name": "User",
            "alias": "usr",
            "description": "...",
            "is_active": true,
            "system_required": true,
            "creation_form_instance_id": 1,
            "profile_form_instance_id": 1
          }
        },
        "domains": [
          {
            "id": 46,
            "alias": "usr_global",
            "name": "User Global",
            "description": "...",
            "is_editable": false,
            "is_removable": false,
            "is_active": true,
            "pso_type": {
              "id": 56,
              "name": "User",
              "alias": "usr",
              "description": "...",
              "is_active": true,
              "system_required": true,
              "creation_form_instance_id": 1,
              "profile_form_instance_id": 1
            }
          }
        ],
        "privacy_level": {
          "id": 123,
          "alias": "public",
          "name": "Not Sensitive",
          "level": 100
        },
        "pso_type": {
          "id": 56,
          "name": "User",
          "alias": "usr",
          "description": "...",
          "is_active": true,
          "system_required": true,
          "creation_form_instance_id": 1,
          "profile_form_instance_id": 1
        },
        "items": [
          {}
        ],
        "options": [
          {
            "id": 198,
            "name": "Choose me!",
            "position": 9,
            "value": "198",
            "is_active": true,
            "is_selectable": true
          }
        ],
        "settings": [],
        "validation": {
          "type": "regexp",
          "attributes": {},
          "value_example": "string",
          "error_message": {
            "en": "Some text",
            "fr": "Du texte",
            "de": "Setwas Text",
            "es": "Algún texto"
          }
        },
        "has_autocomplete_settings": true,
        "autocomplete_settings": {
          "allow_extra_values": true,
          "autofill": true,
          "provider": {
            "name": {
              "en": "Some text",
              "fr": "Du texte",
              "de": "Setwas Text",
              "es": "Algún texto"
            },
            "alias": "string",
            "base_url": "https://exmaple.com/",
            "single_value_supported": true,
            "parameters": [
              {
                "name": "Name",
                "key": "alias",
                "required": true
              }
            ]
          },
          "parameters": [
            {
              "name": "Name",
              "key": "alias",
              "required": true,
              "value": "value",
              "field": {
                "id": 1,
                "name": "Field Name",
                "alias": "usr_first_name",
                "value": "RU",
                "root_field": {
                  "id": 1,
                  "name": "Field Name",
                  "alias": "usr_first_name",
                  "value": "RU",
                  "root_field": "null"
                }
              }
            }
          ]
        }
      }
    ],
    "pso_type": {
      "id": 56,
      "name": "User",
      "alias": "usr",
      "description": "...",
      "is_active": true,
      "system_required": true,
      "creation_form_instance_id": 1,
      "profile_form_instance_id": 1
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "is_active": {
          "type": "boolean"
        },
        "removable": {
          "type": "boolean"
        },
        "has_assigned": {
          "type": "boolean"
        },
        "fields": {
          "type": "array"
        },
        "pso_type": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "name": {
              "type": "string"
            },
            "alias": {
              "type": "string"
            },
            "description": {
              "type": "string"
            },
            "is_active": {
              "type": "boolean"
            },
            "system_required": {
              "type": "boolean"
            },
            "creation_form_instance_id": {
              "type": "number"
            },
            "profile_form_instance_id": {
              "type": "number"
            }
          },
          "required": [
            "id",
            "name",
            "alias",
            "description",
            "is_active",
            "system_required",
            "creation_form_instance_id",
            "profile_form_instance_id"
          ]
        }
      },
      "required": [
        "id",
        "name",
        "description",
        "is_active",
        "removable",
        "has_assigned"
      ],
      "additionalProperties": false
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 400
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
POST/forms/{id}

Update form

Example URI

POST https://rest.monportailrh.com/forms/123
URI Parameters
HideShow
id
string (required) Example: 123
Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Body
{
  "name": {
    "en": "Some text",
    "fr": "Du texte",
    "de": "Setwas Text",
    "es": "Algún texto"
  },
  "description": {
    "en": "Some text",
    "fr": "Du texte",
    "de": "Setwas Text",
    "es": "Algún texto"
  },
  "is_active": true,
  "fields": [
    {
      "field_id": 1,
      "field_alias": "1",
      "position": 1,
      "settings": [
        {
          "id": 1,
          "alias": "setting_alias",
          "name": "Setting Name"
        }
      ],
      "permissions": [
        {
          "id": 1,
          "alias": "feature_alias",
          "name": "Feature Name"
        }
      ],
      "user_required": true,
      "items": [
        {
          "field_id": 1,
          "field_alias": "1",
          "user_required": true
        }
      ]
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "object",
      "properties": {
        "en": {
          "type": "string"
        },
        "fr": {
          "type": "string"
        },
        "de": {
          "type": "string"
        },
        "es": {
          "type": "string"
        }
      },
      "required": [
        "en",
        "fr",
        "de",
        "es"
      ]
    },
    "description": {
      "type": "object",
      "properties": {
        "en": {
          "type": "string"
        },
        "fr": {
          "type": "string"
        },
        "de": {
          "type": "string"
        },
        "es": {
          "type": "string"
        }
      },
      "required": [
        "en",
        "fr",
        "de",
        "es"
      ]
    },
    "is_active": {
      "type": "boolean"
    },
    "fields": {
      "type": "array"
    }
  }
}
Response  202
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 1,
    "name": "Form Name",
    "description": "Form Description",
    "is_active": true,
    "removable": true,
    "has_assigned": true,
    "fields": [
      {
        "id": 1,
        "name": "Field Name",
        "position": 5,
        "alias": "usr_first_name",
        "has_unique_data": false,
        "has_value": true,
        "removable": false,
        "is_active": true,
        "list": false,
        "read_only": false,
        "required": true,
        "user_required": true,
        "system_required": true,
        "type": {
          "id": 1,
          "name": "Data Type Name",
          "alias": "data_type_alias",
          "settings": [
            {
              "id": 1,
              "name": "Data Type Setting Name",
              "alias": "data_type_setting_alias",
              "is_required": true
            }
          ],
          "supports_collection": false,
          "supports_read_only": false,
          "supports_unique": false
        },
        "category": {
          "id": 32,
          "alias": "usr_identity",
          "position": 5,
          "system_required": true,
          "name": "Identity",
          "description": "...",
          "is_active": true,
          "pso_type": {
            "id": 56,
            "name": "User",
            "alias": "usr",
            "description": "...",
            "is_active": true,
            "system_required": true,
            "creation_form_instance_id": 1,
            "profile_form_instance_id": 1
          }
        },
        "domains": [
          {
            "id": 46,
            "alias": "usr_global",
            "name": "User Global",
            "description": "...",
            "is_editable": false,
            "is_removable": false,
            "is_active": true,
            "pso_type": {
              "id": 56,
              "name": "User",
              "alias": "usr",
              "description": "...",
              "is_active": true,
              "system_required": true,
              "creation_form_instance_id": 1,
              "profile_form_instance_id": 1
            }
          }
        ],
        "privacy_level": {
          "id": 123,
          "alias": "public",
          "name": "Not Sensitive",
          "level": 100
        },
        "pso_type": {
          "id": 56,
          "name": "User",
          "alias": "usr",
          "description": "...",
          "is_active": true,
          "system_required": true,
          "creation_form_instance_id": 1,
          "profile_form_instance_id": 1
        },
        "items": [
          {}
        ],
        "options": [
          {
            "id": 198,
            "name": "Choose me!",
            "position": 9,
            "value": "198",
            "is_active": true,
            "is_selectable": true
          }
        ],
        "settings": [],
        "validation": {
          "type": "regexp",
          "attributes": {},
          "value_example": "string",
          "error_message": {
            "en": "Some text",
            "fr": "Du texte",
            "de": "Setwas Text",
            "es": "Algún texto"
          }
        },
        "has_autocomplete_settings": true,
        "autocomplete_settings": {
          "allow_extra_values": true,
          "autofill": true,
          "provider": {
            "name": {
              "en": "Some text",
              "fr": "Du texte",
              "de": "Setwas Text",
              "es": "Algún texto"
            },
            "alias": "string",
            "base_url": "https://exmaple.com/",
            "single_value_supported": true,
            "parameters": [
              {
                "name": "Name",
                "key": "alias",
                "required": true
              }
            ]
          },
          "parameters": [
            {
              "name": "Name",
              "key": "alias",
              "required": true,
              "value": "value",
              "field": {
                "id": 1,
                "name": "Field Name",
                "alias": "usr_first_name",
                "value": "RU",
                "root_field": {
                  "id": 1,
                  "name": "Field Name",
                  "alias": "usr_first_name",
                  "value": "RU",
                  "root_field": "null"
                }
              }
            }
          ]
        }
      }
    ],
    "pso_type": {
      "id": 56,
      "name": "User",
      "alias": "usr",
      "description": "...",
      "is_active": true,
      "system_required": true,
      "creation_form_instance_id": 1,
      "profile_form_instance_id": 1
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "is_active": {
          "type": "boolean"
        },
        "removable": {
          "type": "boolean"
        },
        "has_assigned": {
          "type": "boolean"
        },
        "fields": {
          "type": "array"
        },
        "pso_type": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "name": {
              "type": "string"
            },
            "alias": {
              "type": "string"
            },
            "description": {
              "type": "string"
            },
            "is_active": {
              "type": "boolean"
            },
            "system_required": {
              "type": "boolean"
            },
            "creation_form_instance_id": {
              "type": "number"
            },
            "profile_form_instance_id": {
              "type": "number"
            }
          },
          "required": [
            "id",
            "name",
            "alias",
            "description",
            "is_active",
            "system_required",
            "creation_form_instance_id",
            "profile_form_instance_id"
          ]
        }
      },
      "required": [
        "id",
        "name",
        "description",
        "is_active",
        "removable",
        "has_assigned"
      ],
      "additionalProperties": false
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 400
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete
DELETE/form/{id}

Remove form

Example URI

DELETE https://rest.monportailrh.com/form/123
URI Parameters
HideShow
id
string (required) Example: 123
Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Response  204
HideShow
Headers
Content-Type: application/json
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 400
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Detach one field
DELETE/form/{form}/fields/{field}

Detach a single field from form

Example URI

DELETE https://rest.monportailrh.com/form/123/fields/123
URI Parameters
HideShow
form
number (required) Example: 123

form id

field
number (required) Example: 123

field id

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Response  204
HideShow
Headers
Content-Type: application/json
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 400
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Detach Fields
DELETE/form/{form}/fields/

Detach fields from form

Example URI

DELETE https://rest.monportailrh.com/form/123/fields/
URI Parameters
HideShow
form
number (required) Example: 123

form id

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Body
[
  1
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}
Response  202
HideShow
Headers
Content-Type: application/json
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 400
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Create Assignment
POST/forms/{id}/instances

Assign users to form

Requested user permissions:

  • form_assignments.view

Example URI

POST https://rest.monportailrh.com/forms/123/instances
URI Parameters
HideShow
id
string (required) Example: 123

form id

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Body
{
  "name": {
    "en": "Some text",
    "fr": "Du texte",
    "de": "Setwas Text",
    "es": "Algún texto"
  },
  "description": {
    "en": "Some text",
    "fr": "Du texte",
    "de": "Setwas Text",
    "es": "Algún texto"
  },
  "rules": {
    "access_rule_type_id": 1,
    "value": "Hello, world!"
  },
  "workflow_steps": {
    "step": 1,
    "relation": "mentor"
  },
  "settings": [
    {
      "id": 1,
      "alias": "setting_alias",
      "name": "Setting Name"
    }
  ],
  "is_hidden": false
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "object",
      "properties": {
        "en": {
          "type": "string"
        },
        "fr": {
          "type": "string"
        },
        "de": {
          "type": "string"
        },
        "es": {
          "type": "string"
        }
      },
      "required": [
        "en",
        "fr",
        "de",
        "es"
      ]
    },
    "description": {
      "type": "object",
      "properties": {
        "en": {
          "type": "string"
        },
        "fr": {
          "type": "string"
        },
        "de": {
          "type": "string"
        },
        "es": {
          "type": "string"
        }
      },
      "required": [
        "en",
        "fr",
        "de",
        "es"
      ]
    },
    "rules": {
      "type": "object",
      "properties": {
        "access_rule_type_id": {
          "type": "number"
        },
        "value": {
          "type": "string"
        }
      },
      "required": [
        "access_rule_type_id",
        "value"
      ]
    },
    "workflow_steps": {
      "type": "object",
      "properties": {
        "step": {
          "type": "number"
        },
        "relation": {
          "type": "string"
        }
      },
      "required": [
        "step",
        "relation"
      ]
    },
    "settings": {
      "type": "array"
    },
    "is_hidden": {
      "type": "boolean"
    }
  },
  "required": [
    "rules",
    "workflow_steps",
    "settings",
    "is_hidden"
  ]
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 1,
    "name": "Form Assignment Name",
    "description": "Form Assignment Description",
    "form_id": 12,
    "is_active": true,
    "removable": true,
    "settings": [
      {
        "id": 1,
        "alias": "setting_alias",
        "name": "Setting Name"
      }
    ],
    "access_rules": [
      {
        "id": 123,
        "access_rule_type": {
          "id": 1,
          "alias": "population_type_alias",
          "name": "Population Type Name"
        },
        "value": ""
      }
    ],
    "population_type": [
      {
        "id": 1,
        "alias": "population_type_alias",
        "name": "Population Type Name"
      }
    ],
    "workflow_steps": {
      "relation": "hr",
      "step": 1,
      "field": {
        "id": 1,
        "name": "Field Name",
        "position": 5,
        "alias": "usr_first_name",
        "has_unique_data": false,
        "has_value": true,
        "removable": false,
        "is_active": true,
        "list": false,
        "read_only": false,
        "required": true,
        "user_required": true,
        "system_required": true,
        "type": {
          "id": 1,
          "name": "Data Type Name",
          "alias": "data_type_alias",
          "settings": [
            {
              "id": 1,
              "name": "Data Type Setting Name",
              "alias": "data_type_setting_alias",
              "is_required": true
            }
          ],
          "supports_collection": false,
          "supports_read_only": false,
          "supports_unique": false
        },
        "category": {
          "id": 32,
          "alias": "usr_identity",
          "position": 5,
          "system_required": true,
          "name": "Identity",
          "description": "...",
          "is_active": true,
          "pso_type": {
            "id": 56,
            "name": "User",
            "alias": "usr",
            "description": "...",
            "is_active": true,
            "system_required": true,
            "creation_form_instance_id": 1,
            "profile_form_instance_id": 1
          }
        },
        "domains": [
          {
            "id": 46,
            "alias": "usr_global",
            "name": "User Global",
            "description": "...",
            "is_editable": false,
            "is_removable": false,
            "is_active": true,
            "pso_type": {
              "id": 56,
              "name": "User",
              "alias": "usr",
              "description": "...",
              "is_active": true,
              "system_required": true,
              "creation_form_instance_id": 1,
              "profile_form_instance_id": 1
            }
          }
        ],
        "privacy_level": {
          "id": 123,
          "alias": "public",
          "name": "Not Sensitive",
          "level": 100
        },
        "pso_type": {
          "id": 56,
          "name": "User",
          "alias": "usr",
          "description": "...",
          "is_active": true,
          "system_required": true,
          "creation_form_instance_id": 1,
          "profile_form_instance_id": 1
        },
        "items": [
          {}
        ],
        "options": [
          {
            "id": 198,
            "name": "Choose me!",
            "position": 9,
            "value": "198",
            "is_active": true,
            "is_selectable": true
          }
        ],
        "settings": [],
        "validation": {
          "type": "regexp",
          "attributes": {},
          "value_example": "string",
          "error_message": {
            "en": "Some text",
            "fr": "Du texte",
            "de": "Setwas Text",
            "es": "Algún texto"
          }
        },
        "has_autocomplete_settings": true,
        "autocomplete_settings": {
          "allow_extra_values": true,
          "autofill": true,
          "provider": {
            "name": {
              "en": "Some text",
              "fr": "Du texte",
              "de": "Setwas Text",
              "es": "Algún texto"
            },
            "alias": "string",
            "base_url": "https://exmaple.com/",
            "single_value_supported": true,
            "parameters": [
              {
                "name": "Name",
                "key": "alias",
                "required": true
              }
            ]
          },
          "parameters": [
            {
              "name": "Name",
              "key": "alias",
              "required": true,
              "value": "value",
              "field": {
                "id": 1,
                "name": "Field Name",
                "alias": "usr_first_name",
                "value": "RU",
                "root_field": {
                  "id": 1,
                  "name": "Field Name",
                  "alias": "usr_first_name",
                  "value": "RU",
                  "root_field": "null"
                }
              }
            }
          ]
        }
      }
    },
    "pso_type": {
      "id": 56,
      "name": "User",
      "alias": "usr",
      "description": "...",
      "is_active": true,
      "system_required": true,
      "creation_form_instance_id": 1,
      "profile_form_instance_id": 1
    },
    "population_details": {
      "dynamic": false,
      "includes": [
        "1",
        "2"
      ],
      "excludes": [
        "3",
        "4"
      ],
      "specific_psos": [
        5,
        6
      ]
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "form_id": {
          "type": "number"
        },
        "is_active": {
          "type": "boolean"
        },
        "removable": {
          "type": "boolean"
        },
        "settings": {
          "type": "array"
        },
        "access_rules": {
          "type": "array"
        },
        "population_type": {
          "type": "array"
        },
        "workflow_steps": {
          "type": "object",
          "properties": {
            "relation": {
              "type": "string"
            },
            "step": {
              "type": "number"
            },
            "field": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number"
                },
                "name": {
                  "type": "string"
                },
                "position": {
                  "type": "number"
                },
                "alias": {
                  "type": "string"
                },
                "has_unique_data": {
                  "type": "boolean",
                  "description": "whether field requires values to be unique across system"
                },
                "has_value": {
                  "type": "boolean",
                  "description": "whether field has at least one value submitted"
                },
                "removable": {
                  "type": "boolean",
                  "description": "whether field can be removed from system"
                },
                "is_active": {
                  "type": "boolean"
                },
                "list": {
                  "type": "boolean",
                  "description": "whether field can handle collection of values"
                },
                "read_only": {
                  "type": "boolean",
                  "description": "whether field value can be changed"
                },
                "required": {
                  "type": "boolean",
                  "description": "deprecated setting"
                },
                "user_required": {
                  "type": "boolean",
                  "description": "whether field value required by user"
                },
                "system_required": {
                  "type": "boolean",
                  "description": "whether field value required by system"
                },
                "type": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "number"
                    },
                    "name": {
                      "type": "string"
                    },
                    "alias": {
                      "type": "string"
                    },
                    "settings": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "number"
                          },
                          "name": {
                            "type": "string"
                          },
                          "alias": {
                            "type": "string"
                          },
                          "is_required": {
                            "type": "boolean"
                          }
                        },
                        "required": [
                          "id",
                          "name",
                          "alias",
                          "is_required"
                        ]
                      }
                    },
                    "supports_collection": {
                      "type": "boolean"
                    },
                    "supports_read_only": {
                      "type": "boolean"
                    },
                    "supports_unique": {
                      "type": "boolean"
                    }
                  },
                  "required": [
                    "id",
                    "name",
                    "alias",
                    "settings",
                    "supports_collection",
                    "supports_read_only",
                    "supports_unique"
                  ],
                  "additionalProperties": false
                },
                "category": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "number"
                    },
                    "alias": {
                      "type": "string"
                    },
                    "position": {
                      "type": "number"
                    },
                    "system_required": {
                      "type": "boolean"
                    },
                    "name": {
                      "type": "string"
                    },
                    "description": {
                      "type": "string"
                    },
                    "is_active": {
                      "type": "boolean"
                    },
                    "pso_type": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "number"
                        },
                        "name": {
                          "type": "string"
                        },
                        "alias": {
                          "type": "string"
                        },
                        "description": {
                          "type": "string"
                        },
                        "is_active": {
                          "type": "boolean"
                        },
                        "system_required": {
                          "type": "boolean"
                        },
                        "creation_form_instance_id": {
                          "type": "number"
                        },
                        "profile_form_instance_id": {
                          "type": "number"
                        }
                      },
                      "required": [
                        "id",
                        "name",
                        "alias",
                        "description",
                        "is_active",
                        "system_required",
                        "creation_form_instance_id",
                        "profile_form_instance_id"
                      ],
                      "additionalProperties": false,
                      "description": "Presented only if `include` was send"
                    }
                  },
                  "required": [
                    "id",
                    "alias",
                    "position",
                    "system_required",
                    "name",
                    "description",
                    "is_active"
                  ],
                  "additionalProperties": false
                },
                "domains": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "number"
                      },
                      "alias": {
                        "type": "string"
                      },
                      "name": {
                        "type": "string"
                      },
                      "description": {
                        "type": "string"
                      },
                      "is_editable": {
                        "type": "boolean"
                      },
                      "is_removable": {
                        "type": "boolean"
                      },
                      "is_active": {
                        "type": "boolean"
                      },
                      "pso_type": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "number"
                          },
                          "name": {
                            "type": "string"
                          },
                          "alias": {
                            "type": "string"
                          },
                          "description": {
                            "type": "string"
                          },
                          "is_active": {
                            "type": "boolean"
                          },
                          "system_required": {
                            "type": "boolean"
                          },
                          "creation_form_instance_id": {
                            "type": "number"
                          },
                          "profile_form_instance_id": {
                            "type": "number"
                          }
                        },
                        "required": [
                          "id",
                          "name",
                          "alias",
                          "description",
                          "is_active",
                          "system_required",
                          "creation_form_instance_id",
                          "profile_form_instance_id"
                        ],
                        "additionalProperties": false
                      }
                    },
                    "required": [
                      "id",
                      "alias",
                      "name",
                      "description",
                      "is_editable",
                      "is_removable",
                      "is_active"
                    ]
                  }
                },
                "privacy_level": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "number"
                    },
                    "alias": {
                      "type": "string"
                    },
                    "name": {
                      "type": "string"
                    },
                    "level": {
                      "type": "number"
                    }
                  },
                  "required": [
                    "id",
                    "alias",
                    "name",
                    "level"
                  ],
                  "additionalProperties": false
                },
                "pso_type": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "number"
                    },
                    "name": {
                      "type": "string"
                    },
                    "alias": {
                      "type": "string"
                    },
                    "description": {
                      "type": "string"
                    },
                    "is_active": {
                      "type": "boolean"
                    },
                    "system_required": {
                      "type": "boolean"
                    },
                    "creation_form_instance_id": {
                      "type": "number"
                    },
                    "profile_form_instance_id": {
                      "type": "number"
                    }
                  },
                  "required": [
                    "id",
                    "name",
                    "alias",
                    "description",
                    "is_active",
                    "system_required",
                    "creation_form_instance_id",
                    "profile_form_instance_id"
                  ],
                  "additionalProperties": false
                },
                "items": {
                  "type": [
                    "array",
                    "null"
                  ],
                  "items": {
                    "type": "object",
                    "properties": {}
                  }
                },
                "options": {
                  "type": [
                    "array",
                    "null"
                  ],
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "number"
                      },
                      "name": {
                        "type": "string"
                      },
                      "position": {
                        "type": "number"
                      },
                      "value": {
                        "type": "string"
                      },
                      "is_active": {
                        "type": "boolean"
                      },
                      "is_selectable": {
                        "type": "boolean",
                        "description": "Can select on front this option (Using only in Hierarchy field))"
                      }
                    },
                    "required": [
                      "id",
                      "name",
                      "position",
                      "value",
                      "is_active",
                      "is_selectable"
                    ]
                  },
                  "description": "List of options with possible (allowed) values."
                },
                "settings": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  },
                  "description": "Common field settings"
                },
                "validation": {
                  "type": "object",
                  "properties": {
                    "type": {
                      "type": "string"
                    },
                    "attributes": {
                      "type": "object",
                      "properties": {}
                    },
                    "value_example": {
                      "type": "string"
                    },
                    "error_message": {
                      "type": "object",
                      "properties": {
                        "en": {
                          "type": "string"
                        },
                        "fr": {
                          "type": "string"
                        },
                        "de": {
                          "type": "string"
                        },
                        "es": {
                          "type": "string"
                        }
                      },
                      "required": [
                        "en",
                        "fr",
                        "de",
                        "es"
                      ]
                    }
                  },
                  "required": [
                    "type",
                    "value_example",
                    "error_message"
                  ]
                },
                "has_autocomplete_settings": {
                  "type": "boolean"
                },
                "autocomplete_settings": {
                  "type": "object",
                  "properties": {
                    "allow_extra_values": {
                      "type": "boolean"
                    },
                    "autofill": {
                      "type": "boolean"
                    },
                    "provider": {
                      "type": "object",
                      "properties": {
                        "name": {
                          "type": "object",
                          "properties": {
                            "en": {
                              "type": "string"
                            },
                            "fr": {
                              "type": "string"
                            },
                            "de": {
                              "type": "string"
                            },
                            "es": {
                              "type": "string"
                            }
                          },
                          "required": [
                            "en",
                            "fr",
                            "de",
                            "es"
                          ]
                        },
                        "alias": {
                          "type": "string"
                        },
                        "base_url": {
                          "type": "string"
                        },
                        "single_value_supported": {
                          "type": "boolean"
                        },
                        "parameters": {
                          "type": "array"
                        }
                      },
                      "required": [
                        "name",
                        "alias",
                        "base_url",
                        "single_value_supported",
                        "parameters"
                      ]
                    },
                    "parameters": {
                      "type": "array"
                    }
                  },
                  "required": [
                    "allow_extra_values",
                    "autofill",
                    "provider",
                    "parameters"
                  ]
                }
              },
              "required": [
                "id",
                "name",
                "position",
                "alias",
                "has_unique_data",
                "has_value",
                "removable",
                "is_active",
                "list",
                "read_only",
                "required",
                "user_required",
                "system_required",
                "validation",
                "has_autocomplete_settings",
                "autocomplete_settings"
              ]
            }
          },
          "required": [
            "relation",
            "step"
          ]
        },
        "pso_type": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "name": {
              "type": "string"
            },
            "alias": {
              "type": "string"
            },
            "description": {
              "type": "string"
            },
            "is_active": {
              "type": "boolean"
            },
            "system_required": {
              "type": "boolean"
            },
            "creation_form_instance_id": {
              "type": "number"
            },
            "profile_form_instance_id": {
              "type": "number"
            }
          },
          "required": [
            "id",
            "name",
            "alias",
            "description",
            "is_active",
            "system_required",
            "creation_form_instance_id",
            "profile_form_instance_id"
          ]
        },
        "population_details": {
          "type": "object",
          "properties": {
            "dynamic": {
              "type": "boolean"
            },
            "includes": {
              "type": "array"
            },
            "excludes": {
              "type": "array"
            },
            "specific_psos": {
              "type": "array"
            }
          },
          "required": [
            "dynamic",
            "includes",
            "excludes",
            "specific_psos"
          ]
        }
      },
      "required": [
        "id",
        "name",
        "description",
        "form_id",
        "is_active",
        "removable",
        "population_type",
        "population_details"
      ],
      "additionalProperties": false
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 400
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Form instances

Form instances

Form instances

List
GET/form-instances{?name,active,with-hidden,assignment-type,pso-type,include,sort-by,sort-direction,page,per-page,no-pagination}

Fetch list of Form instances

Permissions: form_assignments.view

Example URI

GET https://rest.monportailrh.com/form-instances?name=Some name&active=true&with-hidden=true&assignment-type=unique&pso-type=some_type&include=settings,access_rules&sort-by=name&sort-direction=asc&page=1&per-page=10&no-pagination=false
URI Parameters
HideShow
name
string (optional) Example: Some name
active
boolean (optional) Example: true
with-hidden
boolean (optional) Default: false Example: true
assignment-type
string (optional) Example: unique

Choices: poll permanent unique periodic

pso-type
string (optional) Example: some_type
include
string (optional) Example: settings,access_rules

Choices: settings access_rules workflow_steps pso_type

sort-by
string (optional) Default: name Example: name

Choices: name

sort-direction
string (optional) Default: asc Example: asc

Choices: asc desc

page
number (required) Example: 1

Page number. 1 by default

per-page
number (required) Example: 10

Number of items per page, 25 by default

no-pagination
boolean (required) Example: false

if presented and positive pagination will not be applied. All available items will be returned.

Note: it may have significant impact on the performance

Note: once this option positive and presented - meta attribute with pagination data will be omit in response

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": 1,
      "name": "Form instance name",
      "description": "Form instance description",
      "form_id": 123,
      "is_active": true,
      "removable": false,
      "effective_date": "2019-04-24 11:47:47"
    }
  ],
  "meta": {
    "pagination": {
      "total": 238,
      "count": 25,
      "per_page": 25,
      "current_page": 2,
      "total_pages": 10,
      "links": {
        "previous": "http://example.com/api/<endpoint>?page=1",
        "next": "http://example.com/api/<endpoint>?page=3"
      }
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number"
          },
          "name": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "form_id": {
            "type": "number"
          },
          "is_active": {
            "type": "boolean"
          },
          "removable": {
            "type": "boolean"
          },
          "effective_date": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "name",
          "description",
          "form_id",
          "is_active",
          "removable"
        ]
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number"
            },
            "count": {
              "type": "number"
            },
            "per_page": {
              "type": "number"
            },
            "current_page": {
              "type": "number"
            },
            "total_pages": {
              "type": "number"
            },
            "links": {
              "type": "object",
              "properties": {
                "previous": {
                  "type": "string"
                },
                "next": {
                  "type": "string"
                }
              },
              "required": [
                "previous",
                "next"
              ]
            }
          },
          "required": [
            "total",
            "count",
            "per_page",
            "current_page",
            "total_pages",
            "links"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "pagination"
      ]
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/form-instances/{id}

Fetch single Form instance

Permissions: form_assignments.view

Example URI

GET https://rest.monportailrh.com/form-instances/123
URI Parameters
HideShow
id
number (required) Example: 123

Id of the Form instance.

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 1,
    "name": {
      "en": "Some text",
      "fr": "Du texte",
      "de": "Setwas Text",
      "es": "Algún texto"
    },
    "description": {
      "en": "Some text",
      "fr": "Du texte",
      "de": "Setwas Text",
      "es": "Algún texto"
    },
    "form_id": 123,
    "is_active": true,
    "removable": false,
    "effective_date": "2019-04-24 11:47:47"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "object",
          "properties": {
            "en": {
              "type": "string"
            },
            "fr": {
              "type": "string"
            },
            "de": {
              "type": "string"
            },
            "es": {
              "type": "string"
            }
          },
          "required": [
            "en",
            "fr",
            "de",
            "es"
          ]
        },
        "description": {
          "type": "object",
          "properties": {
            "en": {
              "type": "string"
            },
            "fr": {
              "type": "string"
            },
            "de": {
              "type": "string"
            },
            "es": {
              "type": "string"
            }
          },
          "required": [
            "en",
            "fr",
            "de",
            "es"
          ]
        },
        "form_id": {
          "type": "number"
        },
        "is_active": {
          "type": "boolean"
        },
        "removable": {
          "type": "boolean"
        },
        "effective_date": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name",
        "description",
        "form_id",
        "is_active",
        "removable",
        "effective_date"
      ],
      "additionalProperties": false
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/form-instances/{id}

Update Form instance

Permissions: form_assignments.edit, form_assignments.view

Example URI

PATCH https://rest.monportailrh.com/form-instances/123
URI Parameters
HideShow
id
number (required) Example: 123

Id of the Form instance.

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Body
{
  "is_active": true,
  "is_hidden": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "is_active": {
      "type": "boolean"
    },
    "is_hidden": {
      "type": "boolean"
    }
  },
  "required": [
    "is_hidden"
  ]
}
Response  202
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 1,
    "name": {
      "en": "Some text",
      "fr": "Du texte",
      "de": "Setwas Text",
      "es": "Algún texto"
    },
    "description": {
      "en": "Some text",
      "fr": "Du texte",
      "de": "Setwas Text",
      "es": "Algún texto"
    },
    "form_id": 123,
    "is_active": true,
    "removable": false,
    "effective_date": "2019-04-24 11:47:47"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "object",
          "properties": {
            "en": {
              "type": "string"
            },
            "fr": {
              "type": "string"
            },
            "de": {
              "type": "string"
            },
            "es": {
              "type": "string"
            }
          },
          "required": [
            "en",
            "fr",
            "de",
            "es"
          ]
        },
        "description": {
          "type": "object",
          "properties": {
            "en": {
              "type": "string"
            },
            "fr": {
              "type": "string"
            },
            "de": {
              "type": "string"
            },
            "es": {
              "type": "string"
            }
          },
          "required": [
            "en",
            "fr",
            "de",
            "es"
          ]
        },
        "form_id": {
          "type": "number"
        },
        "is_active": {
          "type": "boolean"
        },
        "removable": {
          "type": "boolean"
        },
        "effective_date": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name",
        "description",
        "form_id",
        "is_active",
        "removable",
        "effective_date"
      ],
      "additionalProperties": false
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 400
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete
DELETE/form-instances/{id}

Delete Form instance

Permissions: form_assignments.delete, form_assignments.view

Example URI

DELETE https://rest.monportailrh.com/form-instances/123
URI Parameters
HideShow
id
number (required) Example: 123

Id of the Form instance.

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Response  204
HideShow
Headers
Content-Type: application/json
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Groups

Fields categories.

Groups

List
GET/groups{?pso-type,active,name,sort-by,sort-direction}

Fetch list of groups

Example URI

GET https://rest.monportailrh.com/groups?pso-type=123&active=true&name=Category to search&sort-by=name&sort-direction=asc
URI Parameters
HideShow
pso-type
number (optional) Example: 123

PSO type ID to filtering.

active
boolean (optional) Example: true

To filtering groups by active state

name
string (optional) Example: Category to search

Search by group title. Non strict, case-insensitive.

sort-by
name, pso-type, status, owner (optional) Default: name Example: name

Field to sort groups by.

sort-direction
asc, desc (optional) Default: asc Example: asc

Direction to order fields categories by.

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": 32,
      "name": "Group name",
      "description": "...",
      "alias": "usr_group",
      "status": "ok",
      "is_active": true,
      "created_at": "2019-04-24 11:47:47",
      "updated_at": "2019-04-24 11:47:47",
      "processed_at": "2019-04-24 11:47:47",
      "pso_type": {
        "id": 56,
        "name": "User",
        "alias": "usr",
        "description": "...",
        "is_active": true,
        "system_required": true,
        "creation_form_instance_id": 1,
        "profile_form_instance_id": 1
      },
      "owner": {
        "id": 1,
        "external_id": 1,
        "first_name": "John",
        "last_name": "Snow",
        "username": "john_snow",
        "professional_email": "jsnow@example.com",
        "professional_mobile_phone": "00 33 1 40 00 00 00",
        "professional_phone": "00 33 1 40 00 00 00",
        "role": [
          "bastard",
          "king"
        ],
        "is_active": true,
        "status": "remote",
        "settings": [
          "[]"
        ],
        "user_photo": "http://example.com/images/1.jpg"
      },
      "specific_psos": [
        {
          "summary": {
            "first_name": {
              "id": 1,
              "alias": "usr_first_name",
              "value": "John"
            },
            "last_name": {
              "id": 1,
              "alias": "usr_first_name",
              "value": "John"
            },
            "image": {
              "id": 1,
              "alias": "usr_first_name",
              "value": "John"
            },
            "is_active": {
              "id": 1,
              "alias": "usr_first_name",
              "value": "John"
            },
            "email": {
              "id": 1,
              "alias": "usr_first_name",
              "value": "John"
            },
            "phone_number": ""
          },
          "pso": {
            "id": 1,
            "profile_form": {
              "id": 1,
              "name": "Profile Form",
              "description": "Profile Form Description",
              "is_active": true,
              "active_field": "null"
            },
            "pso_type": {
              "id": 56,
              "name": "User",
              "alias": "usr",
              "description": "...",
              "is_active": true,
              "system_required": true,
              "creation_form_instance_id": 1,
              "profile_form_instance_id": 1
            },
            "categories": [
              {
                "id": 1,
                "name": "Category Name",
                "alias": "category_alias"
              }
            ],
            "fields": {
              "id": 1,
              "name": "Field Name",
              "position": 5,
              "alias": "usr_first_name",
              "has_unique_data": false,
              "has_value": true,
              "removable": false,
              "is_active": true,
              "list": false,
              "read_only": false,
              "required": true,
              "type": {
                "id": 1,
                "name": "Data Type Name",
                "alias": "data_type_alias",
                "settings": [
                  {
                    "id": 1,
                    "name": "Data Type Setting Name",
                    "alias": "data_type_setting_alias",
                    "is_required": true
                  }
                ],
                "supports_collection": false,
                "supports_read_only": false,
                "supports_unique": false
              },
              "category": {
                "id": 32,
                "alias": "usr_identity",
                "position": 5,
                "system_required": true,
                "name": "Identity",
                "description": "...",
                "is_active": true,
                "pso_type": {
                  "id": 56,
                  "name": "User",
                  "alias": "usr",
                  "description": "...",
                  "is_active": true,
                  "system_required": true,
                  "creation_form_instance_id": 1,
                  "profile_form_instance_id": 1
                }
              },
              "domains": [
                {
                  "id": 46,
                  "alias": "usr_global",
                  "name": "User Global",
                  "description": "...",
                  "is_editable": false,
                  "is_removable": false,
                  "is_active": true,
                  "pso_type": {
                    "id": 56,
                    "name": "User",
                    "alias": "usr",
                    "description": "...",
                    "is_active": true,
                    "system_required": true,
                    "creation_form_instance_id": 1,
                    "profile_form_instance_id": 1
                  }
                }
              ],
              "privacy_level": {
                "id": 123,
                "alias": "public",
                "name": "Not Sensitive",
                "level": 100
              },
              "pso_type": {
                "id": 56,
                "name": "User",
                "alias": "usr",
                "description": "...",
                "is_active": true,
                "system_required": true,
                "creation_form_instance_id": 1,
                "profile_form_instance_id": 1
              },
              "items": [
                {
                  "id": 1,
                  "name": "Field Name",
                  "position": 5,
                  "alias": "usr_first_name",
                  "has_unique_data": false,
                  "has_value": true,
                  "removable": false,
                  "is_active": true,
                  "list": false,
                  "read_only": false,
                  "required": true,
                  "user_required": true,
                  "system_required": true,
                  "type": {
                    "id": 1,
                    "name": "Data Type Name",
                    "alias": "data_type_alias",
                    "settings": [
                      {
                        "id": 1,
                        "name": "Data Type Setting Name",
                        "alias": "data_type_setting_alias",
                        "is_required": true
                      }
                    ],
                    "supports_collection": false,
                    "supports_read_only": false,
                    "supports_unique": false
                  },
                  "category": {
                    "id": 32,
                    "alias": "usr_identity",
                    "position": 5,
                    "system_required": true,
                    "name": "Identity",
                    "description": "...",
                    "is_active": true,
                    "pso_type": {
                      "id": 56,
                      "name": "User",
                      "alias": "usr",
                      "description": "...",
                      "is_active": true,
                      "system_required": true,
                      "creation_form_instance_id": 1,
                      "profile_form_instance_id": 1
                    }
                  },
                  "domains": [
                    {
                      "id": 46,
                      "alias": "usr_global",
                      "name": "User Global",
                      "description": "...",
                      "is_editable": false,
                      "is_removable": false,
                      "is_active": true,
                      "pso_type": {
                        "id": 56,
                        "name": "User",
                        "alias": "usr",
                        "description": "...",
                        "is_active": true,
                        "system_required": true,
                        "creation_form_instance_id": 1,
                        "profile_form_instance_id": 1
                      }
                    }
                  ],
                  "privacy_level": {
                    "id": 123,
                    "alias": "public",
                    "name": "Not Sensitive",
                    "level": 100
                  },
                  "pso_type": {
                    "id": 56,
                    "name": "User",
                    "alias": "usr",
                    "description": "...",
                    "is_active": true,
                    "system_required": true,
                    "creation_form_instance_id": 1,
                    "profile_form_instance_id": 1
                  },
                  "items": [
                    {}
                  ],
                  "options": [
                    {
                      "id": 198,
                      "name": "Choose me!",
                      "position": 9,
                      "value": "198",
                      "is_active": true,
                      "is_selectable": true
                    }
                  ],
                  "settings": [],
                  "validation": {
                    "type": "regexp",
                    "attributes": {},
                    "value_example": "string",
                    "error_message": {
                      "en": "Some text",
                      "fr": "Du texte",
                      "de": "Setwas Text",
                      "es": "Algún texto"
                    }
                  },
                  "has_autocomplete_settings": true,
                  "autocomplete_settings": {
                    "allow_extra_values": true,
                    "autofill": true,
                    "provider": {
                      "name": {
                        "en": "Some text",
                        "fr": "Du texte",
                        "de": "Setwas Text",
                        "es": "Algún texto"
                      },
                      "alias": "string",
                      "base_url": "https://exmaple.com/",
                      "single_value_supported": true,
                      "parameters": [
                        {
                          "name": "Name",
                          "key": "alias",
                          "required": true
                        }
                      ]
                    },
                    "parameters": [
                      {
                        "name": "Name",
                        "key": "alias",
                        "required": true,
                        "value": "value",
                        "field": {
                          "id": 1,
                          "name": "Field Name",
                          "alias": "usr_first_name",
                          "value": "RU",
                          "root_field": {
                            "id": 1,
                            "name": "Field Name",
                            "alias": "usr_first_name",
                            "value": "RU",
                            "root_field": "null"
                          }
                        }
                      }
                    ]
                  }
                }
              ],
              "options": [
                {
                  "id": 198,
                  "name": "Choose me!",
                  "position": 9,
                  "value": "198",
                  "is_active": true,
                  "is_selectable": true
                }
              ],
              "settings": [],
              "is_locked": false,
              "value_details": [
                "value1",
                "value2"
              ],
              "values_count": 2,
              "assignment_settings": [
                {
                  "setting": "public",
                  "value": "1"
                }
              ],
              "access_permissions": {
                "history": true,
                "view": true,
                "edit": true
              },
              "assignment_permissions": {
                "permissions": {
                  "id": 1,
                  "name": "View",
                  "alias": "view"
                },
                "access_list": [
                  "0",
                  "1",
                  "1"
                ]
              }
            }
          }
        }
      ],
      "conditions": [
        {
          "type": "group",
          "combine_with": "and",
          "conditions": [
            {
              "type": "condition",
              "field": "usr_email",
              "raw_value": "john.doe@example.com",
              "operator": "=="
            }
          ]
        }
      ],
      "permissions": [
        {
          "can_edit": true,
          "can_remove": true
        }
      ]
    }
  ],
  "meta": {
    "pagination": {
      "total": 238,
      "count": 25,
      "per_page": 25,
      "current_page": 2,
      "total_pages": 10,
      "links": {
        "previous": "http://example.com/api/<endpoint>?page=1",
        "next": "http://example.com/api/<endpoint>?page=3"
      }
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number"
          },
          "name": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "alias": {
            "type": "string"
          },
          "status": {
            "type": "string",
            "enum": [
              "ok",
              "pending"
            ]
          },
          "is_active": {
            "type": "boolean"
          },
          "created_at": {
            "type": "string"
          },
          "updated_at": {
            "type": "string"
          },
          "processed_at": {
            "type": "string"
          },
          "pso_type": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number"
              },
              "name": {
                "type": "string"
              },
              "alias": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "is_active": {
                "type": "boolean"
              },
              "system_required": {
                "type": "boolean"
              },
              "creation_form_instance_id": {
                "type": "number"
              },
              "profile_form_instance_id": {
                "type": "number"
              }
            },
            "required": [
              "id",
              "name",
              "alias",
              "description",
              "is_active",
              "system_required",
              "creation_form_instance_id",
              "profile_form_instance_id"
            ],
            "additionalProperties": false
          },
          "owner": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number"
              },
              "external_id": {
                "type": "number"
              },
              "first_name": {
                "type": "string"
              },
              "last_name": {
                "type": "string"
              },
              "username": {
                "type": "string"
              },
              "professional_email": {
                "type": "string"
              },
              "professional_mobile_phone": {
                "type": "string"
              },
              "professional_phone": {
                "type": "string"
              },
              "role": {
                "type": "array"
              },
              "is_active": {
                "type": "boolean"
              },
              "status": {
                "type": "string"
              },
              "settings": {
                "type": "array"
              },
              "user_photo": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "external_id",
              "first_name",
              "last_name",
              "username",
              "professional_email",
              "professional_mobile_phone",
              "professional_phone",
              "role",
              "is_active",
              "status",
              "settings",
              "user_photo"
            ],
            "additionalProperties": false
          },
          "specific_psos": {
            "type": "array"
          },
          "conditions": {
            "type": "array"
          },
          "permissions": {
            "type": "array"
          }
        },
        "required": [
          "id",
          "name",
          "description",
          "alias",
          "status",
          "is_active",
          "created_at",
          "updated_at",
          "specific_psos",
          "conditions"
        ]
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number"
            },
            "count": {
              "type": "number"
            },
            "per_page": {
              "type": "number"
            },
            "current_page": {
              "type": "number"
            },
            "total_pages": {
              "type": "number"
            },
            "links": {
              "type": "object",
              "properties": {
                "previous": {
                  "type": "string"
                },
                "next": {
                  "type": "string"
                }
              },
              "required": [
                "previous",
                "next"
              ]
            }
          },
          "required": [
            "total",
            "count",
            "per_page",
            "current_page",
            "total_pages",
            "links"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "pagination"
      ]
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/groups/{id}/history

Fetch information about changes in group. Supports pagination

Example URI

GET https://rest.monportailrh.com/groups/123/history
URI Parameters
HideShow
id
number (required) Example: 123

ID of the Group item.

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": 32,
      "name": "Group name",
      "description": "...",
      "alias": "usr_group",
      "status": "ok",
      "is_active": true,
      "created_at": "2019-04-24 11:47:47",
      "updated_at": "2019-04-24 11:47:47",
      "processed_at": "2019-04-24 11:47:47",
      "pso_type": {
        "id": 56,
        "name": "User",
        "alias": "usr",
        "description": "...",
        "is_active": true,
        "system_required": true,
        "creation_form_instance_id": 1,
        "profile_form_instance_id": 1
      },
      "owner": {
        "id": 1,
        "external_id": 1,
        "first_name": "John",
        "last_name": "Snow",
        "username": "john_snow",
        "professional_email": "jsnow@example.com",
        "professional_mobile_phone": "00 33 1 40 00 00 00",
        "professional_phone": "00 33 1 40 00 00 00",
        "role": [
          "bastard",
          "king"
        ],
        "is_active": true,
        "status": "remote",
        "settings": [
          "[]"
        ],
        "user_photo": "http://example.com/images/1.jpg"
      },
      "specific_psos": [
        {
          "summary": {
            "first_name": {
              "id": 1,
              "alias": "usr_first_name",
              "value": "John"
            },
            "last_name": {
              "id": 1,
              "alias": "usr_first_name",
              "value": "John"
            },
            "image": {
              "id": 1,
              "alias": "usr_first_name",
              "value": "John"
            },
            "is_active": {
              "id": 1,
              "alias": "usr_first_name",
              "value": "John"
            },
            "email": {
              "id": 1,
              "alias": "usr_first_name",
              "value": "John"
            },
            "phone_number": ""
          },
          "pso": {
            "id": 1,
            "profile_form": {
              "id": 1,
              "name": "Profile Form",
              "description": "Profile Form Description",
              "is_active": true,
              "active_field": "null"
            },
            "pso_type": {
              "id": 56,
              "name": "User",
              "alias": "usr",
              "description": "...",
              "is_active": true,
              "system_required": true,
              "creation_form_instance_id": 1,
              "profile_form_instance_id": 1
            },
            "categories": [
              {
                "id": 1,
                "name": "Category Name",
                "alias": "category_alias"
              }
            ],
            "fields": {
              "id": 1,
              "name": "Field Name",
              "position": 5,
              "alias": "usr_first_name",
              "has_unique_data": false,
              "has_value": true,
              "removable": false,
              "is_active": true,
              "list": false,
              "read_only": false,
              "required": true,
              "type": {
                "id": 1,
                "name": "Data Type Name",
                "alias": "data_type_alias",
                "settings": [
                  {
                    "id": 1,
                    "name": "Data Type Setting Name",
                    "alias": "data_type_setting_alias",
                    "is_required": true
                  }
                ],
                "supports_collection": false,
                "supports_read_only": false,
                "supports_unique": false
              },
              "category": {
                "id": 32,
                "alias": "usr_identity",
                "position": 5,
                "system_required": true,
                "name": "Identity",
                "description": "...",
                "is_active": true,
                "pso_type": {
                  "id": 56,
                  "name": "User",
                  "alias": "usr",
                  "description": "...",
                  "is_active": true,
                  "system_required": true,
                  "creation_form_instance_id": 1,
                  "profile_form_instance_id": 1
                }
              },
              "domains": [
                {
                  "id": 46,
                  "alias": "usr_global",
                  "name": "User Global",
                  "description": "...",
                  "is_editable": false,
                  "is_removable": false,
                  "is_active": true,
                  "pso_type": {
                    "id": 56,
                    "name": "User",
                    "alias": "usr",
                    "description": "...",
                    "is_active": true,
                    "system_required": true,
                    "creation_form_instance_id": 1,
                    "profile_form_instance_id": 1
                  }
                }
              ],
              "privacy_level": {
                "id": 123,
                "alias": "public",
                "name": "Not Sensitive",
                "level": 100
              },
              "pso_type": {
                "id": 56,
                "name": "User",
                "alias": "usr",
                "description": "...",
                "is_active": true,
                "system_required": true,
                "creation_form_instance_id": 1,
                "profile_form_instance_id": 1
              },
              "items": [
                {
                  "id": 1,
                  "name": "Field Name",
                  "position": 5,
                  "alias": "usr_first_name",
                  "has_unique_data": false,
                  "has_value": true,
                  "removable": false,
                  "is_active": true,
                  "list": false,
                  "read_only": false,
                  "required": true,
                  "user_required": true,
                  "system_required": true,
                  "type": {
                    "id": 1,
                    "name": "Data Type Name",
                    "alias": "data_type_alias",
                    "settings": [
                      {
                        "id": 1,
                        "name": "Data Type Setting Name",
                        "alias": "data_type_setting_alias",
                        "is_required": true
                      }
                    ],
                    "supports_collection": false,
                    "supports_read_only": false,
                    "supports_unique": false
                  },
                  "category": {
                    "id": 32,
                    "alias": "usr_identity",
                    "position": 5,
                    "system_required": true,
                    "name": "Identity",
                    "description": "...",
                    "is_active": true,
                    "pso_type": {
                      "id": 56,
                      "name": "User",
                      "alias": "usr",
                      "description": "...",
                      "is_active": true,
                      "system_required": true,
                      "creation_form_instance_id": 1,
                      "profile_form_instance_id": 1
                    }
                  },
                  "domains": [
                    {
                      "id": 46,
                      "alias": "usr_global",
                      "name": "User Global",
                      "description": "...",
                      "is_editable": false,
                      "is_removable": false,
                      "is_active": true,
                      "pso_type": {
                        "id": 56,
                        "name": "User",
                        "alias": "usr",
                        "description": "...",
                        "is_active": true,
                        "system_required": true,
                        "creation_form_instance_id": 1,
                        "profile_form_instance_id": 1
                      }
                    }
                  ],
                  "privacy_level": {
                    "id": 123,
                    "alias": "public",
                    "name": "Not Sensitive",
                    "level": 100
                  },
                  "pso_type": {
                    "id": 56,
                    "name": "User",
                    "alias": "usr",
                    "description": "...",
                    "is_active": true,
                    "system_required": true,
                    "creation_form_instance_id": 1,
                    "profile_form_instance_id": 1
                  },
                  "items": [
                    {}
                  ],
                  "options": [
                    {
                      "id": 198,
                      "name": "Choose me!",
                      "position": 9,
                      "value": "198",
                      "is_active": true,
                      "is_selectable": true
                    }
                  ],
                  "settings": [],
                  "validation": {
                    "type": "regexp",
                    "attributes": {},
                    "value_example": "string",
                    "error_message": {
                      "en": "Some text",
                      "fr": "Du texte",
                      "de": "Setwas Text",
                      "es": "Algún texto"
                    }
                  },
                  "has_autocomplete_settings": true,
                  "autocomplete_settings": {
                    "allow_extra_values": true,
                    "autofill": true,
                    "provider": {
                      "name": {
                        "en": "Some text",
                        "fr": "Du texte",
                        "de": "Setwas Text",
                        "es": "Algún texto"
                      },
                      "alias": "string",
                      "base_url": "https://exmaple.com/",
                      "single_value_supported": true,
                      "parameters": [
                        {
                          "name": "Name",
                          "key": "alias",
                          "required": true
                        }
                      ]
                    },
                    "parameters": [
                      {
                        "name": "Name",
                        "key": "alias",
                        "required": true,
                        "value": "value",
                        "field": {
                          "id": 1,
                          "name": "Field Name",
                          "alias": "usr_first_name",
                          "value": "RU",
                          "root_field": {
                            "id": 1,
                            "name": "Field Name",
                            "alias": "usr_first_name",
                            "value": "RU",
                            "root_field": "null"
                          }
                        }
                      }
                    ]
                  }
                }
              ],
              "options": [
                {
                  "id": 198,
                  "name": "Choose me!",
                  "position": 9,
                  "value": "198",
                  "is_active": true,
                  "is_selectable": true
                }
              ],
              "settings": [],
              "is_locked": false,
              "value_details": [
                "value1",
                "value2"
              ],
              "values_count": 2,
              "assignment_settings": [
                {
                  "setting": "public",
                  "value": "1"
                }
              ],
              "access_permissions": {
                "history": true,
                "view": true,
                "edit": true
              },
              "assignment_permissions": {
                "permissions": {
                  "id": 1,
                  "name": "View",
                  "alias": "view"
                },
                "access_list": [
                  "0",
                  "1",
                  "1"
                ]
              }
            }
          }
        }
      ],
      "conditions": [
        {
          "type": "group",
          "combine_with": "and",
          "conditions": [
            {
              "type": "condition",
              "field": "usr_email",
              "raw_value": "john.doe@example.com",
              "operator": "=="
            }
          ]
        }
      ],
      "permissions": [
        {
          "can_edit": true,
          "can_remove": true
        }
      ]
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number"
          },
          "name": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "alias": {
            "type": "string"
          },
          "status": {
            "type": "string",
            "enum": [
              "ok",
              "pending"
            ]
          },
          "is_active": {
            "type": "boolean"
          },
          "created_at": {
            "type": "string"
          },
          "updated_at": {
            "type": "string"
          },
          "processed_at": {
            "type": "string"
          },
          "pso_type": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number"
              },
              "name": {
                "type": "string"
              },
              "alias": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "is_active": {
                "type": "boolean"
              },
              "system_required": {
                "type": "boolean"
              },
              "creation_form_instance_id": {
                "type": "number"
              },
              "profile_form_instance_id": {
                "type": "number"
              }
            },
            "required": [
              "id",
              "name",
              "alias",
              "description",
              "is_active",
              "system_required",
              "creation_form_instance_id",
              "profile_form_instance_id"
            ],
            "additionalProperties": false
          },
          "owner": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number"
              },
              "external_id": {
                "type": "number"
              },
              "first_name": {
                "type": "string"
              },
              "last_name": {
                "type": "string"
              },
              "username": {
                "type": "string"
              },
              "professional_email": {
                "type": "string"
              },
              "professional_mobile_phone": {
                "type": "string"
              },
              "professional_phone": {
                "type": "string"
              },
              "role": {
                "type": "array"
              },
              "is_active": {
                "type": "boolean"
              },
              "status": {
                "type": "string"
              },
              "settings": {
                "type": "array"
              },
              "user_photo": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "external_id",
              "first_name",
              "last_name",
              "username",
              "professional_email",
              "professional_mobile_phone",
              "professional_phone",
              "role",
              "is_active",
              "status",
              "settings",
              "user_photo"
            ],
            "additionalProperties": false
          },
          "specific_psos": {
            "type": "array"
          },
          "conditions": {
            "type": "array"
          },
          "permissions": {
            "type": "array"
          }
        },
        "required": [
          "id",
          "name",
          "description",
          "alias",
          "status",
          "is_active",
          "created_at",
          "updated_at",
          "specific_psos",
          "conditions"
        ]
      }
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/groups/{id}/members

Fetch information about group members. Supports pagination

Example URI

GET https://rest.monportailrh.com/groups/123/members
URI Parameters
HideShow
id
number (required) Example: 123

ID of the Group item.

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": 1,
      "external_id": 1,
      "first_name": "John",
      "last_name": "Snow",
      "username": "john_snow",
      "professional_email": "jsnow@example.com",
      "professional_mobile_phone": "00 33 1 40 00 00 00",
      "professional_phone": "00 33 1 40 00 00 00",
      "role": [
        "bastard",
        "king"
      ],
      "is_active": true,
      "status": "remote",
      "settings": [
        "[]"
      ],
      "user_photo": "http://example.com/images/1.jpg"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number"
          },
          "external_id": {
            "type": "number"
          },
          "first_name": {
            "type": "string"
          },
          "last_name": {
            "type": "string"
          },
          "username": {
            "type": "string"
          },
          "professional_email": {
            "type": "string"
          },
          "professional_mobile_phone": {
            "type": "string"
          },
          "professional_phone": {
            "type": "string"
          },
          "role": {
            "type": "array"
          },
          "is_active": {
            "type": "boolean"
          },
          "status": {
            "type": "string"
          },
          "settings": {
            "type": "array"
          },
          "user_photo": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "external_id",
          "first_name",
          "last_name",
          "username",
          "professional_email",
          "professional_mobile_phone",
          "professional_phone",
          "role",
          "is_active",
          "status",
          "settings",
          "user_photo"
        ]
      }
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Create
POST/groups

Create new group item

Example URI

POST https://rest.monportailrh.com/groups
Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Body
{
  "pso_type": "usr",
  "owner": 5,
  "name": {
    "en": "Some text",
    "fr": "Du texte",
    "de": "Setwas Text",
    "es": "Algún texto"
  },
  "description": {
    "en": "Some text",
    "fr": "Du texte",
    "de": "Setwas Text",
    "es": "Algún texto"
  },
  "alias": "usr_global",
  "is_active": true,
  "specific_psos": [
    1
  ],
  "conditions": [
    {
      "type": "group",
      "combine_with": "and",
      "conditions": [
        {
          "type": "condition",
          "field": "usr_email",
          "raw_value": "john.doe@example.com",
          "field_value: usr_additional_email": "Hello, world!",
          "operator": "Hello, world!"
        }
      ]
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "pso_type": {
      "type": "string"
    },
    "owner": {
      "type": "number",
      "description": "Id of PSO."
    },
    "name": {
      "type": "object",
      "properties": {
        "en": {
          "type": "string"
        },
        "fr": {
          "type": "string"
        },
        "de": {
          "type": "string"
        },
        "es": {
          "type": "string"
        }
      },
      "required": [
        "en",
        "fr",
        "de",
        "es"
      ]
    },
    "description": {
      "type": "object",
      "properties": {
        "en": {
          "type": "string"
        },
        "fr": {
          "type": "string"
        },
        "de": {
          "type": "string"
        },
        "es": {
          "type": "string"
        }
      },
      "required": [
        "en",
        "fr",
        "de",
        "es"
      ]
    },
    "alias": {
      "type": "string"
    },
    "is_active": {
      "type": "boolean"
    },
    "specific_psos": {
      "type": "array"
    },
    "conditions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "group"
            ]
          },
          "combine_with": {
            "type": "string",
            "enum": [
              "and",
              "or"
            ]
          },
          "conditions": {
            "type": "array"
          }
        },
        "required": [
          "type",
          "combine_with",
          "conditions"
        ]
      }
    }
  },
  "required": [
    "pso_type",
    "owner",
    "name"
  ]
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 123,
    "alias": "can_be_null"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "alias": {
          "type": "string"
        }
      },
      "required": [
        "id"
      ],
      "additionalProperties": false
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 400
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/groups/{id}

Fetch single group item

Example URI

GET https://rest.monportailrh.com/groups/123
URI Parameters
HideShow
id
number (required) Example: 123

ID of the Group item.

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 32,
    "name": "Group name",
    "description": "...",
    "alias": "usr_group",
    "status": "ok",
    "is_active": true,
    "created_at": "2019-04-24 11:47:47",
    "updated_at": "2019-04-24 11:47:47",
    "processed_at": "2019-04-24 11:47:47",
    "pso_type": {
      "id": 56,
      "name": "User",
      "alias": "usr",
      "description": "...",
      "is_active": true,
      "system_required": true,
      "creation_form_instance_id": 1,
      "profile_form_instance_id": 1
    },
    "owner": {
      "id": 1,
      "external_id": 1,
      "first_name": "John",
      "last_name": "Snow",
      "username": "john_snow",
      "professional_email": "jsnow@example.com",
      "professional_mobile_phone": "00 33 1 40 00 00 00",
      "professional_phone": "00 33 1 40 00 00 00",
      "role": [
        "bastard",
        "king"
      ],
      "is_active": true,
      "status": "remote",
      "settings": [
        "[]"
      ],
      "user_photo": "http://example.com/images/1.jpg"
    },
    "specific_psos": [
      {
        "summary": {
          "first_name": {
            "id": 1,
            "alias": "usr_first_name",
            "value": "John"
          },
          "last_name": {
            "id": 1,
            "alias": "usr_first_name",
            "value": "John"
          },
          "image": {
            "id": 1,
            "alias": "usr_first_name",
            "value": "John"
          },
          "is_active": {
            "id": 1,
            "alias": "usr_first_name",
            "value": "John"
          },
          "email": {
            "id": 1,
            "alias": "usr_first_name",
            "value": "John"
          },
          "phone_number": ""
        },
        "pso": {
          "id": 1,
          "profile_form": {
            "id": 1,
            "name": "Profile Form",
            "description": "Profile Form Description",
            "is_active": true,
            "active_field": "null"
          },
          "pso_type": {
            "id": 56,
            "name": "User",
            "alias": "usr",
            "description": "...",
            "is_active": true,
            "system_required": true,
            "creation_form_instance_id": 1,
            "profile_form_instance_id": 1
          },
          "categories": [
            {
              "id": 1,
              "name": "Category Name",
              "alias": "category_alias"
            }
          ],
          "fields": {
            "id": 1,
            "name": "Field Name",
            "position": 5,
            "alias": "usr_first_name",
            "has_unique_data": false,
            "has_value": true,
            "removable": false,
            "is_active": true,
            "list": false,
            "read_only": false,
            "required": true,
            "type": {
              "id": 1,
              "name": "Data Type Name",
              "alias": "data_type_alias",
              "settings": [
                {
                  "id": 1,
                  "name": "Data Type Setting Name",
                  "alias": "data_type_setting_alias",
                  "is_required": true
                }
              ],
              "supports_collection": false,
              "supports_read_only": false,
              "supports_unique": false
            },
            "category": {
              "id": 32,
              "alias": "usr_identity",
              "position": 5,
              "system_required": true,
              "name": "Identity",
              "description": "...",
              "is_active": true,
              "pso_type": {
                "id": 56,
                "name": "User",
                "alias": "usr",
                "description": "...",
                "is_active": true,
                "system_required": true,
                "creation_form_instance_id": 1,
                "profile_form_instance_id": 1
              }
            },
            "domains": [
              {
                "id": 46,
                "alias": "usr_global",
                "name": "User Global",
                "description": "...",
                "is_editable": false,
                "is_removable": false,
                "is_active": true,
                "pso_type": {
                  "id": 56,
                  "name": "User",
                  "alias": "usr",
                  "description": "...",
                  "is_active": true,
                  "system_required": true,
                  "creation_form_instance_id": 1,
                  "profile_form_instance_id": 1
                }
              }
            ],
            "privacy_level": {
              "id": 123,
              "alias": "public",
              "name": "Not Sensitive",
              "level": 100
            },
            "pso_type": {
              "id": 56,
              "name": "User",
              "alias": "usr",
              "description": "...",
              "is_active": true,
              "system_required": true,
              "creation_form_instance_id": 1,
              "profile_form_instance_id": 1
            },
            "items": [
              {
                "id": 1,
                "name": "Field Name",
                "position": 5,
                "alias": "usr_first_name",
                "has_unique_data": false,
                "has_value": true,
                "removable": false,
                "is_active": true,
                "list": false,
                "read_only": false,
                "required": true,
                "user_required": true,
                "system_required": true,
                "type": {
                  "id": 1,
                  "name": "Data Type Name",
                  "alias": "data_type_alias",
                  "settings": [
                    {
                      "id": 1,
                      "name": "Data Type Setting Name",
                      "alias": "data_type_setting_alias",
                      "is_required": true
                    }
                  ],
                  "supports_collection": false,
                  "supports_read_only": false,
                  "supports_unique": false
                },
                "category": {
                  "id": 32,
                  "alias": "usr_identity",
                  "position": 5,
                  "system_required": true,
                  "name": "Identity",
                  "description": "...",
                  "is_active": true,
                  "pso_type": {
                    "id": 56,
                    "name": "User",
                    "alias": "usr",
                    "description": "...",
                    "is_active": true,
                    "system_required": true,
                    "creation_form_instance_id": 1,
                    "profile_form_instance_id": 1
                  }
                },
                "domains": [
                  {
                    "id": 46,
                    "alias": "usr_global",
                    "name": "User Global",
                    "description": "...",
                    "is_editable": false,
                    "is_removable": false,
                    "is_active": true,
                    "pso_type": {
                      "id": 56,
                      "name": "User",
                      "alias": "usr",
                      "description": "...",
                      "is_active": true,
                      "system_required": true,
                      "creation_form_instance_id": 1,
                      "profile_form_instance_id": 1
                    }
                  }
                ],
                "privacy_level": {
                  "id": 123,
                  "alias": "public",
                  "name": "Not Sensitive",
                  "level": 100
                },
                "pso_type": {
                  "id": 56,
                  "name": "User",
                  "alias": "usr",
                  "description": "...",
                  "is_active": true,
                  "system_required": true,
                  "creation_form_instance_id": 1,
                  "profile_form_instance_id": 1
                },
                "items": [
                  {}
                ],
                "options": [
                  {
                    "id": 198,
                    "name": "Choose me!",
                    "position": 9,
                    "value": "198",
                    "is_active": true,
                    "is_selectable": true
                  }
                ],
                "settings": [],
                "validation": {
                  "type": "regexp",
                  "attributes": {},
                  "value_example": "string",
                  "error_message": {
                    "en": "Some text",
                    "fr": "Du texte",
                    "de": "Setwas Text",
                    "es": "Algún texto"
                  }
                },
                "has_autocomplete_settings": true,
                "autocomplete_settings": {
                  "allow_extra_values": true,
                  "autofill": true,
                  "provider": {
                    "name": {
                      "en": "Some text",
                      "fr": "Du texte",
                      "de": "Setwas Text",
                      "es": "Algún texto"
                    },
                    "alias": "string",
                    "base_url": "https://exmaple.com/",
                    "single_value_supported": true,
                    "parameters": [
                      {
                        "name": "Name",
                        "key": "alias",
                        "required": true
                      }
                    ]
                  },
                  "parameters": [
                    {
                      "name": "Name",
                      "key": "alias",
                      "required": true,
                      "value": "value",
                      "field": {
                        "id": 1,
                        "name": "Field Name",
                        "alias": "usr_first_name",
                        "value": "RU",
                        "root_field": {
                          "id": 1,
                          "name": "Field Name",
                          "alias": "usr_first_name",
                          "value": "RU",
                          "root_field": "null"
                        }
                      }
                    }
                  ]
                }
              }
            ],
            "options": [
              {
                "id": 198,
                "name": "Choose me!",
                "position": 9,
                "value": "198",
                "is_active": true,
                "is_selectable": true
              }
            ],
            "settings": [],
            "is_locked": false,
            "value_details": [
              "value1",
              "value2"
            ],
            "values_count": 2,
            "assignment_settings": [
              {
                "setting": "public",
                "value": "1"
              }
            ],
            "access_permissions": {
              "history": true,
              "view": true,
              "edit": true
            },
            "assignment_permissions": {
              "permissions": {
                "id": 1,
                "name": "View",
                "alias": "view"
              },
              "access_list": [
                "0",
                "1",
                "1"
              ]
            }
          }
        }
      }
    ],
    "conditions": [
      {
        "type": "group",
        "combine_with": "and",
        "conditions": [
          {
            "type": "condition",
            "field": "usr_email",
            "raw_value": "john.doe@example.com",
            "operator": "=="
          }
        ]
      }
    ],
    "permissions": [
      {
        "can_edit": true,
        "can_remove": true
      }
    ]
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "alias": {
          "type": "string"
        },
        "status": {
          "type": "string",
          "enum": [
            "ok",
            "pending"
          ]
        },
        "is_active": {
          "type": "boolean"
        },
        "created_at": {
          "type": "string"
        },
        "updated_at": {
          "type": "string"
        },
        "processed_at": {
          "type": "string"
        },
        "pso_type": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "name": {
              "type": "string"
            },
            "alias": {
              "type": "string"
            },
            "description": {
              "type": "string"
            },
            "is_active": {
              "type": "boolean"
            },
            "system_required": {
              "type": "boolean"
            },
            "creation_form_instance_id": {
              "type": "number"
            },
            "profile_form_instance_id": {
              "type": "number"
            }
          },
          "required": [
            "id",
            "name",
            "alias",
            "description",
            "is_active",
            "system_required",
            "creation_form_instance_id",
            "profile_form_instance_id"
          ],
          "additionalProperties": false
        },
        "owner": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "external_id": {
              "type": "number"
            },
            "first_name": {
              "type": "string"
            },
            "last_name": {
              "type": "string"
            },
            "username": {
              "type": "string"
            },
            "professional_email": {
              "type": "string"
            },
            "professional_mobile_phone": {
              "type": "string"
            },
            "professional_phone": {
              "type": "string"
            },
            "role": {
              "type": "array"
            },
            "is_active": {
              "type": "boolean"
            },
            "status": {
              "type": "string"
            },
            "settings": {
              "type": "array"
            },
            "user_photo": {
              "type": "string"
            }
          },
          "required": [
            "id",
            "external_id",
            "first_name",
            "last_name",
            "username",
            "professional_email",
            "professional_mobile_phone",
            "professional_phone",
            "role",
            "is_active",
            "status",
            "settings",
            "user_photo"
          ],
          "additionalProperties": false
        },
        "specific_psos": {
          "type": "array"
        },
        "conditions": {
          "type": "array"
        },
        "permissions": {
          "type": "array"
        }
      },
      "required": [
        "id",
        "name",
        "description",
        "alias",
        "status",
        "is_active",
        "created_at",
        "updated_at",
        "specific_psos",
        "conditions"
      ],
      "additionalProperties": false
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete
DELETE/groups/{id}

Delete group item

Example URI

DELETE https://rest.monportailrh.com/groups/123
URI Parameters
HideShow
id
number (required) Example: 123

ID of the Group item.

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Response  204
HideShow
Headers
Content-Type: application/json
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/groups/{id}

Update group item

Example URI

PATCH https://rest.monportailrh.com/groups/123
URI Parameters
HideShow
id
number (required) Example: 123

ID of the Group item.

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Body
{
  "owner": 5,
  "name": {
    "en": "Some text",
    "fr": "Du texte",
    "de": "Setwas Text",
    "es": "Algún texto"
  },
  "description": {
    "en": "Some text",
    "fr": "Du texte",
    "de": "Setwas Text",
    "es": "Algún texto"
  },
  "alias": "usr_global",
  "is_active": true,
  "is_editable": true,
  "is_removable": true,
  "specific_psos": [
    1
  ],
  "conditions": [
    {
      "type": "group",
      "combine_with": "and",
      "conditions": [
        {
          "type": "condition",
          "field": "usr_email",
          "raw_value": "john.doe@example.com",
          "field_value: usr_additional_email": "Hello, world!",
          "operator": "Hello, world!"
        }
      ]
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "owner": {
      "type": "number",
      "description": "Id of PSO."
    },
    "name": {
      "type": "object",
      "properties": {
        "en": {
          "type": "string"
        },
        "fr": {
          "type": "string"
        },
        "de": {
          "type": "string"
        },
        "es": {
          "type": "string"
        }
      },
      "required": [
        "en",
        "fr",
        "de",
        "es"
      ]
    },
    "description": {
      "type": "object",
      "properties": {
        "en": {
          "type": "string"
        },
        "fr": {
          "type": "string"
        },
        "de": {
          "type": "string"
        },
        "es": {
          "type": "string"
        }
      },
      "required": [
        "en",
        "fr",
        "de",
        "es"
      ]
    },
    "alias": {
      "type": "string"
    },
    "is_active": {
      "type": "boolean"
    },
    "is_editable": {
      "type": "boolean",
      "description": "for admin only"
    },
    "is_removable": {
      "type": "boolean",
      "description": "for admin only"
    },
    "specific_psos": {
      "type": "array"
    },
    "conditions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "group"
            ]
          },
          "combine_with": {
            "type": "string",
            "enum": [
              "and",
              "or"
            ]
          },
          "conditions": {
            "type": "array"
          }
        },
        "required": [
          "type",
          "combine_with",
          "conditions"
        ]
      }
    }
  }
}
Response  202
HideShow
Headers
Content-Type: application/json
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 400
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Ideas and comments

Ideas and comments.

Ideas

List
GET/ideas{?status-id,created-after,created-before,category-id,name,user,sort-by,sort-direction}

Fetch list of ideas

Example URI

GET https://rest.monportailrh.com/ideas?status-id=123&created-after=2019-03-21 09:34:58&created-before=2019-03-21 09:34:58&category-id=123&name='Some name'&user='JohnDoe'&sort-by='votes'&sort-direction='desc'
URI Parameters
HideShow
status-id
number (optional) Example: 123
created-after
date-time (optional) Example: 2019-03-21 09:34:58
created-before
date-time (optional) Example: 2019-03-21 09:34:58
category-id
number (optional) Example: 123
name
string (optional) Example: 'Some name'
user
string (optional) Example: 'JohnDoe'
sort-by
string (optional) Default: 'votes' Example: 'votes'

Field to sort ideas by. Possible values: votes, comments

sort-direction
string (optional) Default: 'desc' Example: 'desc'

Direction to order results by. Possible values: asc, desc

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": 123,
      "creator": {
        "id": 1,
        "external_id": 1,
        "first_name": "John",
        "last_name": "Snow",
        "username": "john_snow",
        "professional_email": "jsnow@example.com",
        "professional_mobile_phone": "00 33 1 40 00 00 00",
        "professional_phone": "00 33 1 40 00 00 00",
        "role": [
          "bastard",
          "king"
        ],
        "is_active": true,
        "status": "remote",
        "settings": [
          "[]"
        ],
        "user_photo": "http://example.com/images/1.jpg"
      },
      "moderator": {
        "id": 1,
        "external_id": 1,
        "first_name": "John",
        "last_name": "Snow",
        "username": "john_snow",
        "professional_email": "jsnow@example.com",
        "professional_mobile_phone": "00 33 1 40 00 00 00",
        "professional_phone": "00 33 1 40 00 00 00",
        "role": [
          "bastard",
          "king"
        ],
        "is_active": true,
        "status": "remote",
        "settings": [
          "[]"
        ],
        "user_photo": "http://example.com/images/1.jpg"
      },
      "status": {
        "id": 123,
        "name_key_id": 123,
        "alias": "opened"
      },
      "category": {
        "id": 32,
        "alias": "usr_identity",
        "position": 5,
        "system_required": true,
        "name": "Identity",
        "description": "...",
        "is_active": true,
        "pso_type": {
          "id": 56,
          "name": "User",
          "alias": "usr",
          "description": "...",
          "is_active": true,
          "system_required": true,
          "creation_form_instance_id": 1,
          "profile_form_instance_id": 1
        }
      },
      "name": "Idea name",
      "body": "Idea body",
      "comments_count": 123,
      "votes_count": 123,
      "is_voted": true
    }
  ],
  "meta": {
    "pagination": {
      "total": 238,
      "count": 25,
      "per_page": 25,
      "current_page": 2,
      "total_pages": 10,
      "links": {
        "previous": "http://example.com/api/<endpoint>?page=1",
        "next": "http://example.com/api/<endpoint>?page=3"
      }
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number"
          },
          "creator": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number"
              },
              "external_id": {
                "type": "number"
              },
              "first_name": {
                "type": "string"
              },
              "last_name": {
                "type": "string"
              },
              "username": {
                "type": "string"
              },
              "professional_email": {
                "type": "string"
              },
              "professional_mobile_phone": {
                "type": "string"
              },
              "professional_phone": {
                "type": "string"
              },
              "role": {
                "type": "array"
              },
              "is_active": {
                "type": "boolean"
              },
              "status": {
                "type": "string"
              },
              "settings": {
                "type": "array"
              },
              "user_photo": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "external_id",
              "first_name",
              "last_name",
              "username",
              "professional_email",
              "professional_mobile_phone",
              "professional_phone",
              "role",
              "is_active",
              "status",
              "settings",
              "user_photo"
            ],
            "additionalProperties": false
          },
          "moderator": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number"
              },
              "external_id": {
                "type": "number"
              },
              "first_name": {
                "type": "string"
              },
              "last_name": {
                "type": "string"
              },
              "username": {
                "type": "string"
              },
              "professional_email": {
                "type": "string"
              },
              "professional_mobile_phone": {
                "type": "string"
              },
              "professional_phone": {
                "type": "string"
              },
              "role": {
                "type": "array"
              },
              "is_active": {
                "type": "boolean"
              },
              "status": {
                "type": "string"
              },
              "settings": {
                "type": "array"
              },
              "user_photo": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "external_id",
              "first_name",
              "last_name",
              "username",
              "professional_email",
              "professional_mobile_phone",
              "professional_phone",
              "role",
              "is_active",
              "status",
              "settings",
              "user_photo"
            ]
          },
          "status": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number"
              },
              "name_key_id": {
                "type": "number"
              },
              "alias": {
                "type": "string",
                "enum": [
                  "opened",
                  "accepted",
                  "rejected",
                  "implemented",
                  "closed"
                ]
              }
            },
            "required": [
              "id",
              "name_key_id",
              "alias"
            ],
            "additionalProperties": false
          },
          "category": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number"
              },
              "alias": {
                "type": "string"
              },
              "position": {
                "type": "number"
              },
              "system_required": {
                "type": "boolean"
              },
              "name": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "is_active": {
                "type": "boolean"
              },
              "pso_type": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "number"
                  },
                  "name": {
                    "type": "string"
                  },
                  "alias": {
                    "type": "string"
                  },
                  "description": {
                    "type": "string"
                  },
                  "is_active": {
                    "type": "boolean"
                  },
                  "system_required": {
                    "type": "boolean"
                  },
                  "creation_form_instance_id": {
                    "type": "number"
                  },
                  "profile_form_instance_id": {
                    "type": "number"
                  }
                },
                "required": [
                  "id",
                  "name",
                  "alias",
                  "description",
                  "is_active",
                  "system_required",
                  "creation_form_instance_id",
                  "profile_form_instance_id"
                ],
                "additionalProperties": false,
                "description": "Presented only if `include` was send"
              }
            },
            "required": [
              "id",
              "alias",
              "position",
              "system_required",
              "name",
              "description",
              "is_active"
            ],
            "additionalProperties": false
          },
          "name": {
            "type": "string"
          },
          "body": {
            "type": [
              "string",
              "null"
            ]
          },
          "comments_count": {
            "type": "number"
          },
          "votes_count": {
            "type": "number"
          },
          "is_voted": {
            "type": "boolean"
          }
        },
        "required": [
          "id",
          "creator",
          "status",
          "category",
          "name",
          "comments_count",
          "votes_count",
          "is_voted"
        ]
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number"
            },
            "count": {
              "type": "number"
            },
            "per_page": {
              "type": "number"
            },
            "current_page": {
              "type": "number"
            },
            "total_pages": {
              "type": "number"
            },
            "links": {
              "type": "object",
              "properties": {
                "previous": {
                  "type": "string"
                },
                "next": {
                  "type": "string"
                }
              },
              "required": [
                "previous",
                "next"
              ]
            }
          },
          "required": [
            "total",
            "count",
            "per_page",
            "current_page",
            "total_pages",
            "links"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "pagination"
      ]
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Create
POST/ideas

Create Idea

Example URI

POST https://rest.monportailrh.com/ideas
Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: '*'
Body
{
  "name": "Idea name",
  "body": "Idea body",
  "creator_id": 1,
  "category_id": 1
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "body": {
      "type": "string"
    },
    "creator_id": {
      "type": "number"
    },
    "category_id": {
      "type": "number"
    }
  },
  "required": [
    "name",
    "creator_id",
    "category_id"
  ]
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 123,
    "creator": {
      "id": 1,
      "external_id": 1,
      "first_name": "John",
      "last_name": "Snow",
      "username": "john_snow",
      "professional_email": "jsnow@example.com",
      "professional_mobile_phone": "00 33 1 40 00 00 00",
      "professional_phone": "00 33 1 40 00 00 00",
      "role": [
        "bastard",
        "king"
      ],
      "is_active": true,
      "status": "remote",
      "settings": [
        "[]"
      ],
      "user_photo": "http://example.com/images/1.jpg"
    },
    "moderator": {
      "id": 1,
      "external_id": 1,
      "first_name": "John",
      "last_name": "Snow",
      "username": "john_snow",
      "professional_email": "jsnow@example.com",
      "professional_mobile_phone": "00 33 1 40 00 00 00",
      "professional_phone": "00 33 1 40 00 00 00",
      "role": [
        "bastard",
        "king"
      ],
      "is_active": true,
      "status": "remote",
      "settings": [
        "[]"
      ],
      "user_photo": "http://example.com/images/1.jpg"
    },
    "status": {
      "id": 123,
      "name_key_id": 123,
      "alias": "opened"
    },
    "category": {
      "id": 32,
      "alias": "usr_identity",
      "position": 5,
      "system_required": true,
      "name": "Identity",
      "description": "...",
      "is_active": true,
      "pso_type": {
        "id": 56,
        "name": "User",
        "alias": "usr",
        "description": "...",
        "is_active": true,
        "system_required": true,
        "creation_form_instance_id": 1,
        "profile_form_instance_id": 1
      }
    },
    "name": "Idea name",
    "body": "Idea body",
    "comments_count": 123,
    "votes_count": 123,
    "is_voted": true
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "creator": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "external_id": {
              "type": "number"
            },
            "first_name": {
              "type": "string"
            },
            "last_name": {
              "type": "string"
            },
            "username": {
              "type": "string"
            },
            "professional_email": {
              "type": "string"
            },
            "professional_mobile_phone": {
              "type": "string"
            },
            "professional_phone": {
              "type": "string"
            },
            "role": {
              "type": "array"
            },
            "is_active": {
              "type": "boolean"
            },
            "status": {
              "type": "string"
            },
            "settings": {
              "type": "array"
            },
            "user_photo": {
              "type": "string"
            }
          },
          "required": [
            "id",
            "external_id",
            "first_name",
            "last_name",
            "username",
            "professional_email",
            "professional_mobile_phone",
            "professional_phone",
            "role",
            "is_active",
            "status",
            "settings",
            "user_photo"
          ],
          "additionalProperties": false
        },
        "moderator": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "external_id": {
              "type": "number"
            },
            "first_name": {
              "type": "string"
            },
            "last_name": {
              "type": "string"
            },
            "username": {
              "type": "string"
            },
            "professional_email": {
              "type": "string"
            },
            "professional_mobile_phone": {
              "type": "string"
            },
            "professional_phone": {
              "type": "string"
            },
            "role": {
              "type": "array"
            },
            "is_active": {
              "type": "boolean"
            },
            "status": {
              "type": "string"
            },
            "settings": {
              "type": "array"
            },
            "user_photo": {
              "type": "string"
            }
          },
          "required": [
            "id",
            "external_id",
            "first_name",
            "last_name",
            "username",
            "professional_email",
            "professional_mobile_phone",
            "professional_phone",
            "role",
            "is_active",
            "status",
            "settings",
            "user_photo"
          ]
        },
        "status": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "name_key_id": {
              "type": "number"
            },
            "alias": {
              "type": "string",
              "enum": [
                "opened",
                "accepted",
                "rejected",
                "implemented",
                "closed"
              ]
            }
          },
          "required": [
            "id",
            "name_key_id",
            "alias"
          ],
          "additionalProperties": false
        },
        "category": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "alias": {
              "type": "string"
            },
            "position": {
              "type": "number"
            },
            "system_required": {
              "type": "boolean"
            },
            "name": {
              "type": "string"
            },
            "description": {
              "type": "string"
            },
            "is_active": {
              "type": "boolean"
            },
            "pso_type": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number"
                },
                "name": {
                  "type": "string"
                },
                "alias": {
                  "type": "string"
                },
                "description": {
                  "type": "string"
                },
                "is_active": {
                  "type": "boolean"
                },
                "system_required": {
                  "type": "boolean"
                },
                "creation_form_instance_id": {
                  "type": "number"
                },
                "profile_form_instance_id": {
                  "type": "number"
                }
              },
              "required": [
                "id",
                "name",
                "alias",
                "description",
                "is_active",
                "system_required",
                "creation_form_instance_id",
                "profile_form_instance_id"
              ],
              "additionalProperties": false,
              "description": "Presented only if `include` was send"
            }
          },
          "required": [
            "id",
            "alias",
            "position",
            "system_required",
            "name",
            "description",
            "is_active"
          ],
          "additionalProperties": false
        },
        "name": {
          "type": "string"
        },
        "body": {
          "type": [
            "string",
            "null"
          ]
        },
        "comments_count": {
          "type": "number"
        },
        "votes_count": {
          "type": "number"
        },
        "is_voted": {
          "type": "boolean"
        }
      },
      "required": [
        "id",
        "creator",
        "status",
        "category",
        "name",
        "comments_count",
        "votes_count",
        "is_voted"
      ],
      "additionalProperties": false
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/ideas/{id}

Fetch single Idea

Example URI

GET https://rest.monportailrh.com/ideas/123
URI Parameters
HideShow
id
number (required) Example: 123

Id of the Idea.

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 123,
    "creator": {
      "id": 1,
      "external_id": 1,
      "first_name": "John",
      "last_name": "Snow",
      "username": "john_snow",
      "professional_email": "jsnow@example.com",
      "professional_mobile_phone": "00 33 1 40 00 00 00",
      "professional_phone": "00 33 1 40 00 00 00",
      "role": [
        "bastard",
        "king"
      ],
      "is_active": true,
      "status": "remote",
      "settings": [
        "[]"
      ],
      "user_photo": "http://example.com/images/1.jpg"
    },
    "moderator": {
      "id": 1,
      "external_id": 1,
      "first_name": "John",
      "last_name": "Snow",
      "username": "john_snow",
      "professional_email": "jsnow@example.com",
      "professional_mobile_phone": "00 33 1 40 00 00 00",
      "professional_phone": "00 33 1 40 00 00 00",
      "role": [
        "bastard",
        "king"
      ],
      "is_active": true,
      "status": "remote",
      "settings": [
        "[]"
      ],
      "user_photo": "http://example.com/images/1.jpg"
    },
    "status": {
      "id": 123,
      "name_key_id": 123,
      "alias": "opened"
    },
    "category": {
      "id": 32,
      "alias": "usr_identity",
      "position": 5,
      "system_required": true,
      "name": "Identity",
      "description": "...",
      "is_active": true,
      "pso_type": {
        "id": 56,
        "name": "User",
        "alias": "usr",
        "description": "...",
        "is_active": true,
        "system_required": true,
        "creation_form_instance_id": 1,
        "profile_form_instance_id": 1
      }
    },
    "name": "Idea name",
    "body": "Idea body",
    "comments_count": 123,
    "votes_count": 123,
    "is_voted": true
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "creator": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "external_id": {
              "type": "number"
            },
            "first_name": {
              "type": "string"
            },
            "last_name": {
              "type": "string"
            },
            "username": {
              "type": "string"
            },
            "professional_email": {
              "type": "string"
            },
            "professional_mobile_phone": {
              "type": "string"
            },
            "professional_phone": {
              "type": "string"
            },
            "role": {
              "type": "array"
            },
            "is_active": {
              "type": "boolean"
            },
            "status": {
              "type": "string"
            },
            "settings": {
              "type": "array"
            },
            "user_photo": {
              "type": "string"
            }
          },
          "required": [
            "id",
            "external_id",
            "first_name",
            "last_name",
            "username",
            "professional_email",
            "professional_mobile_phone",
            "professional_phone",
            "role",
            "is_active",
            "status",
            "settings",
            "user_photo"
          ],
          "additionalProperties": false
        },
        "moderator": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "external_id": {
              "type": "number"
            },
            "first_name": {
              "type": "string"
            },
            "last_name": {
              "type": "string"
            },
            "username": {
              "type": "string"
            },
            "professional_email": {
              "type": "string"
            },
            "professional_mobile_phone": {
              "type": "string"
            },
            "professional_phone": {
              "type": "string"
            },
            "role": {
              "type": "array"
            },
            "is_active": {
              "type": "boolean"
            },
            "status": {
              "type": "string"
            },
            "settings": {
              "type": "array"
            },
            "user_photo": {
              "type": "string"
            }
          },
          "required": [
            "id",
            "external_id",
            "first_name",
            "last_name",
            "username",
            "professional_email",
            "professional_mobile_phone",
            "professional_phone",
            "role",
            "is_active",
            "status",
            "settings",
            "user_photo"
          ]
        },
        "status": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "name_key_id": {
              "type": "number"
            },
            "alias": {
              "type": "string",
              "enum": [
                "opened",
                "accepted",
                "rejected",
                "implemented",
                "closed"
              ]
            }
          },
          "required": [
            "id",
            "name_key_id",
            "alias"
          ],
          "additionalProperties": false
        },
        "category": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "alias": {
              "type": "string"
            },
            "position": {
              "type": "number"
            },
            "system_required": {
              "type": "boolean"
            },
            "name": {
              "type": "string"
            },
            "description": {
              "type": "string"
            },
            "is_active": {
              "type": "boolean"
            },
            "pso_type": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number"
                },
                "name": {
                  "type": "string"
                },
                "alias": {
                  "type": "string"
                },
                "description": {
                  "type": "string"
                },
                "is_active": {
                  "type": "boolean"
                },
                "system_required": {
                  "type": "boolean"
                },
                "creation_form_instance_id": {
                  "type": "number"
                },
                "profile_form_instance_id": {
                  "type": "number"
                }
              },
              "required": [
                "id",
                "name",
                "alias",
                "description",
                "is_active",
                "system_required",
                "creation_form_instance_id",
                "profile_form_instance_id"
              ],
              "additionalProperties": false,
              "description": "Presented only if `include` was send"
            }
          },
          "required": [
            "id",
            "alias",
            "position",
            "system_required",
            "name",
            "description",
            "is_active"
          ],
          "additionalProperties": false
        },
        "name": {
          "type": "string"
        },
        "body": {
          "type": [
            "string",
            "null"
          ]
        },
        "comments_count": {
          "type": "number"
        },
        "votes_count": {
          "type": "number"
        },
        "is_voted": {
          "type": "boolean"
        }
      },
      "required": [
        "id",
        "creator",
        "status",
        "category",
        "name",
        "comments_count",
        "votes_count",
        "is_voted"
      ],
      "additionalProperties": false
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/ideas/{id}

Update Idea

Example URI

PATCH https://rest.monportailrh.com/ideas/123
URI Parameters
HideShow
id
number (required) Example: 123

Id of the Idea.

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Body
{
  "name": "Idea name",
  "body": "Idea body",
  "status_id": 1,
  "category_id": 1
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "body": {
      "type": "string"
    },
    "status_id": {
      "type": "number"
    },
    "category_id": {
      "type": "number"
    }
  }
}
Response  202
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 123,
    "creator": {
      "id": 1,
      "external_id": 1,
      "first_name": "John",
      "last_name": "Snow",
      "username": "john_snow",
      "professional_email": "jsnow@example.com",
      "professional_mobile_phone": "00 33 1 40 00 00 00",
      "professional_phone": "00 33 1 40 00 00 00",
      "role": [
        "bastard",
        "king"
      ],
      "is_active": true,
      "status": "remote",
      "settings": [
        "[]"
      ],
      "user_photo": "http://example.com/images/1.jpg"
    },
    "moderator": {
      "id": 1,
      "external_id": 1,
      "first_name": "John",
      "last_name": "Snow",
      "username": "john_snow",
      "professional_email": "jsnow@example.com",
      "professional_mobile_phone": "00 33 1 40 00 00 00",
      "professional_phone": "00 33 1 40 00 00 00",
      "role": [
        "bastard",
        "king"
      ],
      "is_active": true,
      "status": "remote",
      "settings": [
        "[]"
      ],
      "user_photo": "http://example.com/images/1.jpg"
    },
    "status": {
      "id": 123,
      "name_key_id": 123,
      "alias": "opened"
    },
    "category": {
      "id": 32,
      "alias": "usr_identity",
      "position": 5,
      "system_required": true,
      "name": "Identity",
      "description": "...",
      "is_active": true,
      "pso_type": {
        "id": 56,
        "name": "User",
        "alias": "usr",
        "description": "...",
        "is_active": true,
        "system_required": true,
        "creation_form_instance_id": 1,
        "profile_form_instance_id": 1
      }
    },
    "name": "Idea name",
    "body": "Idea body",
    "comments_count": 123,
    "votes_count": 123,
    "is_voted": true
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "creator": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "external_id": {
              "type": "number"
            },
            "first_name": {
              "type": "string"
            },
            "last_name": {
              "type": "string"
            },
            "username": {
              "type": "string"
            },
            "professional_email": {
              "type": "string"
            },
            "professional_mobile_phone": {
              "type": "string"
            },
            "professional_phone": {
              "type": "string"
            },
            "role": {
              "type": "array"
            },
            "is_active": {
              "type": "boolean"
            },
            "status": {
              "type": "string"
            },
            "settings": {
              "type": "array"
            },
            "user_photo": {
              "type": "string"
            }
          },
          "required": [
            "id",
            "external_id",
            "first_name",
            "last_name",
            "username",
            "professional_email",
            "professional_mobile_phone",
            "professional_phone",
            "role",
            "is_active",
            "status",
            "settings",
            "user_photo"
          ],
          "additionalProperties": false
        },
        "moderator": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "external_id": {
              "type": "number"
            },
            "first_name": {
              "type": "string"
            },
            "last_name": {
              "type": "string"
            },
            "username": {
              "type": "string"
            },
            "professional_email": {
              "type": "string"
            },
            "professional_mobile_phone": {
              "type": "string"
            },
            "professional_phone": {
              "type": "string"
            },
            "role": {
              "type": "array"
            },
            "is_active": {
              "type": "boolean"
            },
            "status": {
              "type": "string"
            },
            "settings": {
              "type": "array"
            },
            "user_photo": {
              "type": "string"
            }
          },
          "required": [
            "id",
            "external_id",
            "first_name",
            "last_name",
            "username",
            "professional_email",
            "professional_mobile_phone",
            "professional_phone",
            "role",
            "is_active",
            "status",
            "settings",
            "user_photo"
          ]
        },
        "status": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "name_key_id": {
              "type": "number"
            },
            "alias": {
              "type": "string",
              "enum": [
                "opened",
                "accepted",
                "rejected",
                "implemented",
                "closed"
              ]
            }
          },
          "required": [
            "id",
            "name_key_id",
            "alias"
          ],
          "additionalProperties": false
        },
        "category": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "alias": {
              "type": "string"
            },
            "position": {
              "type": "number"
            },
            "system_required": {
              "type": "boolean"
            },
            "name": {
              "type": "string"
            },
            "description": {
              "type": "string"
            },
            "is_active": {
              "type": "boolean"
            },
            "pso_type": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number"
                },
                "name": {
                  "type": "string"
                },
                "alias": {
                  "type": "string"
                },
                "description": {
                  "type": "string"
                },
                "is_active": {
                  "type": "boolean"
                },
                "system_required": {
                  "type": "boolean"
                },
                "creation_form_instance_id": {
                  "type": "number"
                },
                "profile_form_instance_id": {
                  "type": "number"
                }
              },
              "required": [
                "id",
                "name",
                "alias",
                "description",
                "is_active",
                "system_required",
                "creation_form_instance_id",
                "profile_form_instance_id"
              ],
              "additionalProperties": false,
              "description": "Presented only if `include` was send"
            }
          },
          "required": [
            "id",
            "alias",
            "position",
            "system_required",
            "name",
            "description",
            "is_active"
          ],
          "additionalProperties": false
        },
        "name": {
          "type": "string"
        },
        "body": {
          "type": [
            "string",
            "null"
          ]
        },
        "comments_count": {
          "type": "number"
        },
        "votes_count": {
          "type": "number"
        },
        "is_voted": {
          "type": "boolean"
        }
      },
      "required": [
        "id",
        "creator",
        "status",
        "category",
        "name",
        "comments_count",
        "votes_count",
        "is_voted"
      ],
      "additionalProperties": false
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 400
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete
DELETE/ideas/{id}

Delete Idea

Example URI

DELETE https://rest.monportailrh.com/ideas/123
URI Parameters
HideShow
id
number (required) Example: 123

Id of the Idea item.

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Response  204
HideShow
Headers
Content-Type: application/json
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Like
POST/ideas/{id}/like

Like Idea

Example URI

POST https://rest.monportailrh.com/ideas/123/like
URI Parameters
HideShow
id
number (required) Example: 123

Id of the Idea.

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: '*'
Response  202
HideShow
Headers
Content-Type: application/json
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Dislike
POST/ideas/{id}/dislike

Dislike Idea

Example URI

POST https://rest.monportailrh.com/ideas/123/dislike
URI Parameters
HideShow
id
number (required) Example: 123

Id of the Idea.

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: '*'
Response  202
HideShow
Headers
Content-Type: application/json
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Get vote list (list of likes)
GET/ideas/{id}/vote/list

Fetch list of Idea votes (likes).

Example URI

GET https://rest.monportailrh.com/ideas/123/vote/list
URI Parameters
HideShow
id
number (required) Example: 123

Id of the Idea.

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: '*'
Response  200
HideShow
Headers
Content-Type: application/json
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Comments

List
GET/ideas/{idea}/comments

Fetch list of idea comments.

Example URI

GET https://rest.monportailrh.com/ideas/123/comments
URI Parameters
HideShow
idea
number (required) Example: 123
Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": 123,
      "creator": {
        "id": 1,
        "external_id": 1,
        "first_name": "John",
        "last_name": "Snow",
        "username": "john_snow",
        "professional_email": "jsnow@example.com",
        "professional_mobile_phone": "00 33 1 40 00 00 00",
        "professional_phone": "00 33 1 40 00 00 00",
        "role": [
          "bastard",
          "king"
        ],
        "is_active": true,
        "status": "remote",
        "settings": [
          "[]"
        ],
        "user_photo": "http://example.com/images/1.jpg"
      },
      "body": "Comment body text",
      "idea_id": 234,
      "created_at": "2019-01-01 23:34:40"
    }
  ],
  "meta": {
    "pagination": {
      "total": 238,
      "count": 25,
      "per_page": 25,
      "current_page": 2,
      "total_pages": 10,
      "links": {
        "previous": "http://example.com/api/<endpoint>?page=1",
        "next": "http://example.com/api/<endpoint>?page=3"
      }
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number"
          },
          "creator": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number"
              },
              "external_id": {
                "type": "number"
              },
              "first_name": {
                "type": "string"
              },
              "last_name": {
                "type": "string"
              },
              "username": {
                "type": "string"
              },
              "professional_email": {
                "type": "string"
              },
              "professional_mobile_phone": {
                "type": "string"
              },
              "professional_phone": {
                "type": "string"
              },
              "role": {
                "type": "array"
              },
              "is_active": {
                "type": "boolean"
              },
              "status": {
                "type": "string"
              },
              "settings": {
                "type": "array"
              },
              "user_photo": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "external_id",
              "first_name",
              "last_name",
              "username",
              "professional_email",
              "professional_mobile_phone",
              "professional_phone",
              "role",
              "is_active",
              "status",
              "settings",
              "user_photo"
            ],
            "additionalProperties": false
          },
          "body": {
            "type": "string"
          },
          "idea_id": {
            "type": "number"
          },
          "created_at": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "creator",
          "body",
          "idea_id",
          "created_at"
        ]
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number"
            },
            "count": {
              "type": "number"
            },
            "per_page": {
              "type": "number"
            },
            "current_page": {
              "type": "number"
            },
            "total_pages": {
              "type": "number"
            },
            "links": {
              "type": "object",
              "properties": {
                "previous": {
                  "type": "string"
                },
                "next": {
                  "type": "string"
                }
              },
              "required": [
                "previous",
                "next"
              ]
            }
          },
          "required": [
            "total",
            "count",
            "per_page",
            "current_page",
            "total_pages",
            "links"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "pagination"
      ]
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/ideas/{idea}/comments/{comment}

Fetch single Idea comment.

Example URI

GET https://rest.monportailrh.com/ideas/123/comments/234
URI Parameters
HideShow
idea
number (required) Example: 123

Id of the Idea.

comment
number (required) Example: 234

Id of Idea comment.

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 123,
    "creator": {
      "id": 1,
      "external_id": 1,
      "first_name": "John",
      "last_name": "Snow",
      "username": "john_snow",
      "professional_email": "jsnow@example.com",
      "professional_mobile_phone": "00 33 1 40 00 00 00",
      "professional_phone": "00 33 1 40 00 00 00",
      "role": [
        "bastard",
        "king"
      ],
      "is_active": true,
      "status": "remote",
      "settings": [
        "[]"
      ],
      "user_photo": "http://example.com/images/1.jpg"
    },
    "body": "Comment body text",
    "idea_id": 234,
    "created_at": "2019-01-01 23:34:40"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "creator": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "external_id": {
              "type": "number"
            },
            "first_name": {
              "type": "string"
            },
            "last_name": {
              "type": "string"
            },
            "username": {
              "type": "string"
            },
            "professional_email": {
              "type": "string"
            },
            "professional_mobile_phone": {
              "type": "string"
            },
            "professional_phone": {
              "type": "string"
            },
            "role": {
              "type": "array"
            },
            "is_active": {
              "type": "boolean"
            },
            "status": {
              "type": "string"
            },
            "settings": {
              "type": "array"
            },
            "user_photo": {
              "type": "string"
            }
          },
          "required": [
            "id",
            "external_id",
            "first_name",
            "last_name",
            "username",
            "professional_email",
            "professional_mobile_phone",
            "professional_phone",
            "role",
            "is_active",
            "status",
            "settings",
            "user_photo"
          ],
          "additionalProperties": false
        },
        "body": {
          "type": "string"
        },
        "idea_id": {
          "type": "number"
        },
        "created_at": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "creator",
        "body",
        "idea_id",
        "created_at"
      ],
      "additionalProperties": false
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Create
POST/ideas/comments

Create Idea comment

Example URI

POST https://rest.monportailrh.com/ideas/comments
Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: '*'
Body
{
  "body": "Idea body"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "body": {
      "type": "string"
    }
  }
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 123,
    "creator": {
      "id": 1,
      "external_id": 1,
      "first_name": "John",
      "last_name": "Snow",
      "username": "john_snow",
      "professional_email": "jsnow@example.com",
      "professional_mobile_phone": "00 33 1 40 00 00 00",
      "professional_phone": "00 33 1 40 00 00 00",
      "role": [
        "bastard",
        "king"
      ],
      "is_active": true,
      "status": "remote",
      "settings": [
        "[]"
      ],
      "user_photo": "http://example.com/images/1.jpg"
    },
    "body": "Comment body text",
    "idea_id": 234,
    "created_at": "2019-01-01 23:34:40"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "creator": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "external_id": {
              "type": "number"
            },
            "first_name": {
              "type": "string"
            },
            "last_name": {
              "type": "string"
            },
            "username": {
              "type": "string"
            },
            "professional_email": {
              "type": "string"
            },
            "professional_mobile_phone": {
              "type": "string"
            },
            "professional_phone": {
              "type": "string"
            },
            "role": {
              "type": "array"
            },
            "is_active": {
              "type": "boolean"
            },
            "status": {
              "type": "string"
            },
            "settings": {
              "type": "array"
            },
            "user_photo": {
              "type": "string"
            }
          },
          "required": [
            "id",
            "external_id",
            "first_name",
            "last_name",
            "username",
            "professional_email",
            "professional_mobile_phone",
            "professional_phone",
            "role",
            "is_active",
            "status",
            "settings",
            "user_photo"
          ],
          "additionalProperties": false
        },
        "body": {
          "type": "string"
        },
        "idea_id": {
          "type": "number"
        },
        "created_at": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "creator",
        "body",
        "idea_id",
        "created_at"
      ],
      "additionalProperties": false
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/ideas/{idea}/comments/{comment}

Update Idea comment.

Example URI

PATCH https://rest.monportailrh.com/ideas/123/comments/234
URI Parameters
HideShow
idea
number (required) Example: 123

Id of the Idea.

comment
number (required) Example: 234

Id of the Idea comment.

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Body
{
  "body": "Idea body"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "body": {
      "type": "string"
    }
  }
}
Response  202
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 123,
    "creator": {
      "id": 1,
      "external_id": 1,
      "first_name": "John",
      "last_name": "Snow",
      "username": "john_snow",
      "professional_email": "jsnow@example.com",
      "professional_mobile_phone": "00 33 1 40 00 00 00",
      "professional_phone": "00 33 1 40 00 00 00",
      "role": [
        "bastard",
        "king"
      ],
      "is_active": true,
      "status": "remote",
      "settings": [
        "[]"
      ],
      "user_photo": "http://example.com/images/1.jpg"
    },
    "body": "Comment body text",
    "idea_id": 234,
    "created_at": "2019-01-01 23:34:40"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "creator": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "external_id": {
              "type": "number"
            },
            "first_name": {
              "type": "string"
            },
            "last_name": {
              "type": "string"
            },
            "username": {
              "type": "string"
            },
            "professional_email": {
              "type": "string"
            },
            "professional_mobile_phone": {
              "type": "string"
            },
            "professional_phone": {
              "type": "string"
            },
            "role": {
              "type": "array"
            },
            "is_active": {
              "type": "boolean"
            },
            "status": {
              "type": "string"
            },
            "settings": {
              "type": "array"
            },
            "user_photo": {
              "type": "string"
            }
          },
          "required": [
            "id",
            "external_id",
            "first_name",
            "last_name",
            "username",
            "professional_email",
            "professional_mobile_phone",
            "professional_phone",
            "role",
            "is_active",
            "status",
            "settings",
            "user_photo"
          ],
          "additionalProperties": false
        },
        "body": {
          "type": "string"
        },
        "idea_id": {
          "type": "number"
        },
        "created_at": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "creator",
        "body",
        "idea_id",
        "created_at"
      ],
      "additionalProperties": false
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 400
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete
DELETE/ideas/{idea}/comments/{comment}

Delete Idea comment.

Example URI

DELETE https://rest.monportailrh.com/ideas/123/comments/234
URI Parameters
HideShow
idea
number (required) Example: 123

Id of the Idea.

comment
number (required) Example: 234

Id of the Idea comment.

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Response  204
HideShow
Headers
Content-Type: application/json
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

History

History provide users with the list of answers changes

History

Get History
GET/history/psos/{pso}/{field}

Get detailed changes of answers data for selected pso (user) and field

Example URI

GET https://rest.monportailrh.com/history/psos/1/2
URI Parameters
HideShow
pso
number (required) Example: 1

id of pso

field
number (required) Example: 2

id of field

Request
HideShow
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "name": "Field Name",
    "field": 1,
    "data_type": {
      "id": 1,
      "name": "Data Type Name",
      "alias": "data_type_alias",
      "settings": [
        {
          "id": 1,
          "name": "Data Type Setting Name",
          "alias": "data_type_setting_alias",
          "is_required": true
        }
      ],
      "supports_collection": false,
      "supports_read_only": false,
      "supports_unique": false
    },
    "action_type": "updated",
    "user": {
      "summary": {
        "first_name": {
          "id": 1,
          "alias": "usr_first_name",
          "value": "John"
        },
        "last_name": {
          "id": 1,
          "alias": "usr_first_name",
          "value": "John"
        },
        "image": {
          "id": 1,
          "alias": "usr_first_name",
          "value": "John"
        },
        "is_active": {
          "id": 1,
          "alias": "usr_first_name",
          "value": "John"
        },
        "email": {
          "id": 1,
          "alias": "usr_first_name",
          "value": "John"
        },
        "phone_number": ""
      },
      "pso": {
        "id": 1,
        "profile_form": {
          "id": 1,
          "name": "Profile Form",
          "description": "Profile Form Description",
          "is_active": true,
          "active_field": "null"
        },
        "pso_type": {
          "id": 56,
          "name": "User",
          "alias": "usr",
          "description": "...",
          "is_active": true,
          "system_required": true,
          "creation_form_instance_id": 1,
          "profile_form_instance_id": 1
        },
        "categories": [
          {
            "id": 1,
            "name": "Category Name",
            "alias": "category_alias"
          }
        ],
        "fields": {
          "id": 1,
          "name": "Field Name",
          "position": 5,
          "alias": "usr_first_name",
          "has_unique_data": false,
          "has_value": true,
          "removable": false,
          "is_active": true,
          "list": false,
          "read_only": false,
          "required": true,
          "type": {
            "id": 1,
            "name": "Data Type Name",
            "alias": "data_type_alias",
            "settings": [
              {
                "id": 1,
                "name": "Data Type Setting Name",
                "alias": "data_type_setting_alias",
                "is_required": true
              }
            ],
            "supports_collection": false,
            "supports_read_only": false,
            "supports_unique": false
          },
          "category": {
            "id": 32,
            "alias": "usr_identity",
            "position": 5,
            "system_required": true,
            "name": "Identity",
            "description": "...",
            "is_active": true,
            "pso_type": {
              "id": 56,
              "name": "User",
              "alias": "usr",
              "description": "...",
              "is_active": true,
              "system_required": true,
              "creation_form_instance_id": 1,
              "profile_form_instance_id": 1
            }
          },
          "domains": [
            {
              "id": 46,
              "alias": "usr_global",
              "name": "User Global",
              "description": "...",
              "is_editable": false,
              "is_removable": false,
              "is_active": true,
              "pso_type": {
                "id": 56,
                "name": "User",
                "alias": "usr",
                "description": "...",
                "is_active": true,
                "system_required": true,
                "creation_form_instance_id": 1,
                "profile_form_instance_id": 1
              }
            }
          ],
          "privacy_level": {
            "id": 123,
            "alias": "public",
            "name": "Not Sensitive",
            "level": 100
          },
          "pso_type": {
            "id": 56,
            "name": "User",
            "alias": "usr",
            "description": "...",
            "is_active": true,
            "system_required": true,
            "creation_form_instance_id": 1,
            "profile_form_instance_id": 1
          },
          "items": [
            {
              "id": 1,
              "name": "Field Name",
              "position": 5,
              "alias": "usr_first_name",
              "has_unique_data": false,
              "has_value": true,
              "removable": false,
              "is_active": true,
              "list": false,
              "read_only": false,
              "required": true,
              "user_required": true,
              "system_required": true,
              "type": {
                "id": 1,
                "name": "Data Type Name",
                "alias": "data_type_alias",
                "settings": [
                  {
                    "id": 1,
                    "name": "Data Type Setting Name",
                    "alias": "data_type_setting_alias",
                    "is_required": true
                  }
                ],
                "supports_collection": false,
                "supports_read_only": false,
                "supports_unique": false
              },
              "category": {
                "id": 32,
                "alias": "usr_identity",
                "position": 5,
                "system_required": true,
                "name": "Identity",
                "description": "...",
                "is_active": true,
                "pso_type": {
                  "id": 56,
                  "name": "User",
                  "alias": "usr",
                  "description": "...",
                  "is_active": true,
                  "system_required": true,
                  "creation_form_instance_id": 1,
                  "profile_form_instance_id": 1
                }
              },
              "domains": [
                {
                  "id": 46,
                  "alias": "usr_global",
                  "name": "User Global",
                  "description": "...",
                  "is_editable": false,
                  "is_removable": false,
                  "is_active": true,
                  "pso_type": {
                    "id": 56,
                    "name": "User",
                    "alias": "usr",
                    "description": "...",
                    "is_active": true,
                    "system_required": true,
                    "creation_form_instance_id": 1,
                    "profile_form_instance_id": 1
                  }
                }
              ],
              "privacy_level": {
                "id": 123,
                "alias": "public",
                "name": "Not Sensitive",
                "level": 100
              },
              "pso_type": {
                "id": 56,
                "name": "User",
                "alias": "usr",
                "description": "...",
                "is_active": true,
                "system_required": true,
                "creation_form_instance_id": 1,
                "profile_form_instance_id": 1
              },
              "items": [
                {}
              ],
              "options": [
                {
                  "id": 198,
                  "name": "Choose me!",
                  "position": 9,
                  "value": "198",
                  "is_active": true,
                  "is_selectable": true
                }
              ],
              "settings": [],
              "validation": {
                "type": "regexp",
                "attributes": {},
                "value_example": "string",
                "error_message": {
                  "en": "Some text",
                  "fr": "Du texte",
                  "de": "Setwas Text",
                  "es": "Algún texto"
                }
              },
              "has_autocomplete_settings": true,
              "autocomplete_settings": {
                "allow_extra_values": true,
                "autofill": true,
                "provider": {
                  "name": {
                    "en": "Some text",
                    "fr": "Du texte",
                    "de": "Setwas Text",
                    "es": "Algún texto"
                  },
                  "alias": "string",
                  "base_url": "https://exmaple.com/",
                  "single_value_supported": true,
                  "parameters": [
                    {
                      "name": "Name",
                      "key": "alias",
                      "required": true
                    }
                  ]
                },
                "parameters": [
                  {
                    "name": "Name",
                    "key": "alias",
                    "required": true,
                    "value": "value",
                    "field": {
                      "id": 1,
                      "name": "Field Name",
                      "alias": "usr_first_name",
                      "value": "RU",
                      "root_field": {
                        "id": 1,
                        "name": "Field Name",
                        "alias": "usr_first_name",
                        "value": "RU",
                        "root_field": "null"
                      }
                    }
                  }
                ]
              }
            }
          ],
          "options": [
            {
              "id": 198,
              "name": "Choose me!",
              "position": 9,
              "value": "198",
              "is_active": true,
              "is_selectable": true
            }
          ],
          "settings": [],
          "is_locked": false,
          "value_details": [
            "value1",
            "value2"
          ],
          "values_count": 2,
          "assignment_settings": [
            {
              "setting": "public",
              "value": "1"
            }
          ],
          "access_permissions": {
            "history": true,
            "view": true,
            "edit": true
          },
          "assignment_permissions": {
            "permissions": {
              "id": 1,
              "name": "View",
              "alias": "view"
            },
            "access_list": [
              "0",
              "1",
              "1"
            ]
          }
        }
      }
    },
    "value": "updated value",
    "updated_at": "2019-01-01 23:34:40"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "field": {
          "type": "number"
        },
        "data_type": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "name": {
              "type": "string"
            },
            "alias": {
              "type": "string"
            },
            "settings": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "number"
                  },
                  "name": {
                    "type": "string"
                  },
                  "alias": {
                    "type": "string"
                  },
                  "is_required": {
                    "type": "boolean"
                  }
                },
                "required": [
                  "id",
                  "name",
                  "alias",
                  "is_required"
                ]
              }
            },
            "supports_collection": {
              "type": "boolean"
            },
            "supports_read_only": {
              "type": "boolean"
            },
            "supports_unique": {
              "type": "boolean"
            }
          },
          "required": [
            "id",
            "name",
            "alias",
            "supports_collection",
            "supports_read_only",
            "supports_unique"
          ]
        },
        "action_type": {
          "type": "string"
        },
        "user": {
          "type": "object",
          "properties": {
            "summary": {
              "type": "object",
              "properties": {
                "first_name": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "number"
                    },
                    "alias": {
                      "type": "string"
                    },
                    "value": {
                      "type": "string",
                      "description": "if field support multiple values it can be array"
                    }
                  },
                  "required": [
                    "id",
                    "alias",
                    "value"
                  ]
                },
                "last_name": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "number"
                    },
                    "alias": {
                      "type": "string"
                    },
                    "value": {
                      "type": "string",
                      "description": "if field support multiple values it can be array"
                    }
                  },
                  "required": [
                    "id",
                    "alias",
                    "value"
                  ]
                },
                "image": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "number"
                    },
                    "alias": {
                      "type": "string"
                    },
                    "value": {
                      "type": "string",
                      "description": "if field support multiple values it can be array"
                    }
                  },
                  "required": [
                    "id",
                    "alias",
                    "value"
                  ]
                },
                "is_active": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "number"
                    },
                    "alias": {
                      "type": "string"
                    },
                    "value": {
                      "type": "string",
                      "description": "if field support multiple values it can be array"
                    }
                  },
                  "required": [
                    "id",
                    "alias",
                    "value"
                  ]
                },
                "email": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "number"
                    },
                    "alias": {
                      "type": "string"
                    },
                    "value": {
                      "type": "string",
                      "description": "if field support multiple values it can be array"
                    }
                  },
                  "required": [
                    "id",
                    "alias",
                    "value"
                  ]
                },
                "phone_number": {
                  "type": "string"
                }
              },
              "required": [
                "first_name",
                "last_name",
                "image",
                "is_active",
                "email",
                "phone_number"
              ]
            },
            "pso": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number"
                },
                "profile_form": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "number"
                    },
                    "name": {
                      "type": "string"
                    },
                    "description": {
                      "type": "string"
                    },
                    "is_active": {
                      "type": "boolean"
                    },
                    "active_field": {
                      "type": [
                        "string",
                        "null"
                      ]
                    }
                  },
                  "required": [
                    "id",
                    "name",
                    "description",
                    "is_active"
                  ]
                },
                "pso_type": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "number"
                    },
                    "name": {
                      "type": "string"
                    },
                    "alias": {
                      "type": "string"
                    },
                    "description": {
                      "type": "string"
                    },
                    "is_active": {
                      "type": "boolean"
                    },
                    "system_required": {
                      "type": "boolean"
                    },
                    "creation_form_instance_id": {
                      "type": "number"
                    },
                    "profile_form_instance_id": {
                      "type": "number"
                    }
                  },
                  "required": [
                    "id",
                    "name",
                    "alias",
                    "description",
                    "is_active",
                    "system_required",
                    "creation_form_instance_id",
                    "profile_form_instance_id"
                  ]
                },
                "categories": {
                  "type": "array"
                },
                "fields": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "number"
                    },
                    "name": {
                      "type": "string"
                    },
                    "position": {
                      "type": "number"
                    },
                    "alias": {
                      "type": "string"
                    },
                    "has_unique_data": {
                      "type": "boolean",
                      "description": "whether field requires values to be unique across system"
                    },
                    "has_value": {
                      "type": "boolean",
                      "description": "whether field has at least one value submitted"
                    },
                    "removable": {
                      "type": "boolean",
                      "description": "whether field can be removed from system"
                    },
                    "is_active": {
                      "type": "boolean"
                    },
                    "list": {
                      "type": "boolean",
                      "description": "whether field can handle collection of values"
                    },
                    "read_only": {
                      "type": "boolean",
                      "description": "whether field value can be changed"
                    },
                    "required": {
                      "type": "boolean",
                      "description": "whether field value required by system"
                    },
                    "type": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "number"
                        },
                        "name": {
                          "type": "string"
                        },
                        "alias": {
                          "type": "string"
                        },
                        "settings": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "number"
                              },
                              "name": {
                                "type": "string"
                              },
                              "alias": {
                                "type": "string"
                              },
                              "is_required": {
                                "type": "boolean"
                              }
                            },
                            "required": [
                              "id",
                              "name",
                              "alias",
                              "is_required"
                            ]
                          }
                        },
                        "supports_collection": {
                          "type": "boolean"
                        },
                        "supports_read_only": {
                          "type": "boolean"
                        },
                        "supports_unique": {
                          "type": "boolean"
                        }
                      },
                      "required": [
                        "id",
                        "name",
                        "alias",
                        "settings",
                        "supports_collection",
                        "supports_read_only",
                        "supports_unique"
                      ],
                      "additionalProperties": false
                    },
                    "category": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "number"
                        },
                        "alias": {
                          "type": "string"
                        },
                        "position": {
                          "type": "number"
                        },
                        "system_required": {
                          "type": "boolean"
                        },
                        "name": {
                          "type": "string"
                        },
                        "description": {
                          "type": "string"
                        },
                        "is_active": {
                          "type": "boolean"
                        },
                        "pso_type": {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "number"
                            },
                            "name": {
                              "type": "string"
                            },
                            "alias": {
                              "type": "string"
                            },
                            "description": {
                              "type": "string"
                            },
                            "is_active": {
                              "type": "boolean"
                            },
                            "system_required": {
                              "type": "boolean"
                            },
                            "creation_form_instance_id": {
                              "type": "number"
                            },
                            "profile_form_instance_id": {
                              "type": "number"
                            }
                          },
                          "required": [
                            "id",
                            "name",
                            "alias",
                            "description",
                            "is_active",
                            "system_required",
                            "creation_form_instance_id",
                            "profile_form_instance_id"
                          ],
                          "additionalProperties": false,
                          "description": "Presented only if `include` was send"
                        }
                      },
                      "required": [
                        "id",
                        "alias",
                        "position",
                        "system_required",
                        "name",
                        "description",
                        "is_active"
                      ],
                      "additionalProperties": false
                    },
                    "domains": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "number"
                          },
                          "alias": {
                            "type": "string"
                          },
                          "name": {
                            "type": "string"
                          },
                          "description": {
                            "type": "string"
                          },
                          "is_editable": {
                            "type": "boolean"
                          },
                          "is_removable": {
                            "type": "boolean"
                          },
                          "is_active": {
                            "type": "boolean"
                          },
                          "pso_type": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "number"
                              },
                              "name": {
                                "type": "string"
                              },
                              "alias": {
                                "type": "string"
                              },
                              "description": {
                                "type": "string"
                              },
                              "is_active": {
                                "type": "boolean"
                              },
                              "system_required": {
                                "type": "boolean"
                              },
                              "creation_form_instance_id": {
                                "type": "number"
                              },
                              "profile_form_instance_id": {
                                "type": "number"
                              }
                            },
                            "required": [
                              "id",
                              "name",
                              "alias",
                              "description",
                              "is_active",
                              "system_required",
                              "creation_form_instance_id",
                              "profile_form_instance_id"
                            ],
                            "additionalProperties": false
                          }
                        },
                        "required": [
                          "id",
                          "alias",
                          "name",
                          "description",
                          "is_editable",
                          "is_removable",
                          "is_active"
                        ]
                      }
                    },
                    "privacy_level": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "number"
                        },
                        "alias": {
                          "type": "string"
                        },
                        "name": {
                          "type": "string"
                        },
                        "level": {
                          "type": "number"
                        }
                      },
                      "required": [
                        "id",
                        "alias",
                        "name",
                        "level"
                      ],
                      "additionalProperties": false
                    },
                    "pso_type": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "number"
                        },
                        "name": {
                          "type": "string"
                        },
                        "alias": {
                          "type": "string"
                        },
                        "description": {
                          "type": "string"
                        },
                        "is_active": {
                          "type": "boolean"
                        },
                        "system_required": {
                          "type": "boolean"
                        },
                        "creation_form_instance_id": {
                          "type": "number"
                        },
                        "profile_form_instance_id": {
                          "type": "number"
                        }
                      },
                      "required": [
                        "id",
                        "name",
                        "alias",
                        "description",
                        "is_active",
                        "system_required",
                        "creation_form_instance_id",
                        "profile_form_instance_id"
                      ],
                      "additionalProperties": false
                    },
                    "items": {
                      "type": [
                        "array",
                        "null"
                      ],
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "number"
                          },
                          "name": {
                            "type": "string"
                          },
                          "position": {
                            "type": "number"
                          },
                          "alias": {
                            "type": "string"
                          },
                          "has_unique_data": {
                            "type": "boolean",
                            "description": "whether field requires values to be unique across system"
                          },
                          "has_value": {
                            "type": "boolean",
                            "description": "whether field has at least one value submitted"
                          },
                          "removable": {
                            "type": "boolean",
                            "description": "whether field can be removed from system"
                          },
                          "is_active": {
                            "type": "boolean"
                          },
                          "list": {
                            "type": "boolean",
                            "description": "whether field can handle collection of values"
                          },
                          "read_only": {
                            "type": "boolean",
                            "description": "whether field value can be changed"
                          },
                          "required": {
                            "type": "boolean",
                            "description": "deprecated setting"
                          },
                          "user_required": {
                            "type": "boolean",
                            "description": "whether field value required by user"
                          },
                          "system_required": {
                            "type": "boolean",
                            "description": "whether field value required by system"
                          },
                          "type": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "number"
                              },
                              "name": {
                                "type": "string"
                              },
                              "alias": {
                                "type": "string"
                              },
                              "settings": {
                                "type": "array",
                                "items": {
                                  "type": "object",
                                  "properties": {
                                    "id": {
                                      "type": "number"
                                    },
                                    "name": {
                                      "type": "string"
                                    },
                                    "alias": {
                                      "type": "string"
                                    },
                                    "is_required": {
                                      "type": "boolean"
                                    }
                                  },
                                  "required": [
                                    "id",
                                    "name",
                                    "alias",
                                    "is_required"
                                  ]
                                }
                              },
                              "supports_collection": {
                                "type": "boolean"
                              },
                              "supports_read_only": {
                                "type": "boolean"
                              },
                              "supports_unique": {
                                "type": "boolean"
                              }
                            },
                            "required": [
                              "id",
                              "name",
                              "alias",
                              "settings",
                              "supports_collection",
                              "supports_read_only",
                              "supports_unique"
                            ],
                            "additionalProperties": false
                          },
                          "category": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "number"
                              },
                              "alias": {
                                "type": "string"
                              },
                              "position": {
                                "type": "number"
                              },
                              "system_required": {
                                "type": "boolean"
                              },
                              "name": {
                                "type": "string"
                              },
                              "description": {
                                "type": "string"
                              },
                              "is_active": {
                                "type": "boolean"
                              },
                              "pso_type": {
                                "type": "object",
                                "properties": {
                                  "id": {
                                    "type": "number"
                                  },
                                  "name": {
                                    "type": "string"
                                  },
                                  "alias": {
                                    "type": "string"
                                  },
                                  "description": {
                                    "type": "string"
                                  },
                                  "is_active": {
                                    "type": "boolean"
                                  },
                                  "system_required": {
                                    "type": "boolean"
                                  },
                                  "creation_form_instance_id": {
                                    "type": "number"
                                  },
                                  "profile_form_instance_id": {
                                    "type": "number"
                                  }
                                },
                                "required": [
                                  "id",
                                  "name",
                                  "alias",
                                  "description",
                                  "is_active",
                                  "system_required",
                                  "creation_form_instance_id",
                                  "profile_form_instance_id"
                                ],
                                "additionalProperties": false,
                                "description": "Presented only if `include` was send"
                              }
                            },
                            "required": [
                              "id",
                              "alias",
                              "position",
                              "system_required",
                              "name",
                              "description",
                              "is_active"
                            ],
                            "additionalProperties": false
                          },
                          "domains": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "id": {
                                  "type": "number"
                                },
                                "alias": {
                                  "type": "string"
                                },
                                "name": {
                                  "type": "string"
                                },
                                "description": {
                                  "type": "string"
                                },
                                "is_editable": {
                                  "type": "boolean"
                                },
                                "is_removable": {
                                  "type": "boolean"
                                },
                                "is_active": {
                                  "type": "boolean"
                                },
                                "pso_type": {
                                  "type": "object",
                                  "properties": {
                                    "id": {
                                      "type": "number"
                                    },
                                    "name": {
                                      "type": "string"
                                    },
                                    "alias": {
                                      "type": "string"
                                    },
                                    "description": {
                                      "type": "string"
                                    },
                                    "is_active": {
                                      "type": "boolean"
                                    },
                                    "system_required": {
                                      "type": "boolean"
                                    },
                                    "creation_form_instance_id": {
                                      "type": "number"
                                    },
                                    "profile_form_instance_id": {
                                      "type": "number"
                                    }
                                  },
                                  "required": [
                                    "id",
                                    "name",
                                    "alias",
                                    "description",
                                    "is_active",
                                    "system_required",
                                    "creation_form_instance_id",
                                    "profile_form_instance_id"
                                  ],
                                  "additionalProperties": false
                                }
                              },
                              "required": [
                                "id",
                                "alias",
                                "name",
                                "description",
                                "is_editable",
                                "is_removable",
                                "is_active"
                              ]
                            }
                          },
                          "privacy_level": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "number"
                              },
                              "alias": {
                                "type": "string"
                              },
                              "name": {
                                "type": "string"
                              },
                              "level": {
                                "type": "number"
                              }
                            },
                            "required": [
                              "id",
                              "alias",
                              "name",
                              "level"
                            ],
                            "additionalProperties": false
                          },
                          "pso_type": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "number"
                              },
                              "name": {
                                "type": "string"
                              },
                              "alias": {
                                "type": "string"
                              },
                              "description": {
                                "type": "string"
                              },
                              "is_active": {
                                "type": "boolean"
                              },
                              "system_required": {
                                "type": "boolean"
                              },
                              "creation_form_instance_id": {
                                "type": "number"
                              },
                              "profile_form_instance_id": {
                                "type": "number"
                              }
                            },
                            "required": [
                              "id",
                              "name",
                              "alias",
                              "description",
                              "is_active",
                              "system_required",
                              "creation_form_instance_id",
                              "profile_form_instance_id"
                            ],
                            "additionalProperties": false
                          },
                          "items": {
                            "type": [
                              "array",
                              "null"
                            ],
                            "items": {
                              "type": "object",
                              "properties": {}
                            }
                          },
                          "options": {
                            "type": [
                              "array",
                              "null"
                            ],
                            "items": {
                              "type": "object",
                              "properties": {
                                "id": {
                                  "type": "number"
                                },
                                "name": {
                                  "type": "string"
                                },
                                "position": {
                                  "type": "number"
                                },
                                "value": {
                                  "type": "string"
                                },
                                "is_active": {
                                  "type": "boolean"
                                },
                                "is_selectable": {
                                  "type": "boolean",
                                  "description": "Can select on front this option (Using only in Hierarchy field))"
                                }
                              },
                              "required": [
                                "id",
                                "name",
                                "position",
                                "value",
                                "is_active",
                                "is_selectable"
                              ]
                            },
                            "description": "List of options with possible (allowed) values."
                          },
                          "settings": {
                            "type": "array",
                            "items": {
                              "type": "string"
                            },
                            "description": "Common field settings"
                          },
                          "validation": {
                            "type": "object",
                            "properties": {
                              "type": {
                                "type": "string"
                              },
                              "attributes": {
                                "type": "object",
                                "properties": {}
                              },
                              "value_example": {
                                "type": "string"
                              },
                              "error_message": {
                                "type": "object",
                                "properties": {
                                  "en": {
                                    "type": "string"
                                  },
                                  "fr": {
                                    "type": "string"
                                  },
                                  "de": {
                                    "type": "string"
                                  },
                                  "es": {
                                    "type": "string"
                                  }
                                },
                                "required": [
                                  "en",
                                  "fr",
                                  "de",
                                  "es"
                                ]
                              }
                            },
                            "required": [
                              "type",
                              "value_example",
                              "error_message"
                            ]
                          },
                          "has_autocomplete_settings": {
                            "type": "boolean"
                          },
                          "autocomplete_settings": {
                            "type": "object",
                            "properties": {
                              "allow_extra_values": {
                                "type": "boolean"
                              },
                              "autofill": {
                                "type": "boolean"
                              },
                              "provider": {
                                "type": "object",
                                "properties": {
                                  "name": {
                                    "type": "object",
                                    "properties": {
                                      "en": {
                                        "type": "string"
                                      },
                                      "fr": {
                                        "type": "string"
                                      },
                                      "de": {
                                        "type": "string"
                                      },
                                      "es": {
                                        "type": "string"
                                      }
                                    },
                                    "required": [
                                      "en",
                                      "fr",
                                      "de",
                                      "es"
                                    ]
                                  },
                                  "alias": {
                                    "type": "string"
                                  },
                                  "base_url": {
                                    "type": "string"
                                  },
                                  "single_value_supported": {
                                    "type": "boolean"
                                  },
                                  "parameters": {
                                    "type": "array"
                                  }
                                },
                                "required": [
                                  "name",
                                  "alias",
                                  "base_url",
                                  "single_value_supported",
                                  "parameters"
                                ]
                              },
                              "parameters": {
                                "type": "array"
                              }
                            },
                            "required": [
                              "allow_extra_values",
                              "autofill",
                              "provider",
                              "parameters"
                            ]
                          }
                        },
                        "required": [
                          "id",
                          "name",
                          "position",
                          "alias",
                          "has_unique_data",
                          "has_value",
                          "removable",
                          "is_active",
                          "list",
                          "read_only",
                          "required",
                          "user_required",
                          "system_required",
                          "validation",
                          "has_autocomplete_settings",
                          "autocomplete_settings"
                        ]
                      }
                    },
                    "options": {
                      "type": [
                        "array",
                        "null"
                      ],
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "number"
                          },
                          "name": {
                            "type": "string"
                          },
                          "position": {
                            "type": "number"
                          },
                          "value": {
                            "type": "string"
                          },
                          "is_active": {
                            "type": "boolean"
                          },
                          "is_selectable": {
                            "type": "boolean",
                            "description": "Can select on front this option (Using only in Hierarchy field))"
                          }
                        },
                        "required": [
                          "id",
                          "name",
                          "position",
                          "value",
                          "is_active",
                          "is_selectable"
                        ]
                      },
                      "description": "List of options with possible (allowed) values."
                    },
                    "settings": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      },
                      "description": "Common field settings"
                    },
                    "is_locked": {
                      "type": "boolean"
                    },
                    "value_details": {
                      "type": "array"
                    },
                    "values_count": {
                      "type": "number"
                    },
                    "assignment_settings": {
                      "type": "array"
                    },
                    "access_permissions": {
                      "type": "object",
                      "properties": {
                        "history": {
                          "type": "boolean"
                        },
                        "view": {
                          "type": "boolean"
                        },
                        "edit": {
                          "type": "boolean"
                        }
                      },
                      "required": [
                        "history",
                        "view",
                        "edit"
                      ]
                    },
                    "assignment_permissions": {
                      "type": "object",
                      "properties": {
                        "permissions": {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "number"
                            },
                            "name": {
                              "type": "string"
                            },
                            "alias": {
                              "type": "string"
                            }
                          },
                          "required": [
                            "id",
                            "name",
                            "alias"
                          ]
                        },
                        "access_list": {
                          "type": "array",
                          "description": "user, manager, hr"
                        }
                      },
                      "required": [
                        "permissions",
                        "access_list"
                      ]
                    }
                  },
                  "required": [
                    "id",
                    "name",
                    "position",
                    "alias",
                    "has_unique_data",
                    "has_value",
                    "removable",
                    "is_active",
                    "list",
                    "read_only",
                    "required",
                    "is_locked",
                    "value_details",
                    "values_count",
                    "assignment_settings",
                    "access_permissions",
                    "assignment_permissions"
                  ]
                }
              },
              "required": [
                "id"
              ]
            }
          },
          "required": [
            "summary",
            "pso"
          ]
        },
        "value": {
          "type": "string",
          "description": "Items can be History Response as well - in case we have a deal for composite field"
        },
        "updated_at": {
          "type": "string"
        }
      },
      "required": [
        "name",
        "field",
        "data_type",
        "action_type",
        "user",
        "value",
        "updated_at"
      ]
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Language

Available languages and default language.

Language

List
GET/languages

Fetch list of languages

Example URI

GET https://rest.monportailrh.com/languages
Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": 1,
      "alias": "en",
      "name": "English"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number"
          },
          "alias": {
            "type": "string"
          },
          "name": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "alias",
          "name"
        ]
      }
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/languages/default

Get company language. System default language will return if company language not specified.

Example URI

GET https://rest.monportailrh.com/languages/default
Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 1,
    "alias": "en",
    "name": "English"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "alias": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "alias",
        "name"
      ],
      "additionalProperties": false
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Me

Scope of end points which is provide info about logged user, his team, company and assignments.

Management Permissions:

  • hr_request.view.forms - allow to view user form assignments

Me

Show
GET/me

Fetch information about current user

Example URI

GET https://rest.monportailrh.com/me
Request
HideShow
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "summary": {
      "first_name": {
        "id": 1,
        "alias": "usr_first_name",
        "value": "John"
      },
      "last_name": {
        "id": 1,
        "alias": "usr_first_name",
        "value": "John"
      },
      "image": {
        "id": 1,
        "alias": "usr_first_name",
        "value": "John"
      },
      "is_active": {
        "id": 1,
        "alias": "usr_first_name",
        "value": "John"
      },
      "email": {
        "id": 1,
        "alias": "usr_first_name",
        "value": "John"
      },
      "phone_number": ""
    },
    "pso": {
      "id": 1,
      "profile_form": {
        "id": 1,
        "name": "Profile Form",
        "description": "Profile Form Description",
        "is_active": true,
        "active_field": "null"
      },
      "pso_type": {
        "id": 56,
        "name": "User",
        "alias": "usr",
        "description": "...",
        "is_active": true,
        "system_required": true,
        "creation_form_instance_id": 1,
        "profile_form_instance_id": 1
      },
      "categories": [
        {
          "id": 1,
          "name": "Category Name",
          "alias": "category_alias"
        }
      ],
      "fields": {
        "id": 1,
        "name": "Field Name",
        "position": 5,
        "alias": "usr_first_name",
        "has_unique_data": false,
        "has_value": true,
        "removable": false,
        "is_active": true,
        "list": false,
        "read_only": false,
        "required": true,
        "type": {
          "id": 1,
          "name": "Data Type Name",
          "alias": "data_type_alias",
          "settings": [
            {
              "id": 1,
              "name": "Data Type Setting Name",
              "alias": "data_type_setting_alias",
              "is_required": true
            }
          ],
          "supports_collection": false,
          "supports_read_only": false,
          "supports_unique": false
        },
        "category": {
          "id": 32,
          "alias": "usr_identity",
          "position": 5,
          "system_required": true,
          "name": "Identity",
          "description": "...",
          "is_active": true,
          "pso_type": {
            "id": 56,
            "name": "User",
            "alias": "usr",
            "description": "...",
            "is_active": true,
            "system_required": true,
            "creation_form_instance_id": 1,
            "profile_form_instance_id": 1
          }
        },
        "domains": [
          {
            "id": 46,
            "alias": "usr_global",
            "name": "User Global",
            "description": "...",
            "is_editable": false,
            "is_removable": false,
            "is_active": true,
            "pso_type": {
              "id": 56,
              "name": "User",
              "alias": "usr",
              "description": "...",
              "is_active": true,
              "system_required": true,
              "creation_form_instance_id": 1,
              "profile_form_instance_id": 1
            }
          }
        ],
        "privacy_level": {
          "id": 123,
          "alias": "public",
          "name": "Not Sensitive",
          "level": 100
        },
        "pso_type": {
          "id": 56,
          "name": "User",
          "alias": "usr",
          "description": "...",
          "is_active": true,
          "system_required": true,
          "creation_form_instance_id": 1,
          "profile_form_instance_id": 1
        },
        "items": [
          {
            "id": 1,
            "name": "Field Name",
            "position": 5,
            "alias": "usr_first_name",
            "has_unique_data": false,
            "has_value": true,
            "removable": false,
            "is_active": true,
            "list": false,
            "read_only": false,
            "required": true,
            "user_required": true,
            "system_required": true,
            "type": {
              "id": 1,
              "name": "Data Type Name",
              "alias": "data_type_alias",
              "settings": [
                {
                  "id": 1,
                  "name": "Data Type Setting Name",
                  "alias": "data_type_setting_alias",
                  "is_required": true
                }
              ],
              "supports_collection": false,
              "supports_read_only": false,
              "supports_unique": false
            },
            "category": {
              "id": 32,
              "alias": "usr_identity",
              "position": 5,
              "system_required": true,
              "name": "Identity",
              "description": "...",
              "is_active": true,
              "pso_type": {
                "id": 56,
                "name": "User",
                "alias": "usr",
                "description": "...",
                "is_active": true,
                "system_required": true,
                "creation_form_instance_id": 1,
                "profile_form_instance_id": 1
              }
            },
            "domains": [
              {
                "id": 46,
                "alias": "usr_global",
                "name": "User Global",
                "description": "...",
                "is_editable": false,
                "is_removable": false,
                "is_active": true,
                "pso_type": {
                  "id": 56,
                  "name": "User",
                  "alias": "usr",
                  "description": "...",
                  "is_active": true,
                  "system_required": true,
                  "creation_form_instance_id": 1,
                  "profile_form_instance_id": 1
                }
              }
            ],
            "privacy_level": {
              "id": 123,
              "alias": "public",
              "name": "Not Sensitive",
              "level": 100
            },
            "pso_type": {
              "id": 56,
              "name": "User",
              "alias": "usr",
              "description": "...",
              "is_active": true,
              "system_required": true,
              "creation_form_instance_id": 1,
              "profile_form_instance_id": 1
            },
            "items": [
              {}
            ],
            "options": [
              {
                "id": 198,
                "name": "Choose me!",
                "position": 9,
                "value": "198",
                "is_active": true,
                "is_selectable": true
              }
            ],
            "settings": [],
            "validation": {
              "type": "regexp",
              "attributes": {},
              "value_example": "string",
              "error_message": {
                "en": "Some text",
                "fr": "Du texte",
                "de": "Setwas Text",
                "es": "Algún texto"
              }
            },
            "has_autocomplete_settings": true,
            "autocomplete_settings": {
              "allow_extra_values": true,
              "autofill": true,
              "provider": {
                "name": {
                  "en": "Some text",
                  "fr": "Du texte",
                  "de": "Setwas Text",
                  "es": "Algún texto"
                },
                "alias": "string",
                "base_url": "https://exmaple.com/",
                "single_value_supported": true,
                "parameters": [
                  {
                    "name": "Name",
                    "key": "alias",
                    "required": true
                  }
                ]
              },
              "parameters": [
                {
                  "name": "Name",
                  "key": "alias",
                  "required": true,
                  "value": "value",
                  "field": {
                    "id": 1,
                    "name": "Field Name",
                    "alias": "usr_first_name",
                    "value": "RU",
                    "root_field": {
                      "id": 1,
                      "name": "Field Name",
                      "alias": "usr_first_name",
                      "value": "RU",
                      "root_field": "null"
                    }
                  }
                }
              ]
            }
          }
        ],
        "options": [
          {
            "id": 198,
            "name": "Choose me!",
            "position": 9,
            "value": "198",
            "is_active": true,
            "is_selectable": true
          }
        ],
        "settings": [],
        "is_locked": false,
        "value_details": [
          "value1",
          "value2"
        ],
        "values_count": 2,
        "assignment_settings": [
          {
            "setting": "public",
            "value": "1"
          }
        ],
        "access_permissions": {
          "history": true,
          "view": true,
          "edit": true
        },
        "assignment_permissions": {
          "permissions": {
            "id": 1,
            "name": "View",
            "alias": "view"
          },
          "access_list": [
            "0",
            "1",
            "1"
          ]
        }
      }
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "summary": {
          "type": "object",
          "properties": {
            "first_name": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number"
                },
                "alias": {
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "description": "if field support multiple values it can be array"
                }
              },
              "required": [
                "id",
                "alias",
                "value"
              ]
            },
            "last_name": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number"
                },
                "alias": {
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "description": "if field support multiple values it can be array"
                }
              },
              "required": [
                "id",
                "alias",
                "value"
              ]
            },
            "image": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number"
                },
                "alias": {
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "description": "if field support multiple values it can be array"
                }
              },
              "required": [
                "id",
                "alias",
                "value"
              ]
            },
            "is_active": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number"
                },
                "alias": {
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "description": "if field support multiple values it can be array"
                }
              },
              "required": [
                "id",
                "alias",
                "value"
              ]
            },
            "email": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number"
                },
                "alias": {
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "description": "if field support multiple values it can be array"
                }
              },
              "required": [
                "id",
                "alias",
                "value"
              ]
            },
            "phone_number": {
              "type": "string"
            }
          },
          "required": [
            "first_name",
            "last_name",
            "image",
            "is_active",
            "email",
            "phone_number"
          ]
        },
        "pso": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "profile_form": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number"
                },
                "name": {
                  "type": "string"
                },
                "description": {
                  "type": "string"
                },
                "is_active": {
                  "type": "boolean"
                },
                "active_field": {
                  "type": [
                    "string",
                    "null"
                  ]
                }
              },
              "required": [
                "id",
                "name",
                "description",
                "is_active"
              ]
            },
            "pso_type": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number"
                },
                "name": {
                  "type": "string"
                },
                "alias": {
                  "type": "string"
                },
                "description": {
                  "type": "string"
                },
                "is_active": {
                  "type": "boolean"
                },
                "system_required": {
                  "type": "boolean"
                },
                "creation_form_instance_id": {
                  "type": "number"
                },
                "profile_form_instance_id": {
                  "type": "number"
                }
              },
              "required": [
                "id",
                "name",
                "alias",
                "description",
                "is_active",
                "system_required",
                "creation_form_instance_id",
                "profile_form_instance_id"
              ]
            },
            "categories": {
              "type": "array"
            },
            "fields": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number"
                },
                "name": {
                  "type": "string"
                },
                "position": {
                  "type": "number"
                },
                "alias": {
                  "type": "string"
                },
                "has_unique_data": {
                  "type": "boolean",
                  "description": "whether field requires values to be unique across system"
                },
                "has_value": {
                  "type": "boolean",
                  "description": "whether field has at least one value submitted"
                },
                "removable": {
                  "type": "boolean",
                  "description": "whether field can be removed from system"
                },
                "is_active": {
                  "type": "boolean"
                },
                "list": {
                  "type": "boolean",
                  "description": "whether field can handle collection of values"
                },
                "read_only": {
                  "type": "boolean",
                  "description": "whether field value can be changed"
                },
                "required": {
                  "type": "boolean",
                  "description": "whether field value required by system"
                },
                "type": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "number"
                    },
                    "name": {
                      "type": "string"
                    },
                    "alias": {
                      "type": "string"
                    },
                    "settings": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "number"
                          },
                          "name": {
                            "type": "string"
                          },
                          "alias": {
                            "type": "string"
                          },
                          "is_required": {
                            "type": "boolean"
                          }
                        },
                        "required": [
                          "id",
                          "name",
                          "alias",
                          "is_required"
                        ]
                      }
                    },
                    "supports_collection": {
                      "type": "boolean"
                    },
                    "supports_read_only": {
                      "type": "boolean"
                    },
                    "supports_unique": {
                      "type": "boolean"
                    }
                  },
                  "required": [
                    "id",
                    "name",
                    "alias",
                    "settings",
                    "supports_collection",
                    "supports_read_only",
                    "supports_unique"
                  ],
                  "additionalProperties": false
                },
                "category": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "number"
                    },
                    "alias": {
                      "type": "string"
                    },
                    "position": {
                      "type": "number"
                    },
                    "system_required": {
                      "type": "boolean"
                    },
                    "name": {
                      "type": "string"
                    },
                    "description": {
                      "type": "string"
                    },
                    "is_active": {
                      "type": "boolean"
                    },
                    "pso_type": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "number"
                        },
                        "name": {
                          "type": "string"
                        },
                        "alias": {
                          "type": "string"
                        },
                        "description": {
                          "type": "string"
                        },
                        "is_active": {
                          "type": "boolean"
                        },
                        "system_required": {
                          "type": "boolean"
                        },
                        "creation_form_instance_id": {
                          "type": "number"
                        },
                        "profile_form_instance_id": {
                          "type": "number"
                        }
                      },
                      "required": [
                        "id",
                        "name",
                        "alias",
                        "description",
                        "is_active",
                        "system_required",
                        "creation_form_instance_id",
                        "profile_form_instance_id"
                      ],
                      "additionalProperties": false,
                      "description": "Presented only if `include` was send"
                    }
                  },
                  "required": [
                    "id",
                    "alias",
                    "position",
                    "system_required",
                    "name",
                    "description",
                    "is_active"
                  ],
                  "additionalProperties": false
                },
                "domains": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "number"
                      },
                      "alias": {
                        "type": "string"
                      },
                      "name": {
                        "type": "string"
                      },
                      "description": {
                        "type": "string"
                      },
                      "is_editable": {
                        "type": "boolean"
                      },
                      "is_removable": {
                        "type": "boolean"
                      },
                      "is_active": {
                        "type": "boolean"
                      },
                      "pso_type": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "number"
                          },
                          "name": {
                            "type": "string"
                          },
                          "alias": {
                            "type": "string"
                          },
                          "description": {
                            "type": "string"
                          },
                          "is_active": {
                            "type": "boolean"
                          },
                          "system_required": {
                            "type": "boolean"
                          },
                          "creation_form_instance_id": {
                            "type": "number"
                          },
                          "profile_form_instance_id": {
                            "type": "number"
                          }
                        },
                        "required": [
                          "id",
                          "name",
                          "alias",
                          "description",
                          "is_active",
                          "system_required",
                          "creation_form_instance_id",
                          "profile_form_instance_id"
                        ],
                        "additionalProperties": false
                      }
                    },
                    "required": [
                      "id",
                      "alias",
                      "name",
                      "description",
                      "is_editable",
                      "is_removable",
                      "is_active"
                    ]
                  }
                },
                "privacy_level": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "number"
                    },
                    "alias": {
                      "type": "string"
                    },
                    "name": {
                      "type": "string"
                    },
                    "level": {
                      "type": "number"
                    }
                  },
                  "required": [
                    "id",
                    "alias",
                    "name",
                    "level"
                  ],
                  "additionalProperties": false
                },
                "pso_type": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "number"
                    },
                    "name": {
                      "type": "string"
                    },
                    "alias": {
                      "type": "string"
                    },
                    "description": {
                      "type": "string"
                    },
                    "is_active": {
                      "type": "boolean"
                    },
                    "system_required": {
                      "type": "boolean"
                    },
                    "creation_form_instance_id": {
                      "type": "number"
                    },
                    "profile_form_instance_id": {
                      "type": "number"
                    }
                  },
                  "required": [
                    "id",
                    "name",
                    "alias",
                    "description",
                    "is_active",
                    "system_required",
                    "creation_form_instance_id",
                    "profile_form_instance_id"
                  ],
                  "additionalProperties": false
                },
                "items": {
                  "type": [
                    "array",
                    "null"
                  ],
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "number"
                      },
                      "name": {
                        "type": "string"
                      },
                      "position": {
                        "type": "number"
                      },
                      "alias": {
                        "type": "string"
                      },
                      "has_unique_data": {
                        "type": "boolean",
                        "description": "whether field requires values to be unique across system"
                      },
                      "has_value": {
                        "type": "boolean",
                        "description": "whether field has at least one value submitted"
                      },
                      "removable": {
                        "type": "boolean",
                        "description": "whether field can be removed from system"
                      },
                      "is_active": {
                        "type": "boolean"
                      },
                      "list": {
                        "type": "boolean",
                        "description": "whether field can handle collection of values"
                      },
                      "read_only": {
                        "type": "boolean",
                        "description": "whether field value can be changed"
                      },
                      "required": {
                        "type": "boolean",
                        "description": "deprecated setting"
                      },
                      "user_required": {
                        "type": "boolean",
                        "description": "whether field value required by user"
                      },
                      "system_required": {
                        "type": "boolean",
                        "description": "whether field value required by system"
                      },
                      "type": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "number"
                          },
                          "name": {
                            "type": "string"
                          },
                          "alias": {
                            "type": "string"
                          },
                          "settings": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "id": {
                                  "type": "number"
                                },
                                "name": {
                                  "type": "string"
                                },
                                "alias": {
                                  "type": "string"
                                },
                                "is_required": {
                                  "type": "boolean"
                                }
                              },
                              "required": [
                                "id",
                                "name",
                                "alias",
                                "is_required"
                              ]
                            }
                          },
                          "supports_collection": {
                            "type": "boolean"
                          },
                          "supports_read_only": {
                            "type": "boolean"
                          },
                          "supports_unique": {
                            "type": "boolean"
                          }
                        },
                        "required": [
                          "id",
                          "name",
                          "alias",
                          "settings",
                          "supports_collection",
                          "supports_read_only",
                          "supports_unique"
                        ],
                        "additionalProperties": false
                      },
                      "category": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "number"
                          },
                          "alias": {
                            "type": "string"
                          },
                          "position": {
                            "type": "number"
                          },
                          "system_required": {
                            "type": "boolean"
                          },
                          "name": {
                            "type": "string"
                          },
                          "description": {
                            "type": "string"
                          },
                          "is_active": {
                            "type": "boolean"
                          },
                          "pso_type": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "number"
                              },
                              "name": {
                                "type": "string"
                              },
                              "alias": {
                                "type": "string"
                              },
                              "description": {
                                "type": "string"
                              },
                              "is_active": {
                                "type": "boolean"
                              },
                              "system_required": {
                                "type": "boolean"
                              },
                              "creation_form_instance_id": {
                                "type": "number"
                              },
                              "profile_form_instance_id": {
                                "type": "number"
                              }
                            },
                            "required": [
                              "id",
                              "name",
                              "alias",
                              "description",
                              "is_active",
                              "system_required",
                              "creation_form_instance_id",
                              "profile_form_instance_id"
                            ],
                            "additionalProperties": false,
                            "description": "Presented only if `include` was send"
                          }
                        },
                        "required": [
                          "id",
                          "alias",
                          "position",
                          "system_required",
                          "name",
                          "description",
                          "is_active"
                        ],
                        "additionalProperties": false
                      },
                      "domains": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "number"
                            },
                            "alias": {
                              "type": "string"
                            },
                            "name": {
                              "type": "string"
                            },
                            "description": {
                              "type": "string"
                            },
                            "is_editable": {
                              "type": "boolean"
                            },
                            "is_removable": {
                              "type": "boolean"
                            },
                            "is_active": {
                              "type": "boolean"
                            },
                            "pso_type": {
                              "type": "object",
                              "properties": {
                                "id": {
                                  "type": "number"
                                },
                                "name": {
                                  "type": "string"
                                },
                                "alias": {
                                  "type": "string"
                                },
                                "description": {
                                  "type": "string"
                                },
                                "is_active": {
                                  "type": "boolean"
                                },
                                "system_required": {
                                  "type": "boolean"
                                },
                                "creation_form_instance_id": {
                                  "type": "number"
                                },
                                "profile_form_instance_id": {
                                  "type": "number"
                                }
                              },
                              "required": [
                                "id",
                                "name",
                                "alias",
                                "description",
                                "is_active",
                                "system_required",
                                "creation_form_instance_id",
                                "profile_form_instance_id"
                              ],
                              "additionalProperties": false
                            }
                          },
                          "required": [
                            "id",
                            "alias",
                            "name",
                            "description",
                            "is_editable",
                            "is_removable",
                            "is_active"
                          ]
                        }
                      },
                      "privacy_level": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "number"
                          },
                          "alias": {
                            "type": "string"
                          },
                          "name": {
                            "type": "string"
                          },
                          "level": {
                            "type": "number"
                          }
                        },
                        "required": [
                          "id",
                          "alias",
                          "name",
                          "level"
                        ],
                        "additionalProperties": false
                      },
                      "pso_type": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "number"
                          },
                          "name": {
                            "type": "string"
                          },
                          "alias": {
                            "type": "string"
                          },
                          "description": {
                            "type": "string"
                          },
                          "is_active": {
                            "type": "boolean"
                          },
                          "system_required": {
                            "type": "boolean"
                          },
                          "creation_form_instance_id": {
                            "type": "number"
                          },
                          "profile_form_instance_id": {
                            "type": "number"
                          }
                        },
                        "required": [
                          "id",
                          "name",
                          "alias",
                          "description",
                          "is_active",
                          "system_required",
                          "creation_form_instance_id",
                          "profile_form_instance_id"
                        ],
                        "additionalProperties": false
                      },
                      "items": {
                        "type": [
                          "array",
                          "null"
                        ],
                        "items": {
                          "type": "object",
                          "properties": {}
                        }
                      },
                      "options": {
                        "type": [
                          "array",
                          "null"
                        ],
                        "items": {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "number"
                            },
                            "name": {
                              "type": "string"
                            },
                            "position": {
                              "type": "number"
                            },
                            "value": {
                              "type": "string"
                            },
                            "is_active": {
                              "type": "boolean"
                            },
                            "is_selectable": {
                              "type": "boolean",
                              "description": "Can select on front this option (Using only in Hierarchy field))"
                            }
                          },
                          "required": [
                            "id",
                            "name",
                            "position",
                            "value",
                            "is_active",
                            "is_selectable"
                          ]
                        },
                        "description": "List of options with possible (allowed) values."
                      },
                      "settings": {
                        "type": "array",
                        "items": {
                          "type": "string"
                        },
                        "description": "Common field settings"
                      },
                      "validation": {
                        "type": "object",
                        "properties": {
                          "type": {
                            "type": "string"
                          },
                          "attributes": {
                            "type": "object",
                            "properties": {}
                          },
                          "value_example": {
                            "type": "string"
                          },
                          "error_message": {
                            "type": "object",
                            "properties": {
                              "en": {
                                "type": "string"
                              },
                              "fr": {
                                "type": "string"
                              },
                              "de": {
                                "type": "string"
                              },
                              "es": {
                                "type": "string"
                              }
                            },
                            "required": [
                              "en",
                              "fr",
                              "de",
                              "es"
                            ]
                          }
                        },
                        "required": [
                          "type",
                          "value_example",
                          "error_message"
                        ]
                      },
                      "has_autocomplete_settings": {
                        "type": "boolean"
                      },
                      "autocomplete_settings": {
                        "type": "object",
                        "properties": {
                          "allow_extra_values": {
                            "type": "boolean"
                          },
                          "autofill": {
                            "type": "boolean"
                          },
                          "provider": {
                            "type": "object",
                            "properties": {
                              "name": {
                                "type": "object",
                                "properties": {
                                  "en": {
                                    "type": "string"
                                  },
                                  "fr": {
                                    "type": "string"
                                  },
                                  "de": {
                                    "type": "string"
                                  },
                                  "es": {
                                    "type": "string"
                                  }
                                },
                                "required": [
                                  "en",
                                  "fr",
                                  "de",
                                  "es"
                                ]
                              },
                              "alias": {
                                "type": "string"
                              },
                              "base_url": {
                                "type": "string"
                              },
                              "single_value_supported": {
                                "type": "boolean"
                              },
                              "parameters": {
                                "type": "array"
                              }
                            },
                            "required": [
                              "name",
                              "alias",
                              "base_url",
                              "single_value_supported",
                              "parameters"
                            ]
                          },
                          "parameters": {
                            "type": "array"
                          }
                        },
                        "required": [
                          "allow_extra_values",
                          "autofill",
                          "provider",
                          "parameters"
                        ]
                      }
                    },
                    "required": [
                      "id",
                      "name",
                      "position",
                      "alias",
                      "has_unique_data",
                      "has_value",
                      "removable",
                      "is_active",
                      "list",
                      "read_only",
                      "required",
                      "user_required",
                      "system_required",
                      "validation",
                      "has_autocomplete_settings",
                      "autocomplete_settings"
                    ]
                  }
                },
                "options": {
                  "type": [
                    "array",
                    "null"
                  ],
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "number"
                      },
                      "name": {
                        "type": "string"
                      },
                      "position": {
                        "type": "number"
                      },
                      "value": {
                        "type": "string"
                      },
                      "is_active": {
                        "type": "boolean"
                      },
                      "is_selectable": {
                        "type": "boolean",
                        "description": "Can select on front this option (Using only in Hierarchy field))"
                      }
                    },
                    "required": [
                      "id",
                      "name",
                      "position",
                      "value",
                      "is_active",
                      "is_selectable"
                    ]
                  },
                  "description": "List of options with possible (allowed) values."
                },
                "settings": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  },
                  "description": "Common field settings"
                },
                "is_locked": {
                  "type": "boolean"
                },
                "value_details": {
                  "type": "array"
                },
                "values_count": {
                  "type": "number"
                },
                "assignment_settings": {
                  "type": "array"
                },
                "access_permissions": {
                  "type": "object",
                  "properties": {
                    "history": {
                      "type": "boolean"
                    },
                    "view": {
                      "type": "boolean"
                    },
                    "edit": {
                      "type": "boolean"
                    }
                  },
                  "required": [
                    "history",
                    "view",
                    "edit"
                  ]
                },
                "assignment_permissions": {
                  "type": "object",
                  "properties": {
                    "permissions": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "number"
                        },
                        "name": {
                          "type": "string"
                        },
                        "alias": {
                          "type": "string"
                        }
                      },
                      "required": [
                        "id",
                        "name",
                        "alias"
                      ]
                    },
                    "access_list": {
                      "type": "array",
                      "description": "user, manager, hr"
                    }
                  },
                  "required": [
                    "permissions",
                    "access_list"
                  ]
                }
              },
              "required": [
                "id",
                "name",
                "position",
                "alias",
                "has_unique_data",
                "has_value",
                "removable",
                "is_active",
                "list",
                "read_only",
                "required",
                "is_locked",
                "value_details",
                "values_count",
                "assignment_settings",
                "access_permissions",
                "assignment_permissions"
              ]
            }
          },
          "required": [
            "id"
          ]
        }
      },
      "required": [
        "summary",
        "pso"
      ]
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Team
GET/me/team

Fetch team of current user

Example URI

GET https://rest.monportailrh.com/me/team
Request
HideShow
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": 1,
      "first_name": "John",
      "last_name": "Snow",
      "professional_email": "john.snow@email.com",
      "role": "admin",
      "is_active": true,
      "status": "Hello, world!",
      "user_photo": "https://rest-dev.monportailrh.com/storage/company/images/image.jpeg",
      "modules": [
        {
          "id": 1,
          "name": "Module name",
          "alias": "mdl",
          "app_url": {
            "android": "http://android/app/url",
            "ios": "http://ios/app/url"
          },
          "store_url": {
            "android": "http://android/store/url",
            "ios": "http://ios/store/url"
          },
          "web_url": "http://web/url",
          "icon": "http://image.png",
          "permissions": [
            {
              "access": true,
              "synchronisation": true
            }
          ]
        }
      ],
      "features": [
        {
          "id": 1,
          "alias": "feature_alias",
          "name": "Feature Name"
        }
      ],
      "internal_modules": [
        "time_tracking"
      ]
    }
  ],
  "meta": {
    "pagination": {
      "total": 238,
      "count": 25,
      "per_page": 25,
      "current_page": 2,
      "total_pages": 10,
      "links": {
        "previous": "http://example.com/api/<endpoint>?page=1",
        "next": "http://example.com/api/<endpoint>?page=3"
      }
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number"
          },
          "first_name": {
            "type": "string"
          },
          "last_name": {
            "type": "string"
          },
          "professional_email": {
            "type": "string"
          },
          "role": {
            "type": "string"
          },
          "is_active": {
            "type": "boolean"
          },
          "status": {
            "type": "string"
          },
          "user_photo": {
            "type": "string"
          },
          "modules": {
            "type": "array"
          },
          "features": {
            "type": "array"
          },
          "internal_modules": {
            "type": "array"
          }
        },
        "required": [
          "id",
          "first_name",
          "last_name",
          "professional_email",
          "role",
          "is_active",
          "status",
          "user_photo"
        ]
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number"
            },
            "count": {
              "type": "number"
            },
            "per_page": {
              "type": "number"
            },
            "current_page": {
              "type": "number"
            },
            "total_pages": {
              "type": "number"
            },
            "links": {
              "type": "object",
              "properties": {
                "previous": {
                  "type": "string"
                },
                "next": {
                  "type": "string"
                }
              },
              "required": [
                "previous",
                "next"
              ]
            }
          },
          "required": [
            "total",
            "count",
            "per_page",
            "current_page",
            "total_pages",
            "links"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "pagination"
      ]
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Form Instances
GET/me/form-instances/{type}

Fetch List of form-instances by type (poll | permanent | unique | periodic)

Example URI

GET https://rest.monportailrh.com/me/form-instances/poll
URI Parameters
HideShow
type
string (required) Example: poll

type of form instances

Request
HideShow
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": 1,
      "name": "Form assignment name",
      "description": "Form assignment description",
      "form_id": 123,
      "is_active": true,
      "removable": true,
      "effective_date": "null",
      "can_edit": true,
      "approval_scheduled_date": "null",
      "fields": ""
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Poll (Form Instances)
GET/me/poll

Fetch latest poll available to current user

Example URI

GET https://rest.monportailrh.com/me/poll
Request
HideShow
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": 1,
      "name": "Form assignment name",
      "description": "Form assignment description",
      "form_id": 123,
      "is_active": true,
      "removable": true,
      "effective_date": "null",
      "can_edit": true,
      "approval_scheduled_date": "null",
      "fields": ""
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Time Tracking

Stopwatch-like timer to track work time for employees

Please be notices: declared_location and reported_location can be required if this setting enabled in module config on create time tracking event.

Time Tracking

Status
POST/time-tracking/status

Get actual state of the tracker. It returns last known event for the tracker

Example URI

POST https://rest.monportailrh.com/time-tracking/status
Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target features>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "last_event": {
      "date": "2019-04-24 11:47:47",
      "event": "start",
      "declared_location": {
        "name": "United States of America ,Pueblo",
        "coordinates": {
          "lat": 30.312562,
          "long": 59.873794
        }
      },
      "reported_location": {
        "name": "United States of America ,Pueblo",
        "coordinates": {
          "lat": 30.312562,
          "long": 59.873794
        }
      },
      "in_tolerance_radius": true
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "last_event": {
          "type": "object",
          "properties": {
            "date": {
              "type": "string"
            },
            "event": {
              "type": "string",
              "enum": [
                "start",
                "stop"
              ]
            },
            "declared_location": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string"
                },
                "coordinates": {
                  "type": "object",
                  "properties": {
                    "lat": {
                      "type": "number"
                    },
                    "long": {
                      "type": "number"
                    }
                  },
                  "required": [
                    "lat",
                    "long"
                  ]
                }
              },
              "required": [
                "name"
              ],
              "description": "Location specified by User"
            },
            "reported_location": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string"
                },
                "coordinates": {
                  "type": "object",
                  "properties": {
                    "lat": {
                      "type": "number"
                    },
                    "long": {
                      "type": "number"
                    }
                  },
                  "required": [
                    "lat",
                    "long"
                  ]
                }
              },
              "required": [
                "name"
              ],
              "description": "Real location captured by GPS "
            },
            "in_tolerance_radius": {
              "type": "boolean"
            }
          },
          "required": [
            "date",
            "event",
            "in_tolerance_radius"
          ]
        }
      },
      "required": [
        "last_event"
      ],
      "additionalProperties": false
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 400
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Start / Stop / Pause / Resume
POST/time-tracking/events

Add new event to manage state of tracker

Example URI

POST https://rest.monportailrh.com/time-tracking/events
Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target features>
Body
{
  "event": "start",
  "declared_location": 1,
  "reported_location": {
    "name": "United States of America ,Pueblo",
    "coordinates": {
      "lat": 30.312562,
      "long": 59.873794
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "event": {
      "type": "string",
      "enum": [
        "start",
        "stop"
      ]
    },
    "declared_location": {
      "type": "number",
      "description": "ID of Location PSO that user specified as his current place "
    },
    "reported_location": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "coordinates": {
          "type": "object",
          "properties": {
            "lat": {
              "type": "number"
            },
            "long": {
              "type": "number"
            }
          },
          "required": [
            "lat",
            "long"
          ]
        }
      },
      "required": [
        "name"
      ],
      "description": "Real location object captured with help of GPS"
    }
  },
  "required": [
    "event"
  ]
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "last_event": {
      "date": "2019-04-24 11:47:47",
      "event": "start",
      "declared_location": {
        "name": "United States of America ,Pueblo",
        "coordinates": {
          "lat": 30.312562,
          "long": 59.873794
        }
      },
      "reported_location": {
        "name": "United States of America ,Pueblo",
        "coordinates": {
          "lat": 30.312562,
          "long": 59.873794
        }
      },
      "in_tolerance_radius": true
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "last_event": {
          "type": "object",
          "properties": {
            "date": {
              "type": "string"
            },
            "event": {
              "type": "string",
              "enum": [
                "start",
                "stop"
              ]
            },
            "declared_location": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string"
                },
                "coordinates": {
                  "type": "object",
                  "properties": {
                    "lat": {
                      "type": "number"
                    },
                    "long": {
                      "type": "number"
                    }
                  },
                  "required": [
                    "lat",
                    "long"
                  ]
                }
              },
              "required": [
                "name"
              ],
              "description": "Location specified by User"
            },
            "reported_location": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string"
                },
                "coordinates": {
                  "type": "object",
                  "properties": {
                    "lat": {
                      "type": "number"
                    },
                    "long": {
                      "type": "number"
                    }
                  },
                  "required": [
                    "lat",
                    "long"
                  ]
                }
              },
              "required": [
                "name"
              ],
              "description": "Real location captured by GPS "
            },
            "in_tolerance_radius": {
              "type": "boolean"
            }
          },
          "required": [
            "date",
            "event",
            "in_tolerance_radius"
          ]
        }
      },
      "required": [
        "last_event"
      ],
      "additionalProperties": false
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 400
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Reports
GET/time-tracking/reports{?name,sort-by,sort-direction}

Show list of users that has access to Time Tracking in case to see Event History for them

Example URI

GET https://rest.monportailrh.com/time-tracking/reports?name=John&sort-by=email&sort-direction=asc
URI Parameters
HideShow
name
string (optional) Example: John

Part of of a name to search users by

sort-by
string (optional) Example: email

Field to sort Users by. Possible values: email, name

sort-direction
string (optional) Example: asc

Direction to order results by. Possible values: asc, desc

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 1,
    "external_id": 1,
    "first_name": "John",
    "last_name": "Snow",
    "username": "john_snow",
    "professional_email": "jsnow@example.com",
    "professional_mobile_phone": "00 33 1 40 00 00 00",
    "professional_phone": "00 33 1 40 00 00 00",
    "role": [
      "bastard",
      "king"
    ],
    "is_active": true,
    "status": "remote",
    "settings": [
      "[]"
    ],
    "user_photo": "http://example.com/images/1.jpg"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "external_id": {
          "type": "number"
        },
        "first_name": {
          "type": "string"
        },
        "last_name": {
          "type": "string"
        },
        "username": {
          "type": "string"
        },
        "professional_email": {
          "type": "string"
        },
        "professional_mobile_phone": {
          "type": "string"
        },
        "professional_phone": {
          "type": "string"
        },
        "role": {
          "type": "array"
        },
        "is_active": {
          "type": "boolean"
        },
        "status": {
          "type": "string"
        },
        "settings": {
          "type": "array"
        },
        "user_photo": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "external_id",
        "first_name",
        "last_name",
        "username",
        "professional_email",
        "professional_mobile_phone",
        "professional_phone",
        "role",
        "is_active",
        "status",
        "settings",
        "user_photo"
      ],
      "additionalProperties": false
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Event History
GET/time-tracking/events{?user-id,sort-by,sort-direction}

Fetch time tracking events

Example URI

GET https://rest.monportailrh.com/time-tracking/events?user-id=123&sort-by=date&sort-direction=asc
URI Parameters
HideShow
user-id
integer (optional) Example: 123

Filter events by User.

sort-by
string (optional) Default: date Example: date

Field to sort events by. Possible values: date, event, declared_location.name, reported_location.name

sort-direction
string (optional) Default: desc Example: asc

Direction to order results by. Possible values: asc, desc

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "date": "2019-04-24 11:47:47",
      "event": "start",
      "declared_location": {
        "name": "United States of America ,Pueblo",
        "coordinates": {
          "lat": 30.312562,
          "long": 59.873794
        }
      },
      "reported_location": {
        "name": "United States of America ,Pueblo",
        "coordinates": {
          "lat": 30.312562,
          "long": 59.873794
        }
      },
      "in_tolerance_radius": true
    }
  ],
  "meta": {
    "pagination": {
      "total": 238,
      "count": 25,
      "per_page": 25,
      "current_page": 2,
      "total_pages": 10,
      "links": {
        "previous": "http://example.com/api/<endpoint>?page=1",
        "next": "http://example.com/api/<endpoint>?page=3"
      }
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "date": {
            "type": "string"
          },
          "event": {
            "type": "string",
            "enum": [
              "start",
              "stop"
            ]
          },
          "declared_location": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string"
              },
              "coordinates": {
                "type": "object",
                "properties": {
                  "lat": {
                    "type": "number"
                  },
                  "long": {
                    "type": "number"
                  }
                },
                "required": [
                  "lat",
                  "long"
                ]
              }
            },
            "required": [
              "name"
            ],
            "description": "Location specified by User"
          },
          "reported_location": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string"
              },
              "coordinates": {
                "type": "object",
                "properties": {
                  "lat": {
                    "type": "number"
                  },
                  "long": {
                    "type": "number"
                  }
                },
                "required": [
                  "lat",
                  "long"
                ]
              }
            },
            "required": [
              "name"
            ],
            "description": "Real location captured by GPS "
          },
          "in_tolerance_radius": {
            "type": "boolean"
          }
        },
        "required": [
          "date",
          "event",
          "in_tolerance_radius"
        ]
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number"
            },
            "count": {
              "type": "number"
            },
            "per_page": {
              "type": "number"
            },
            "current_page": {
              "type": "number"
            },
            "total_pages": {
              "type": "number"
            },
            "links": {
              "type": "object",
              "properties": {
                "previous": {
                  "type": "string"
                },
                "next": {
                  "type": "string"
                }
              },
              "required": [
                "previous",
                "next"
              ]
            }
          },
          "required": [
            "total",
            "count",
            "per_page",
            "current_page",
            "total_pages",
            "links"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "pagination"
      ]
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

News

News articles. Can be presented in 2 ways:

  • Standard news (has title, body, author and timestamps)

  • Top News (in addition to common parameters has )

News

List View
GET/news{?title,published-only,sort,order}

Fetch list of news for main page. Use population functional.

Example URI

GET https://rest.monportailrh.com/news?title=News to search&published-only=Filter by state&sort=title&order=asc
URI Parameters
HideShow
published-only
boolean (optional) Example: Filter by state

Get only published News. Filtering use publish-date attribute.

title
string (optional) Example: News to search

Search by new title. Non strict, case-insensitive.

sort
publish-date, title (optional) Default: publish-date Example: title

Field to sort news by.

order
asc, desc (optional) Default: desc Example: asc

Direction to order news by.

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": 1,
      "creator": {
        "id": 1,
        "external_id": 1,
        "first_name": "John",
        "last_name": "Snow",
        "username": "john_snow",
        "professional_email": "jsnow@example.com",
        "professional_mobile_phone": "00 33 1 40 00 00 00",
        "professional_phone": "00 33 1 40 00 00 00",
        "role": [
          "bastard",
          "king"
        ],
        "is_active": true,
        "status": "remote",
        "settings": [
          "[]"
        ],
        "user_photo": "http://example.com/images/1.jpg"
      },
      "type_id": 0,
      "title": "News title",
      "body": "Some text",
      "button_text": "Click Me",
      "logo": "http://example.com/images/logo.jpg",
      "banner": "http://example.com/images/banner.jpg",
      "external_link": "http://example.com/news/article-1.html",
      "is_promote_as_top": true,
      "publish_at": "2019-04-24 11:47:47",
      "editable": true
    }
  ],
  "meta": {
    "pagination": {
      "total": 238,
      "count": 25,
      "per_page": 25,
      "current_page": 2,
      "total_pages": 10,
      "links": {
        "previous": "http://example.com/api/<endpoint>?page=1",
        "next": "http://example.com/api/<endpoint>?page=3"
      }
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number"
          },
          "creator": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number"
              },
              "external_id": {
                "type": "number"
              },
              "first_name": {
                "type": "string"
              },
              "last_name": {
                "type": "string"
              },
              "username": {
                "type": "string"
              },
              "professional_email": {
                "type": "string"
              },
              "professional_mobile_phone": {
                "type": "string"
              },
              "professional_phone": {
                "type": "string"
              },
              "role": {
                "type": "array"
              },
              "is_active": {
                "type": "boolean"
              },
              "status": {
                "type": "string"
              },
              "settings": {
                "type": "array"
              },
              "user_photo": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "external_id",
              "first_name",
              "last_name",
              "username",
              "professional_email",
              "professional_mobile_phone",
              "professional_phone",
              "role",
              "is_active",
              "status",
              "settings",
              "user_photo"
            ],
            "additionalProperties": false
          },
          "type_id": {
            "type": "number"
          },
          "title": {
            "type": "string"
          },
          "body": {
            "type": "string"
          },
          "button_text": {
            "type": [
              "string",
              "null"
            ]
          },
          "logo": {
            "type": [
              "string",
              "null"
            ]
          },
          "banner": {
            "type": [
              "string",
              "null"
            ]
          },
          "external_link": {
            "type": [
              "string",
              "null"
            ]
          },
          "is_promote_as_top": {
            "type": "boolean"
          },
          "publish_at": {
            "type": "string"
          },
          "editable": {
            "type": "boolean"
          }
        },
        "required": [
          "id",
          "creator",
          "type_id",
          "title",
          "body",
          "button_text",
          "logo",
          "banner",
          "external_link",
          "is_promote_as_top",
          "publish_at",
          "editable"
        ]
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number"
            },
            "count": {
              "type": "number"
            },
            "per_page": {
              "type": "number"
            },
            "current_page": {
              "type": "number"
            },
            "total_pages": {
              "type": "number"
            },
            "links": {
              "type": "object",
              "properties": {
                "previous": {
                  "type": "string"
                },
                "next": {
                  "type": "string"
                }
              },
              "required": [
                "previous",
                "next"
              ]
            }
          },
          "required": [
            "total",
            "count",
            "per_page",
            "current_page",
            "total_pages",
            "links"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "pagination"
      ]
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

List Management
GET/news-management{?title,published-only,sort,order}

Fetch list of news for management page. Not use population functional.

Example URI

GET https://rest.monportailrh.com/news-management?title=News to search&published-only=Filter by state&sort=title&order=asc
URI Parameters
HideShow
published-only
boolean (optional) Example: Filter by state

Get only published News. Filtering use publish-date attribute.

title
string (optional) Example: News to search

Search by new title. Non strict, case-insensitive.

sort
publish-date, title (optional) Default: publish-date Example: title

Field to sort news by.

order
asc, desc (optional) Default: desc Example: asc

Direction to order news by.

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": 1,
      "creator": {
        "id": 1,
        "external_id": 1,
        "first_name": "John",
        "last_name": "Snow",
        "username": "john_snow",
        "professional_email": "jsnow@example.com",
        "professional_mobile_phone": "00 33 1 40 00 00 00",
        "professional_phone": "00 33 1 40 00 00 00",
        "role": [
          "bastard",
          "king"
        ],
        "is_active": true,
        "status": "remote",
        "settings": [
          "[]"
        ],
        "user_photo": "http://example.com/images/1.jpg"
      },
      "type_id": 0,
      "title": "News title",
      "body": "Some text",
      "button_text": "Click Me",
      "logo": "http://example.com/images/logo.jpg",
      "banner": "http://example.com/images/banner.jpg",
      "external_link": "http://example.com/news/article-1.html",
      "is_promote_as_top": true,
      "publish_at": "2019-04-24 11:47:47",
      "editable": true,
      "population": [
        {
          "type": "all",
          "details": {
            "dynamic": true,
            "includes": [
              "group_a"
            ],
            "excludes": [
              "group_b",
              "group_c"
            ]
          }
        }
      ]
    }
  ],
  "meta": {
    "pagination": {
      "total": 238,
      "count": 25,
      "per_page": 25,
      "current_page": 2,
      "total_pages": 10,
      "links": {
        "previous": "http://example.com/api/<endpoint>?page=1",
        "next": "http://example.com/api/<endpoint>?page=3"
      }
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number"
          },
          "creator": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number"
              },
              "external_id": {
                "type": "number"
              },
              "first_name": {
                "type": "string"
              },
              "last_name": {
                "type": "string"
              },
              "username": {
                "type": "string"
              },
              "professional_email": {
                "type": "string"
              },
              "professional_mobile_phone": {
                "type": "string"
              },
              "professional_phone": {
                "type": "string"
              },
              "role": {
                "type": "array"
              },
              "is_active": {
                "type": "boolean"
              },
              "status": {
                "type": "string"
              },
              "settings": {
                "type": "array"
              },
              "user_photo": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "external_id",
              "first_name",
              "last_name",
              "username",
              "professional_email",
              "professional_mobile_phone",
              "professional_phone",
              "role",
              "is_active",
              "status",
              "settings",
              "user_photo"
            ],
            "additionalProperties": false
          },
          "type_id": {
            "type": "number"
          },
          "title": {
            "type": "string"
          },
          "body": {
            "type": "string"
          },
          "button_text": {
            "type": [
              "string",
              "null"
            ]
          },
          "logo": {
            "type": [
              "string",
              "null"
            ]
          },
          "banner": {
            "type": [
              "string",
              "null"
            ]
          },
          "external_link": {
            "type": [
              "string",
              "null"
            ]
          },
          "is_promote_as_top": {
            "type": "boolean"
          },
          "publish_at": {
            "type": "string"
          },
          "editable": {
            "type": "boolean"
          },
          "population": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "type": {
                  "type": "string",
                  "enum": [
                    "all",
                    "group",
                    "pso",
                    "relation",
                    "self"
                  ]
                },
                "details": {
                  "anyOf": [
                    {
                      "type": "object",
                      "properties": {
                        "dynamic": {
                          "type": "boolean"
                        },
                        "includes": {
                          "type": "array"
                        },
                        "excludes": {
                          "type": "array"
                        }
                      },
                      "required": [
                        "dynamic",
                        "includes",
                        "excludes"
                      ]
                    },
                    {
                      "type": "array",
                      "enum": [
                        [],
                        []
                      ]
                    }
                  ],
                  "type": "null"
                }
              },
              "required": [
                "type",
                "details"
              ]
            }
          }
        },
        "required": [
          "id",
          "creator",
          "type_id",
          "title",
          "body",
          "button_text",
          "logo",
          "banner",
          "external_link",
          "is_promote_as_top",
          "publish_at",
          "editable"
        ]
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number"
            },
            "count": {
              "type": "number"
            },
            "per_page": {
              "type": "number"
            },
            "current_page": {
              "type": "number"
            },
            "total_pages": {
              "type": "number"
            },
            "links": {
              "type": "object",
              "properties": {
                "previous": {
                  "type": "string"
                },
                "next": {
                  "type": "string"
                }
              },
              "required": [
                "previous",
                "next"
              ]
            }
          },
          "required": [
            "total",
            "count",
            "per_page",
            "current_page",
            "total_pages",
            "links"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "pagination"
      ]
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Create
POST/news-management

Create news item

Example URI

POST https://rest.monportailrh.com/news-management
Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: '*'
Body
{
  "type_id": 1,
  "logo": "http://example.com/images/logo.jpg",
  "banner": "http://example.com/images/banner.jpg",
  "external_link": "http://example.com/news/article-1.html",
  "is_promote_as_top": true,
  "publish_at": "2019-04-24 11:47:47",
  "title": {
    "en": "Some text",
    "fr": "Du texte",
    "de": "Setwas Text",
    "es": "Algún texto"
  },
  "body": {
    "en": "Some text",
    "fr": "Du texte",
    "de": "Setwas Text",
    "es": "Algún texto"
  },
  "button_text": {
    "en": "Some text",
    "fr": "Du texte",
    "de": "Setwas Text",
    "es": "Algún texto"
  },
  "population": [
    {
      "type": "all",
      "details": {
        "dynamic": true,
        "includes": [
          "group_a"
        ],
        "excludes": [
          "group_b",
          "group_c"
        ]
      }
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "type_id": {
      "type": "number"
    },
    "logo": {
      "type": [
        "string",
        "null"
      ]
    },
    "banner": {
      "type": [
        "string",
        "null"
      ]
    },
    "external_link": {
      "type": [
        "string",
        "null"
      ]
    },
    "is_promote_as_top": {
      "type": "boolean"
    },
    "publish_at": {
      "type": "string"
    },
    "title": {
      "type": "object",
      "properties": {
        "en": {
          "type": "string"
        },
        "fr": {
          "type": "string"
        },
        "de": {
          "type": "string"
        },
        "es": {
          "type": "string"
        }
      },
      "required": [
        "en",
        "fr",
        "de",
        "es"
      ]
    },
    "body": {
      "type": "object",
      "properties": {
        "en": {
          "type": "string"
        },
        "fr": {
          "type": "string"
        },
        "de": {
          "type": "string"
        },
        "es": {
          "type": "string"
        }
      },
      "required": [
        "en",
        "fr",
        "de",
        "es"
      ]
    },
    "button_text": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "en": {
          "type": "string"
        },
        "fr": {
          "type": "string"
        },
        "de": {
          "type": "string"
        },
        "es": {
          "type": "string"
        }
      },
      "required": [
        "en",
        "fr",
        "de",
        "es"
      ]
    },
    "population": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "all",
              "group",
              "pso",
              "relation",
              "self"
            ]
          },
          "details": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "dynamic": {
                    "type": "boolean"
                  },
                  "includes": {
                    "type": "array"
                  },
                  "excludes": {
                    "type": "array"
                  }
                },
                "required": [
                  "dynamic",
                  "includes",
                  "excludes"
                ]
              },
              {
                "type": "array",
                "enum": [
                  [],
                  []
                ]
              }
            ],
            "type": "null"
          }
        },
        "required": [
          "type",
          "details"
        ]
      }
    }
  },
  "required": [
    "type_id",
    "logo",
    "banner",
    "external_link",
    "is_promote_as_top",
    "publish_at",
    "title",
    "body",
    "button_text"
  ]
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 1,
    "creator": {
      "id": 1,
      "external_id": 1,
      "first_name": "John",
      "last_name": "Snow",
      "username": "john_snow",
      "professional_email": "jsnow@example.com",
      "professional_mobile_phone": "00 33 1 40 00 00 00",
      "professional_phone": "00 33 1 40 00 00 00",
      "role": [
        "bastard",
        "king"
      ],
      "is_active": true,
      "status": "remote",
      "settings": [
        "[]"
      ],
      "user_photo": "http://example.com/images/1.jpg"
    },
    "type_id": 0,
    "title": "News title",
    "body": "Some text",
    "button_text": "Click Me",
    "logo": "http://example.com/images/logo.jpg",
    "banner": "http://example.com/images/banner.jpg",
    "external_link": "http://example.com/news/article-1.html",
    "is_promote_as_top": true,
    "publish_at": "2019-04-24 11:47:47",
    "editable": true,
    "population": [
      {
        "type": "all",
        "details": {
          "dynamic": true,
          "includes": [
            "group_a"
          ],
          "excludes": [
            "group_b",
            "group_c"
          ]
        }
      }
    ]
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "creator": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "external_id": {
              "type": "number"
            },
            "first_name": {
              "type": "string"
            },
            "last_name": {
              "type": "string"
            },
            "username": {
              "type": "string"
            },
            "professional_email": {
              "type": "string"
            },
            "professional_mobile_phone": {
              "type": "string"
            },
            "professional_phone": {
              "type": "string"
            },
            "role": {
              "type": "array"
            },
            "is_active": {
              "type": "boolean"
            },
            "status": {
              "type": "string"
            },
            "settings": {
              "type": "array"
            },
            "user_photo": {
              "type": "string"
            }
          },
          "required": [
            "id",
            "external_id",
            "first_name",
            "last_name",
            "username",
            "professional_email",
            "professional_mobile_phone",
            "professional_phone",
            "role",
            "is_active",
            "status",
            "settings",
            "user_photo"
          ],
          "additionalProperties": false
        },
        "type_id": {
          "type": "number"
        },
        "title": {
          "type": "string"
        },
        "body": {
          "type": "string"
        },
        "button_text": {
          "type": [
            "string",
            "null"
          ]
        },
        "logo": {
          "type": [
            "string",
            "null"
          ]
        },
        "banner": {
          "type": [
            "string",
            "null"
          ]
        },
        "external_link": {
          "type": [
            "string",
            "null"
          ]
        },
        "is_promote_as_top": {
          "type": "boolean"
        },
        "publish_at": {
          "type": "string"
        },
        "editable": {
          "type": "boolean"
        },
        "population": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "type": {
                "type": "string",
                "enum": [
                  "all",
                  "group",
                  "pso",
                  "relation",
                  "self"
                ]
              },
              "details": {
                "anyOf": [
                  {
                    "type": "object",
                    "properties": {
                      "dynamic": {
                        "type": "boolean"
                      },
                      "includes": {
                        "type": "array"
                      },
                      "excludes": {
                        "type": "array"
                      }
                    },
                    "required": [
                      "dynamic",
                      "includes",
                      "excludes"
                    ]
                  },
                  {
                    "type": "array",
                    "enum": [
                      [],
                      []
                    ]
                  }
                ],
                "type": "null"
              }
            },
            "required": [
              "type",
              "details"
            ]
          }
        }
      },
      "required": [
        "id",
        "creator",
        "type_id",
        "title",
        "body",
        "button_text",
        "logo",
        "banner",
        "external_link",
        "is_promote_as_top",
        "publish_at",
        "editable",
        "population"
      ],
      "additionalProperties": false
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 400
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/news-management/{id}

Fetch single news item

Example URI

GET https://rest.monportailrh.com/news-management/query
URI Parameters
HideShow
id
number (required) Example: query

Id of the News item.

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: '*'
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 1,
    "creator": {
      "id": 1,
      "external_id": 1,
      "first_name": "John",
      "last_name": "Snow",
      "username": "john_snow",
      "professional_email": "jsnow@example.com",
      "professional_mobile_phone": "00 33 1 40 00 00 00",
      "professional_phone": "00 33 1 40 00 00 00",
      "role": [
        "bastard",
        "king"
      ],
      "is_active": true,
      "status": "remote",
      "settings": [
        "[]"
      ],
      "user_photo": "http://example.com/images/1.jpg"
    },
    "type_id": 0,
    "title": "News title",
    "body": "Some text",
    "button_text": "Click Me",
    "logo": "http://example.com/images/logo.jpg",
    "banner": "http://example.com/images/banner.jpg",
    "external_link": "http://example.com/news/article-1.html",
    "is_promote_as_top": true,
    "publish_at": "2019-04-24 11:47:47",
    "editable": true,
    "population": [
      {
        "type": "all",
        "details": {
          "dynamic": true,
          "includes": [
            "group_a"
          ],
          "excludes": [
            "group_b",
            "group_c"
          ]
        }
      }
    ]
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "creator": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "external_id": {
              "type": "number"
            },
            "first_name": {
              "type": "string"
            },
            "last_name": {
              "type": "string"
            },
            "username": {
              "type": "string"
            },
            "professional_email": {
              "type": "string"
            },
            "professional_mobile_phone": {
              "type": "string"
            },
            "professional_phone": {
              "type": "string"
            },
            "role": {
              "type": "array"
            },
            "is_active": {
              "type": "boolean"
            },
            "status": {
              "type": "string"
            },
            "settings": {
              "type": "array"
            },
            "user_photo": {
              "type": "string"
            }
          },
          "required": [
            "id",
            "external_id",
            "first_name",
            "last_name",
            "username",
            "professional_email",
            "professional_mobile_phone",
            "professional_phone",
            "role",
            "is_active",
            "status",
            "settings",
            "user_photo"
          ],
          "additionalProperties": false
        },
        "type_id": {
          "type": "number"
        },
        "title": {
          "type": "string"
        },
        "body": {
          "type": "string"
        },
        "button_text": {
          "type": [
            "string",
            "null"
          ]
        },
        "logo": {
          "type": [
            "string",
            "null"
          ]
        },
        "banner": {
          "type": [
            "string",
            "null"
          ]
        },
        "external_link": {
          "type": [
            "string",
            "null"
          ]
        },
        "is_promote_as_top": {
          "type": "boolean"
        },
        "publish_at": {
          "type": "string"
        },
        "editable": {
          "type": "boolean"
        },
        "population": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "type": {
                "type": "string",
                "enum": [
                  "all",
                  "group",
                  "pso",
                  "relation",
                  "self"
                ]
              },
              "details": {
                "anyOf": [
                  {
                    "type": "object",
                    "properties": {
                      "dynamic": {
                        "type": "boolean"
                      },
                      "includes": {
                        "type": "array"
                      },
                      "excludes": {
                        "type": "array"
                      }
                    },
                    "required": [
                      "dynamic",
                      "includes",
                      "excludes"
                    ]
                  },
                  {
                    "type": "array",
                    "enum": [
                      [],
                      []
                    ]
                  }
                ],
                "type": "null"
              }
            },
            "required": [
              "type",
              "details"
            ]
          }
        }
      },
      "required": [
        "id",
        "creator",
        "type_id",
        "title",
        "body",
        "button_text",
        "logo",
        "banner",
        "external_link",
        "is_promote_as_top",
        "publish_at",
        "editable",
        "population"
      ],
      "additionalProperties": false
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete
DELETE/news-management/{id}

Delete news item

Example URI

DELETE https://rest.monportailrh.com/news-management/123
URI Parameters
HideShow
id
number (required) Example: 123

Id of the News item.

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: '*'
Response  204
HideShow
Headers
Content-Type: application/json
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/news-management/{id}

Update news item

Example URI

PATCH https://rest.monportailrh.com/news-management/123
URI Parameters
HideShow
id
number (required) Example: 123

Id of the News item.

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Body
{
  "type_id": 1,
  "logo": "http://example.com/images/logo.jpg",
  "banner": "http://example.com/images/banner.jpg",
  "external_link": "http://example.com/news/article-1.html",
  "is_promote_as_top": true,
  "publish_at": "2019-04-24 11:47:47",
  "title": {
    "en": "Some text",
    "fr": "Du texte",
    "de": "Setwas Text",
    "es": "Algún texto"
  },
  "body": {
    "en": "Some text",
    "fr": "Du texte",
    "de": "Setwas Text",
    "es": "Algún texto"
  },
  "button_text": {
    "en": "Some text",
    "fr": "Du texte",
    "de": "Setwas Text",
    "es": "Algún texto"
  },
  "population": [
    {
      "type": "all",
      "details": {
        "dynamic": true,
        "includes": [
          "group_a"
        ],
        "excludes": [
          "group_b",
          "group_c"
        ]
      }
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "type_id": {
      "type": "number"
    },
    "logo": {
      "type": [
        "string",
        "null"
      ]
    },
    "banner": {
      "type": [
        "string",
        "null"
      ]
    },
    "external_link": {
      "type": [
        "string",
        "null"
      ]
    },
    "is_promote_as_top": {
      "type": "boolean"
    },
    "publish_at": {
      "type": "string"
    },
    "title": {
      "type": "object",
      "properties": {
        "en": {
          "type": "string"
        },
        "fr": {
          "type": "string"
        },
        "de": {
          "type": "string"
        },
        "es": {
          "type": "string"
        }
      },
      "required": [
        "en",
        "fr",
        "de",
        "es"
      ]
    },
    "body": {
      "type": "object",
      "properties": {
        "en": {
          "type": "string"
        },
        "fr": {
          "type": "string"
        },
        "de": {
          "type": "string"
        },
        "es": {
          "type": "string"
        }
      },
      "required": [
        "en",
        "fr",
        "de",
        "es"
      ]
    },
    "button_text": {
      "type": "object",
      "properties": {
        "en": {
          "type": "string"
        },
        "fr": {
          "type": "string"
        },
        "de": {
          "type": "string"
        },
        "es": {
          "type": "string"
        }
      },
      "required": [
        "en",
        "fr",
        "de",
        "es"
      ]
    },
    "population": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "all",
              "group",
              "pso",
              "relation",
              "self"
            ]
          },
          "details": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "dynamic": {
                    "type": "boolean"
                  },
                  "includes": {
                    "type": "array"
                  },
                  "excludes": {
                    "type": "array"
                  }
                },
                "required": [
                  "dynamic",
                  "includes",
                  "excludes"
                ]
              },
              {
                "type": "array",
                "enum": [
                  [],
                  []
                ]
              }
            ],
            "type": "null"
          }
        },
        "required": [
          "type",
          "details"
        ]
      }
    }
  }
}
Response  202
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 1,
    "creator": {
      "id": 1,
      "external_id": 1,
      "first_name": "John",
      "last_name": "Snow",
      "username": "john_snow",
      "professional_email": "jsnow@example.com",
      "professional_mobile_phone": "00 33 1 40 00 00 00",
      "professional_phone": "00 33 1 40 00 00 00",
      "role": [
        "bastard",
        "king"
      ],
      "is_active": true,
      "status": "remote",
      "settings": [
        "[]"
      ],
      "user_photo": "http://example.com/images/1.jpg"
    },
    "type_id": 0,
    "title": "News title",
    "body": "Some text",
    "button_text": "Click Me",
    "logo": "http://example.com/images/logo.jpg",
    "banner": "http://example.com/images/banner.jpg",
    "external_link": "http://example.com/news/article-1.html",
    "is_promote_as_top": true,
    "publish_at": "2019-04-24 11:47:47",
    "editable": true,
    "population": [
      {
        "type": "all",
        "details": {
          "dynamic": true,
          "includes": [
            "group_a"
          ],
          "excludes": [
            "group_b",
            "group_c"
          ]
        }
      }
    ]
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "creator": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "external_id": {
              "type": "number"
            },
            "first_name": {
              "type": "string"
            },
            "last_name": {
              "type": "string"
            },
            "username": {
              "type": "string"
            },
            "professional_email": {
              "type": "string"
            },
            "professional_mobile_phone": {
              "type": "string"
            },
            "professional_phone": {
              "type": "string"
            },
            "role": {
              "type": "array"
            },
            "is_active": {
              "type": "boolean"
            },
            "status": {
              "type": "string"
            },
            "settings": {
              "type": "array"
            },
            "user_photo": {
              "type": "string"
            }
          },
          "required": [
            "id",
            "external_id",
            "first_name",
            "last_name",
            "username",
            "professional_email",
            "professional_mobile_phone",
            "professional_phone",
            "role",
            "is_active",
            "status",
            "settings",
            "user_photo"
          ],
          "additionalProperties": false
        },
        "type_id": {
          "type": "number"
        },
        "title": {
          "type": "string"
        },
        "body": {
          "type": "string"
        },
        "button_text": {
          "type": [
            "string",
            "null"
          ]
        },
        "logo": {
          "type": [
            "string",
            "null"
          ]
        },
        "banner": {
          "type": [
            "string",
            "null"
          ]
        },
        "external_link": {
          "type": [
            "string",
            "null"
          ]
        },
        "is_promote_as_top": {
          "type": "boolean"
        },
        "publish_at": {
          "type": "string"
        },
        "editable": {
          "type": "boolean"
        },
        "population": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "type": {
                "type": "string",
                "enum": [
                  "all",
                  "group",
                  "pso",
                  "relation",
                  "self"
                ]
              },
              "details": {
                "anyOf": [
                  {
                    "type": "object",
                    "properties": {
                      "dynamic": {
                        "type": "boolean"
                      },
                      "includes": {
                        "type": "array"
                      },
                      "excludes": {
                        "type": "array"
                      }
                    },
                    "required": [
                      "dynamic",
                      "includes",
                      "excludes"
                    ]
                  },
                  {
                    "type": "array",
                    "enum": [
                      [],
                      []
                    ]
                  }
                ],
                "type": "null"
              }
            },
            "required": [
              "type",
              "details"
            ]
          }
        }
      },
      "required": [
        "id",
        "creator",
        "type_id",
        "title",
        "body",
        "button_text",
        "logo",
        "banner",
        "external_link",
        "is_promote_as_top",
        "publish_at",
        "editable",
        "population"
      ],
      "additionalProperties": false
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 400
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Notifications

Notifications is way to inform users about various types of events

Notifications

Show
GET/notifications/{notification}

Get details for selected notification

Example URI

GET https://rest.monportailrh.com/notifications/notification
URI Parameters
HideShow
notification
number (required) Example: notification

id of the notification

Request
HideShow
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 1,
    "author": {
      "summary": {
        "first_name": {
          "id": 1,
          "alias": "usr_first_name",
          "value": "John"
        },
        "last_name": {
          "id": 1,
          "alias": "usr_first_name",
          "value": "John"
        },
        "image": {
          "id": 1,
          "alias": "usr_first_name",
          "value": "John"
        },
        "is_active": {
          "id": 1,
          "alias": "usr_first_name",
          "value": "John"
        },
        "email": {
          "id": 1,
          "alias": "usr_first_name",
          "value": "John"
        },
        "phone_number": ""
      },
      "pso": {
        "id": 1,
        "profile_form": {
          "id": 1,
          "name": "Profile Form",
          "description": "Profile Form Description",
          "is_active": true,
          "active_field": "null"
        },
        "pso_type": {
          "id": 56,
          "name": "User",
          "alias": "usr",
          "description": "...",
          "is_active": true,
          "system_required": true,
          "creation_form_instance_id": 1,
          "profile_form_instance_id": 1
        },
        "categories": [
          {
            "id": 1,
            "name": "Category Name",
            "alias": "category_alias"
          }
        ],
        "fields": {
          "id": 1,
          "name": "Field Name",
          "position": 5,
          "alias": "usr_first_name",
          "has_unique_data": false,
          "has_value": true,
          "removable": false,
          "is_active": true,
          "list": false,
          "read_only": false,
          "required": true,
          "type": {
            "id": 1,
            "name": "Data Type Name",
            "alias": "data_type_alias",
            "settings": [
              {
                "id": 1,
                "name": "Data Type Setting Name",
                "alias": "data_type_setting_alias",
                "is_required": true
              }
            ],
            "supports_collection": false,
            "supports_read_only": false,
            "supports_unique": false
          },
          "category": {
            "id": 32,
            "alias": "usr_identity",
            "position": 5,
            "system_required": true,
            "name": "Identity",
            "description": "...",
            "is_active": true,
            "pso_type": {
              "id": 56,
              "name": "User",
              "alias": "usr",
              "description": "...",
              "is_active": true,
              "system_required": true,
              "creation_form_instance_id": 1,
              "profile_form_instance_id": 1
            }
          },
          "domains": [
            {
              "id": 46,
              "alias": "usr_global",
              "name": "User Global",
              "description": "...",
              "is_editable": false,
              "is_removable": false,
              "is_active": true,
              "pso_type": {
                "id": 56,
                "name": "User",
                "alias": "usr",
                "description": "...",
                "is_active": true,
                "system_required": true,
                "creation_form_instance_id": 1,
                "profile_form_instance_id": 1
              }
            }
          ],
          "privacy_level": {
            "id": 123,
            "alias": "public",
            "name": "Not Sensitive",
            "level": 100
          },
          "pso_type": {
            "id": 56,
            "name": "User",
            "alias": "usr",
            "description": "...",
            "is_active": true,
            "system_required": true,
            "creation_form_instance_id": 1,
            "profile_form_instance_id": 1
          },
          "items": [
            {
              "id": 1,
              "name": "Field Name",
              "position": 5,
              "alias": "usr_first_name",
              "has_unique_data": false,
              "has_value": true,
              "removable": false,
              "is_active": true,
              "list": false,
              "read_only": false,
              "required": true,
              "user_required": true,
              "system_required": true,
              "type": {
                "id": 1,
                "name": "Data Type Name",
                "alias": "data_type_alias",
                "settings": [
                  {
                    "id": 1,
                    "name": "Data Type Setting Name",
                    "alias": "data_type_setting_alias",
                    "is_required": true
                  }
                ],
                "supports_collection": false,
                "supports_read_only": false,
                "supports_unique": false
              },
              "category": {
                "id": 32,
                "alias": "usr_identity",
                "position": 5,
                "system_required": true,
                "name": "Identity",
                "description": "...",
                "is_active": true,
                "pso_type": {
                  "id": 56,
                  "name": "User",
                  "alias": "usr",
                  "description": "...",
                  "is_active": true,
                  "system_required": true,
                  "creation_form_instance_id": 1,
                  "profile_form_instance_id": 1
                }
              },
              "domains": [
                {
                  "id": 46,
                  "alias": "usr_global",
                  "name": "User Global",
                  "description": "...",
                  "is_editable": false,
                  "is_removable": false,
                  "is_active": true,
                  "pso_type": {
                    "id": 56,
                    "name": "User",
                    "alias": "usr",
                    "description": "...",
                    "is_active": true,
                    "system_required": true,
                    "creation_form_instance_id": 1,
                    "profile_form_instance_id": 1
                  }
                }
              ],
              "privacy_level": {
                "id": 123,
                "alias": "public",
                "name": "Not Sensitive",
                "level": 100
              },
              "pso_type": {
                "id": 56,
                "name": "User",
                "alias": "usr",
                "description": "...",
                "is_active": true,
                "system_required": true,
                "creation_form_instance_id": 1,
                "profile_form_instance_id": 1
              },
              "items": [
                {}
              ],
              "options": [
                {
                  "id": 198,
                  "name": "Choose me!",
                  "position": 9,
                  "value": "198",
                  "is_active": true,
                  "is_selectable": true
                }
              ],
              "settings": [],
              "validation": {
                "type": "regexp",
                "attributes": {},
                "value_example": "string",
                "error_message": {
                  "en": "Some text",
                  "fr": "Du texte",
                  "de": "Setwas Text",
                  "es": "Algún texto"
                }
              },
              "has_autocomplete_settings": true,
              "autocomplete_settings": {
                "allow_extra_values": true,
                "autofill": true,
                "provider": {
                  "name": {
                    "en": "Some text",
                    "fr": "Du texte",
                    "de": "Setwas Text",
                    "es": "Algún texto"
                  },
                  "alias": "string",
                  "base_url": "https://exmaple.com/",
                  "single_value_supported": true,
                  "parameters": [
                    {
                      "name": "Name",
                      "key": "alias",
                      "required": true
                    }
                  ]
                },
                "parameters": [
                  {
                    "name": "Name",
                    "key": "alias",
                    "required": true,
                    "value": "value",
                    "field": {
                      "id": 1,
                      "name": "Field Name",
                      "alias": "usr_first_name",
                      "value": "RU",
                      "root_field": {
                        "id": 1,
                        "name": "Field Name",
                        "alias": "usr_first_name",
                        "value": "RU",
                        "root_field": "null"
                      }
                    }
                  }
                ]
              }
            }
          ],
          "options": [
            {
              "id": 198,
              "name": "Choose me!",
              "position": 9,
              "value": "198",
              "is_active": true,
              "is_selectable": true
            }
          ],
          "settings": [],
          "is_locked": false,
          "value_details": [
            "value1",
            "value2"
          ],
          "values_count": 2,
          "assignment_settings": [
            {
              "setting": "public",
              "value": "1"
            }
          ],
          "access_permissions": {
            "history": true,
            "view": true,
            "edit": true
          },
          "assignment_permissions": {
            "permissions": {
              "id": 1,
              "name": "View",
              "alias": "view"
            },
            "access_list": [
              "0",
              "1",
              "1"
            ]
          }
        }
      }
    },
    "title": "Notification Title",
    "details": "Notification Details",
    "read_at": "2019-01-01 23:34:40",
    "effective_date": "2019-01-01 23:34:40",
    "expires_at": "2019-01-01 23:34:40",
    "created_at": "2019-01-01 23:34:40",
    "updated_at": "2019-01-01 23:34:40"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "author": {
          "type": "object",
          "properties": {
            "summary": {
              "type": "object",
              "properties": {
                "first_name": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "number"
                    },
                    "alias": {
                      "type": "string"
                    },
                    "value": {
                      "type": "string",
                      "description": "if field support multiple values it can be array"
                    }
                  },
                  "required": [
                    "id",
                    "alias",
                    "value"
                  ]
                },
                "last_name": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "number"
                    },
                    "alias": {
                      "type": "string"
                    },
                    "value": {
                      "type": "string",
                      "description": "if field support multiple values it can be array"
                    }
                  },
                  "required": [
                    "id",
                    "alias",
                    "value"
                  ]
                },
                "image": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "number"
                    },
                    "alias": {
                      "type": "string"
                    },
                    "value": {
                      "type": "string",
                      "description": "if field support multiple values it can be array"
                    }
                  },
                  "required": [
                    "id",
                    "alias",
                    "value"
                  ]
                },
                "is_active": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "number"
                    },
                    "alias": {
                      "type": "string"
                    },
                    "value": {
                      "type": "string",
                      "description": "if field support multiple values it can be array"
                    }
                  },
                  "required": [
                    "id",
                    "alias",
                    "value"
                  ]
                },
                "email": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "number"
                    },
                    "alias": {
                      "type": "string"
                    },
                    "value": {
                      "type": "string",
                      "description": "if field support multiple values it can be array"
                    }
                  },
                  "required": [
                    "id",
                    "alias",
                    "value"
                  ]
                },
                "phone_number": {
                  "type": "string"
                }
              },
              "required": [
                "first_name",
                "last_name",
                "image",
                "is_active",
                "email",
                "phone_number"
              ]
            },
            "pso": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number"
                },
                "profile_form": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "number"
                    },
                    "name": {
                      "type": "string"
                    },
                    "description": {
                      "type": "string"
                    },
                    "is_active": {
                      "type": "boolean"
                    },
                    "active_field": {
                      "type": [
                        "string",
                        "null"
                      ]
                    }
                  },
                  "required": [
                    "id",
                    "name",
                    "description",
                    "is_active"
                  ]
                },
                "pso_type": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "number"
                    },
                    "name": {
                      "type": "string"
                    },
                    "alias": {
                      "type": "string"
                    },
                    "description": {
                      "type": "string"
                    },
                    "is_active": {
                      "type": "boolean"
                    },
                    "system_required": {
                      "type": "boolean"
                    },
                    "creation_form_instance_id": {
                      "type": "number"
                    },
                    "profile_form_instance_id": {
                      "type": "number"
                    }
                  },
                  "required": [
                    "id",
                    "name",
                    "alias",
                    "description",
                    "is_active",
                    "system_required",
                    "creation_form_instance_id",
                    "profile_form_instance_id"
                  ]
                },
                "categories": {
                  "type": "array"
                },
                "fields": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "number"
                    },
                    "name": {
                      "type": "string"
                    },
                    "position": {
                      "type": "number"
                    },
                    "alias": {
                      "type": "string"
                    },
                    "has_unique_data": {
                      "type": "boolean",
                      "description": "whether field requires values to be unique across system"
                    },
                    "has_value": {
                      "type": "boolean",
                      "description": "whether field has at least one value submitted"
                    },
                    "removable": {
                      "type": "boolean",
                      "description": "whether field can be removed from system"
                    },
                    "is_active": {
                      "type": "boolean"
                    },
                    "list": {
                      "type": "boolean",
                      "description": "whether field can handle collection of values"
                    },
                    "read_only": {
                      "type": "boolean",
                      "description": "whether field value can be changed"
                    },
                    "required": {
                      "type": "boolean",
                      "description": "whether field value required by system"
                    },
                    "type": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "number"
                        },
                        "name": {
                          "type": "string"
                        },
                        "alias": {
                          "type": "string"
                        },
                        "settings": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "number"
                              },
                              "name": {
                                "type": "string"
                              },
                              "alias": {
                                "type": "string"
                              },
                              "is_required": {
                                "type": "boolean"
                              }
                            },
                            "required": [
                              "id",
                              "name",
                              "alias",
                              "is_required"
                            ]
                          }
                        },
                        "supports_collection": {
                          "type": "boolean"
                        },
                        "supports_read_only": {
                          "type": "boolean"
                        },
                        "supports_unique": {
                          "type": "boolean"
                        }
                      },
                      "required": [
                        "id",
                        "name",
                        "alias",
                        "settings",
                        "supports_collection",
                        "supports_read_only",
                        "supports_unique"
                      ],
                      "additionalProperties": false
                    },
                    "category": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "number"
                        },
                        "alias": {
                          "type": "string"
                        },
                        "position": {
                          "type": "number"
                        },
                        "system_required": {
                          "type": "boolean"
                        },
                        "name": {
                          "type": "string"
                        },
                        "description": {
                          "type": "string"
                        },
                        "is_active": {
                          "type": "boolean"
                        },
                        "pso_type": {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "number"
                            },
                            "name": {
                              "type": "string"
                            },
                            "alias": {
                              "type": "string"
                            },
                            "description": {
                              "type": "string"
                            },
                            "is_active": {
                              "type": "boolean"
                            },
                            "system_required": {
                              "type": "boolean"
                            },
                            "creation_form_instance_id": {
                              "type": "number"
                            },
                            "profile_form_instance_id": {
                              "type": "number"
                            }
                          },
                          "required": [
                            "id",
                            "name",
                            "alias",
                            "description",
                            "is_active",
                            "system_required",
                            "creation_form_instance_id",
                            "profile_form_instance_id"
                          ],
                          "additionalProperties": false,
                          "description": "Presented only if `include` was send"
                        }
                      },
                      "required": [
                        "id",
                        "alias",
                        "position",
                        "system_required",
                        "name",
                        "description",
                        "is_active"
                      ],
                      "additionalProperties": false
                    },
                    "domains": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "number"
                          },
                          "alias": {
                            "type": "string"
                          },
                          "name": {
                            "type": "string"
                          },
                          "description": {
                            "type": "string"
                          },
                          "is_editable": {
                            "type": "boolean"
                          },
                          "is_removable": {
                            "type": "boolean"
                          },
                          "is_active": {
                            "type": "boolean"
                          },
                          "pso_type": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "number"
                              },
                              "name": {
                                "type": "string"
                              },
                              "alias": {
                                "type": "string"
                              },
                              "description": {
                                "type": "string"
                              },
                              "is_active": {
                                "type": "boolean"
                              },
                              "system_required": {
                                "type": "boolean"
                              },
                              "creation_form_instance_id": {
                                "type": "number"
                              },
                              "profile_form_instance_id": {
                                "type": "number"
                              }
                            },
                            "required": [
                              "id",
                              "name",
                              "alias",
                              "description",
                              "is_active",
                              "system_required",
                              "creation_form_instance_id",
                              "profile_form_instance_id"
                            ],
                            "additionalProperties": false
                          }
                        },
                        "required": [
                          "id",
                          "alias",
                          "name",
                          "description",
                          "is_editable",
                          "is_removable",
                          "is_active"
                        ]
                      }
                    },
                    "privacy_level": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "number"
                        },
                        "alias": {
                          "type": "string"
                        },
                        "name": {
                          "type": "string"
                        },
                        "level": {
                          "type": "number"
                        }
                      },
                      "required": [
                        "id",
                        "alias",
                        "name",
                        "level"
                      ],
                      "additionalProperties": false
                    },
                    "pso_type": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "number"
                        },
                        "name": {
                          "type": "string"
                        },
                        "alias": {
                          "type": "string"
                        },
                        "description": {
                          "type": "string"
                        },
                        "is_active": {
                          "type": "boolean"
                        },
                        "system_required": {
                          "type": "boolean"
                        },
                        "creation_form_instance_id": {
                          "type": "number"
                        },
                        "profile_form_instance_id": {
                          "type": "number"
                        }
                      },
                      "required": [
                        "id",
                        "name",
                        "alias",
                        "description",
                        "is_active",
                        "system_required",
                        "creation_form_instance_id",
                        "profile_form_instance_id"
                      ],
                      "additionalProperties": false
                    },
                    "items": {
                      "type": [
                        "array",
                        "null"
                      ],
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "number"
                          },
                          "name": {
                            "type": "string"
                          },
                          "position": {
                            "type": "number"
                          },
                          "alias": {
                            "type": "string"
                          },
                          "has_unique_data": {
                            "type": "boolean",
                            "description": "whether field requires values to be unique across system"
                          },
                          "has_value": {
                            "type": "boolean",
                            "description": "whether field has at least one value submitted"
                          },
                          "removable": {
                            "type": "boolean",
                            "description": "whether field can be removed from system"
                          },
                          "is_active": {
                            "type": "boolean"
                          },
                          "list": {
                            "type": "boolean",
                            "description": "whether field can handle collection of values"
                          },
                          "read_only": {
                            "type": "boolean",
                            "description": "whether field value can be changed"
                          },
                          "required": {
                            "type": "boolean",
                            "description": "deprecated setting"
                          },
                          "user_required": {
                            "type": "boolean",
                            "description": "whether field value required by user"
                          },
                          "system_required": {
                            "type": "boolean",
                            "description": "whether field value required by system"
                          },
                          "type": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "number"
                              },
                              "name": {
                                "type": "string"
                              },
                              "alias": {
                                "type": "string"
                              },
                              "settings": {
                                "type": "array",
                                "items": {
                                  "type": "object",
                                  "properties": {
                                    "id": {
                                      "type": "number"
                                    },
                                    "name": {
                                      "type": "string"
                                    },
                                    "alias": {
                                      "type": "string"
                                    },
                                    "is_required": {
                                      "type": "boolean"
                                    }
                                  },
                                  "required": [
                                    "id",
                                    "name",
                                    "alias",
                                    "is_required"
                                  ]
                                }
                              },
                              "supports_collection": {
                                "type": "boolean"
                              },
                              "supports_read_only": {
                                "type": "boolean"
                              },
                              "supports_unique": {
                                "type": "boolean"
                              }
                            },
                            "required": [
                              "id",
                              "name",
                              "alias",
                              "settings",
                              "supports_collection",
                              "supports_read_only",
                              "supports_unique"
                            ],
                            "additionalProperties": false
                          },
                          "category": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "number"
                              },
                              "alias": {
                                "type": "string"
                              },
                              "position": {
                                "type": "number"
                              },
                              "system_required": {
                                "type": "boolean"
                              },
                              "name": {
                                "type": "string"
                              },
                              "description": {
                                "type": "string"
                              },
                              "is_active": {
                                "type": "boolean"
                              },
                              "pso_type": {
                                "type": "object",
                                "properties": {
                                  "id": {
                                    "type": "number"
                                  },
                                  "name": {
                                    "type": "string"
                                  },
                                  "alias": {
                                    "type": "string"
                                  },
                                  "description": {
                                    "type": "string"
                                  },
                                  "is_active": {
                                    "type": "boolean"
                                  },
                                  "system_required": {
                                    "type": "boolean"
                                  },
                                  "creation_form_instance_id": {
                                    "type": "number"
                                  },
                                  "profile_form_instance_id": {
                                    "type": "number"
                                  }
                                },
                                "required": [
                                  "id",
                                  "name",
                                  "alias",
                                  "description",
                                  "is_active",
                                  "system_required",
                                  "creation_form_instance_id",
                                  "profile_form_instance_id"
                                ],
                                "additionalProperties": false,
                                "description": "Presented only if `include` was send"
                              }
                            },
                            "required": [
                              "id",
                              "alias",
                              "position",
                              "system_required",
                              "name",
                              "description",
                              "is_active"
                            ],
                            "additionalProperties": false
                          },
                          "domains": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "id": {
                                  "type": "number"
                                },
                                "alias": {
                                  "type": "string"
                                },
                                "name": {
                                  "type": "string"
                                },
                                "description": {
                                  "type": "string"
                                },
                                "is_editable": {
                                  "type": "boolean"
                                },
                                "is_removable": {
                                  "type": "boolean"
                                },
                                "is_active": {
                                  "type": "boolean"
                                },
                                "pso_type": {
                                  "type": "object",
                                  "properties": {
                                    "id": {
                                      "type": "number"
                                    },
                                    "name": {
                                      "type": "string"
                                    },
                                    "alias": {
                                      "type": "string"
                                    },
                                    "description": {
                                      "type": "string"
                                    },
                                    "is_active": {
                                      "type": "boolean"
                                    },
                                    "system_required": {
                                      "type": "boolean"
                                    },
                                    "creation_form_instance_id": {
                                      "type": "number"
                                    },
                                    "profile_form_instance_id": {
                                      "type": "number"
                                    }
                                  },
                                  "required": [
                                    "id",
                                    "name",
                                    "alias",
                                    "description",
                                    "is_active",
                                    "system_required",
                                    "creation_form_instance_id",
                                    "profile_form_instance_id"
                                  ],
                                  "additionalProperties": false
                                }
                              },
                              "required": [
                                "id",
                                "alias",
                                "name",
                                "description",
                                "is_editable",
                                "is_removable",
                                "is_active"
                              ]
                            }
                          },
                          "privacy_level": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "number"
                              },
                              "alias": {
                                "type": "string"
                              },
                              "name": {
                                "type": "string"
                              },
                              "level": {
                                "type": "number"
                              }
                            },
                            "required": [
                              "id",
                              "alias",
                              "name",
                              "level"
                            ],
                            "additionalProperties": false
                          },
                          "pso_type": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "number"
                              },
                              "name": {
                                "type": "string"
                              },
                              "alias": {
                                "type": "string"
                              },
                              "description": {
                                "type": "string"
                              },
                              "is_active": {
                                "type": "boolean"
                              },
                              "system_required": {
                                "type": "boolean"
                              },
                              "creation_form_instance_id": {
                                "type": "number"
                              },
                              "profile_form_instance_id": {
                                "type": "number"
                              }
                            },
                            "required": [
                              "id",
                              "name",
                              "alias",
                              "description",
                              "is_active",
                              "system_required",
                              "creation_form_instance_id",
                              "profile_form_instance_id"
                            ],
                            "additionalProperties": false
                          },
                          "items": {
                            "type": [
                              "array",
                              "null"
                            ],
                            "items": {
                              "type": "object",
                              "properties": {}
                            }
                          },
                          "options": {
                            "type": [
                              "array",
                              "null"
                            ],
                            "items": {
                              "type": "object",
                              "properties": {
                                "id": {
                                  "type": "number"
                                },
                                "name": {
                                  "type": "string"
                                },
                                "position": {
                                  "type": "number"
                                },
                                "value": {
                                  "type": "string"
                                },
                                "is_active": {
                                  "type": "boolean"
                                },
                                "is_selectable": {
                                  "type": "boolean",
                                  "description": "Can select on front this option (Using only in Hierarchy field))"
                                }
                              },
                              "required": [
                                "id",
                                "name",
                                "position",
                                "value",
                                "is_active",
                                "is_selectable"
                              ]
                            },
                            "description": "List of options with possible (allowed) values."
                          },
                          "settings": {
                            "type": "array",
                            "items": {
                              "type": "string"
                            },
                            "description": "Common field settings"
                          },
                          "validation": {
                            "type": "object",
                            "properties": {
                              "type": {
                                "type": "string"
                              },
                              "attributes": {
                                "type": "object",
                                "properties": {}
                              },
                              "value_example": {
                                "type": "string"
                              },
                              "error_message": {
                                "type": "object",
                                "properties": {
                                  "en": {
                                    "type": "string"
                                  },
                                  "fr": {
                                    "type": "string"
                                  },
                                  "de": {
                                    "type": "string"
                                  },
                                  "es": {
                                    "type": "string"
                                  }
                                },
                                "required": [
                                  "en",
                                  "fr",
                                  "de",
                                  "es"
                                ]
                              }
                            },
                            "required": [
                              "type",
                              "value_example",
                              "error_message"
                            ]
                          },
                          "has_autocomplete_settings": {
                            "type": "boolean"
                          },
                          "autocomplete_settings": {
                            "type": "object",
                            "properties": {
                              "allow_extra_values": {
                                "type": "boolean"
                              },
                              "autofill": {
                                "type": "boolean"
                              },
                              "provider": {
                                "type": "object",
                                "properties": {
                                  "name": {
                                    "type": "object",
                                    "properties": {
                                      "en": {
                                        "type": "string"
                                      },
                                      "fr": {
                                        "type": "string"
                                      },
                                      "de": {
                                        "type": "string"
                                      },
                                      "es": {
                                        "type": "string"
                                      }
                                    },
                                    "required": [
                                      "en",
                                      "fr",
                                      "de",
                                      "es"
                                    ]
                                  },
                                  "alias": {
                                    "type": "string"
                                  },
                                  "base_url": {
                                    "type": "string"
                                  },
                                  "single_value_supported": {
                                    "type": "boolean"
                                  },
                                  "parameters": {
                                    "type": "array"
                                  }
                                },
                                "required": [
                                  "name",
                                  "alias",
                                  "base_url",
                                  "single_value_supported",
                                  "parameters"
                                ]
                              },
                              "parameters": {
                                "type": "array"
                              }
                            },
                            "required": [
                              "allow_extra_values",
                              "autofill",
                              "provider",
                              "parameters"
                            ]
                          }
                        },
                        "required": [
                          "id",
                          "name",
                          "position",
                          "alias",
                          "has_unique_data",
                          "has_value",
                          "removable",
                          "is_active",
                          "list",
                          "read_only",
                          "required",
                          "user_required",
                          "system_required",
                          "validation",
                          "has_autocomplete_settings",
                          "autocomplete_settings"
                        ]
                      }
                    },
                    "options": {
                      "type": [
                        "array",
                        "null"
                      ],
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "number"
                          },
                          "name": {
                            "type": "string"
                          },
                          "position": {
                            "type": "number"
                          },
                          "value": {
                            "type": "string"
                          },
                          "is_active": {
                            "type": "boolean"
                          },
                          "is_selectable": {
                            "type": "boolean",
                            "description": "Can select on front this option (Using only in Hierarchy field))"
                          }
                        },
                        "required": [
                          "id",
                          "name",
                          "position",
                          "value",
                          "is_active",
                          "is_selectable"
                        ]
                      },
                      "description": "List of options with possible (allowed) values."
                    },
                    "settings": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      },
                      "description": "Common field settings"
                    },
                    "is_locked": {
                      "type": "boolean"
                    },
                    "value_details": {
                      "type": "array"
                    },
                    "values_count": {
                      "type": "number"
                    },
                    "assignment_settings": {
                      "type": "array"
                    },
                    "access_permissions": {
                      "type": "object",
                      "properties": {
                        "history": {
                          "type": "boolean"
                        },
                        "view": {
                          "type": "boolean"
                        },
                        "edit": {
                          "type": "boolean"
                        }
                      },
                      "required": [
                        "history",
                        "view",
                        "edit"
                      ]
                    },
                    "assignment_permissions": {
                      "type": "object",
                      "properties": {
                        "permissions": {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "number"
                            },
                            "name": {
                              "type": "string"
                            },
                            "alias": {
                              "type": "string"
                            }
                          },
                          "required": [
                            "id",
                            "name",
                            "alias"
                          ]
                        },
                        "access_list": {
                          "type": "array",
                          "description": "user, manager, hr"
                        }
                      },
                      "required": [
                        "permissions",
                        "access_list"
                      ]
                    }
                  },
                  "required": [
                    "id",
                    "name",
                    "position",
                    "alias",
                    "has_unique_data",
                    "has_value",
                    "removable",
                    "is_active",
                    "list",
                    "read_only",
                    "required",
                    "is_locked",
                    "value_details",
                    "values_count",
                    "assignment_settings",
                    "access_permissions",
                    "assignment_permissions"
                  ]
                }
              },
              "required": [
                "id"
              ]
            }
          },
          "required": [
            "summary",
            "pso"
          ]
        },
        "title": {
          "type": "string"
        },
        "details": {
          "type": "string"
        },
        "read_at": {
          "type": "string"
        },
        "effective_date": {
          "type": "string"
        },
        "expires_at": {
          "type": "string"
        },
        "created_at": {
          "type": "string"
        },
        "updated_at": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "author",
        "title",
        "details",
        "read_at",
        "effective_date",
        "expires_at",
        "created_at",
        "updated_at"
      ]
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Common List
GET/notifications{?user_id,expires-after,effective-date,actual,not-read,page,per-page,no-pagination}

Get list of notifications matches specified filters

Example URI

GET https://rest.monportailrh.com/notifications?user_id=1&expires-after=2020-01-01 30:30:30&effective-date=2020-01-01 30:30:30&actual=true&not-read=true&page=1&per-page=10&no-pagination=false
URI Parameters
HideShow
user_id
number (required) Example: 1

id of user for filtering

expires-after
date-time (optional) Example: 2020-01-01 30:30:30

format YYYY-MM-DD HH:II:SS

effective-date
date-time (optional) Example: 2020-01-01 30:30:30

format YYYY-MM-DD HH:II:SS

actual
bool (required) Example: true

get only not expired notifications

not-read
bool (required) Example: true

get only not read notifications

page
number (required) Example: 1

Page number. 1 by default

per-page
number (required) Example: 10

Number of items per page, 25 by default

no-pagination
boolean (required) Example: false

if presented and positive pagination will not be applied. All available items will be returned.

Note: it may have significant impact on the performance

Note: once this option positive and presented - meta attribute with pagination data will be omit in response

Request
HideShow
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": 1,
      "author": {
        "summary": {
          "first_name": {
            "id": 1,
            "alias": "usr_first_name",
            "value": "John"
          },
          "last_name": {
            "id": 1,
            "alias": "usr_first_name",
            "value": "John"
          },
          "image": {
            "id": 1,
            "alias": "usr_first_name",
            "value": "John"
          },
          "is_active": {
            "id": 1,
            "alias": "usr_first_name",
            "value": "John"
          },
          "email": {
            "id": 1,
            "alias": "usr_first_name",
            "value": "John"
          },
          "phone_number": ""
        },
        "pso": {
          "id": 1,
          "profile_form": {
            "id": 1,
            "name": "Profile Form",
            "description": "Profile Form Description",
            "is_active": true,
            "active_field": "null"
          },
          "pso_type": {
            "id": 56,
            "name": "User",
            "alias": "usr",
            "description": "...",
            "is_active": true,
            "system_required": true,
            "creation_form_instance_id": 1,
            "profile_form_instance_id": 1
          },
          "categories": [
            {
              "id": 1,
              "name": "Category Name",
              "alias": "category_alias"
            }
          ],
          "fields": {
            "id": 1,
            "name": "Field Name",
            "position": 5,
            "alias": "usr_first_name",
            "has_unique_data": false,
            "has_value": true,
            "removable": false,
            "is_active": true,
            "list": false,
            "read_only": false,
            "required": true,
            "type": {
              "id": 1,
              "name": "Data Type Name",
              "alias": "data_type_alias",
              "settings": [
                {
                  "id": 1,
                  "name": "Data Type Setting Name",
                  "alias": "data_type_setting_alias",
                  "is_required": true
                }
              ],
              "supports_collection": false,
              "supports_read_only": false,
              "supports_unique": false
            },
            "category": {
              "id": 32,
              "alias": "usr_identity",
              "position": 5,
              "system_required": true,
              "name": "Identity",
              "description": "...",
              "is_active": true,
              "pso_type": {
                "id": 56,
                "name": "User",
                "alias": "usr",
                "description": "...",
                "is_active": true,
                "system_required": true,
                "creation_form_instance_id": 1,
                "profile_form_instance_id": 1
              }
            },
            "domains": [
              {
                "id": 46,
                "alias": "usr_global",
                "name": "User Global",
                "description": "...",
                "is_editable": false,
                "is_removable": false,
                "is_active": true,
                "pso_type": {
                  "id": 56,
                  "name": "User",
                  "alias": "usr",
                  "description": "...",
                  "is_active": true,
                  "system_required": true,
                  "creation_form_instance_id": 1,
                  "profile_form_instance_id": 1
                }
              }
            ],
            "privacy_level": {
              "id": 123,
              "alias": "public",
              "name": "Not Sensitive",
              "level": 100
            },
            "pso_type": {
              "id": 56,
              "name": "User",
              "alias": "usr",
              "description": "...",
              "is_active": true,
              "system_required": true,
              "creation_form_instance_id": 1,
              "profile_form_instance_id": 1
            },
            "items": [
              {
                "id": 1,
                "name": "Field Name",
                "position": 5,
                "alias": "usr_first_name",
                "has_unique_data": false,
                "has_value": true,
                "removable": false,
                "is_active": true,
                "list": false,
                "read_only": false,
                "required": true,
                "user_required": true,
                "system_required": true,
                "type": {
                  "id": 1,
                  "name": "Data Type Name",
                  "alias": "data_type_alias",
                  "settings": [
                    {
                      "id": 1,
                      "name": "Data Type Setting Name",
                      "alias": "data_type_setting_alias",
                      "is_required": true
                    }
                  ],
                  "supports_collection": false,
                  "supports_read_only": false,
                  "supports_unique": false
                },
                "category": {
                  "id": 32,
                  "alias": "usr_identity",
                  "position": 5,
                  "system_required": true,
                  "name": "Identity",
                  "description": "...",
                  "is_active": true,
                  "pso_type": {
                    "id": 56,
                    "name": "User",
                    "alias": "usr",
                    "description": "...",
                    "is_active": true,
                    "system_required": true,
                    "creation_form_instance_id": 1,
                    "profile_form_instance_id": 1
                  }
                },
                "domains": [
                  {
                    "id": 46,
                    "alias": "usr_global",
                    "name": "User Global",
                    "description": "...",
                    "is_editable": false,
                    "is_removable": false,
                    "is_active": true,
                    "pso_type": {
                      "id": 56,
                      "name": "User",
                      "alias": "usr",
                      "description": "...",
                      "is_active": true,
                      "system_required": true,
                      "creation_form_instance_id": 1,
                      "profile_form_instance_id": 1
                    }
                  }
                ],
                "privacy_level": {
                  "id": 123,
                  "alias": "public",
                  "name": "Not Sensitive",
                  "level": 100
                },
                "pso_type": {
                  "id": 56,
                  "name": "User",
                  "alias": "usr",
                  "description": "...",
                  "is_active": true,
                  "system_required": true,
                  "creation_form_instance_id": 1,
                  "profile_form_instance_id": 1
                },
                "items": [
                  {}
                ],
                "options": [
                  {
                    "id": 198,
                    "name": "Choose me!",
                    "position": 9,
                    "value": "198",
                    "is_active": true,
                    "is_selectable": true
                  }
                ],
                "settings": [],
                "validation": {
                  "type": "regexp",
                  "attributes": {},
                  "value_example": "string",
                  "error_message": {
                    "en": "Some text",
                    "fr": "Du texte",
                    "de": "Setwas Text",
                    "es": "Algún texto"
                  }
                },
                "has_autocomplete_settings": true,
                "autocomplete_settings": {
                  "allow_extra_values": true,
                  "autofill": true,
                  "provider": {
                    "name": {
                      "en": "Some text",
                      "fr": "Du texte",
                      "de": "Setwas Text",
                      "es": "Algún texto"
                    },
                    "alias": "string",
                    "base_url": "https://exmaple.com/",
                    "single_value_supported": true,
                    "parameters": [
                      {
                        "name": "Name",
                        "key": "alias",
                        "required": true
                      }
                    ]
                  },
                  "parameters": [
                    {
                      "name": "Name",
                      "key": "alias",
                      "required": true,
                      "value": "value",
                      "field": {
                        "id": 1,
                        "name": "Field Name",
                        "alias": "usr_first_name",
                        "value": "RU",
                        "root_field": {
                          "id": 1,
                          "name": "Field Name",
                          "alias": "usr_first_name",
                          "value": "RU",
                          "root_field": "null"
                        }
                      }
                    }
                  ]
                }
              }
            ],
            "options": [
              {
                "id": 198,
                "name": "Choose me!",
                "position": 9,
                "value": "198",
                "is_active": true,
                "is_selectable": true
              }
            ],
            "settings": [],
            "is_locked": false,
            "value_details": [
              "value1",
              "value2"
            ],
            "values_count": 2,
            "assignment_settings": [
              {
                "setting": "public",
                "value": "1"
              }
            ],
            "access_permissions": {
              "history": true,
              "view": true,
              "edit": true
            },
            "assignment_permissions": {
              "permissions": {
                "id": 1,
                "name": "View",
                "alias": "view"
              },
              "access_list": [
                "0",
                "1",
                "1"
              ]
            }
          }
        }
      },
      "title": "Notification Title",
      "details": "Notification Details",
      "read_at": "2019-01-01 23:34:40",
      "effective_date": "2019-01-01 23:34:40",
      "expires_at": "2019-01-01 23:34:40",
      "created_at": "2019-01-01 23:34:40",
      "updated_at": "2019-01-01 23:34:40"
    }
  ],
  "meta": {
    "pagination": {
      "total": 238,
      "count": 25,
      "per_page": 25,
      "current_page": 2,
      "total_pages": 10,
      "links": {
        "previous": "http://example.com/api/<endpoint>?page=1",
        "next": "http://example.com/api/<endpoint>?page=3"
      }
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number"
          },
          "author": {
            "type": "object",
            "properties": {
              "summary": {
                "type": "object",
                "properties": {
                  "first_name": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "number"
                      },
                      "alias": {
                        "type": "string"
                      },
                      "value": {
                        "type": "string",
                        "description": "if field support multiple values it can be array"
                      }
                    },
                    "required": [
                      "id",
                      "alias",
                      "value"
                    ]
                  },
                  "last_name": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "number"
                      },
                      "alias": {
                        "type": "string"
                      },
                      "value": {
                        "type": "string",
                        "description": "if field support multiple values it can be array"
                      }
                    },
                    "required": [
                      "id",
                      "alias",
                      "value"
                    ]
                  },
                  "image": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "number"
                      },
                      "alias": {
                        "type": "string"
                      },
                      "value": {
                        "type": "string",
                        "description": "if field support multiple values it can be array"
                      }
                    },
                    "required": [
                      "id",
                      "alias",
                      "value"
                    ]
                  },
                  "is_active": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "number"
                      },
                      "alias": {
                        "type": "string"
                      },
                      "value": {
                        "type": "string",
                        "description": "if field support multiple values it can be array"
                      }
                    },
                    "required": [
                      "id",
                      "alias",
                      "value"
                    ]
                  },
                  "email": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "number"
                      },
                      "alias": {
                        "type": "string"
                      },
                      "value": {
                        "type": "string",
                        "description": "if field support multiple values it can be array"
                      }
                    },
                    "required": [
                      "id",
                      "alias",
                      "value"
                    ]
                  },
                  "phone_number": {
                    "type": "string"
                  }
                },
                "required": [
                  "first_name",
                  "last_name",
                  "image",
                  "is_active",
                  "email",
                  "phone_number"
                ]
              },
              "pso": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "number"
                  },
                  "profile_form": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "number"
                      },
                      "name": {
                        "type": "string"
                      },
                      "description": {
                        "type": "string"
                      },
                      "is_active": {
                        "type": "boolean"
                      },
                      "active_field": {
                        "type": [
                          "string",
                          "null"
                        ]
                      }
                    },
                    "required": [
                      "id",
                      "name",
                      "description",
                      "is_active"
                    ]
                  },
                  "pso_type": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "number"
                      },
                      "name": {
                        "type": "string"
                      },
                      "alias": {
                        "type": "string"
                      },
                      "description": {
                        "type": "string"
                      },
                      "is_active": {
                        "type": "boolean"
                      },
                      "system_required": {
                        "type": "boolean"
                      },
                      "creation_form_instance_id": {
                        "type": "number"
                      },
                      "profile_form_instance_id": {
                        "type": "number"
                      }
                    },
                    "required": [
                      "id",
                      "name",
                      "alias",
                      "description",
                      "is_active",
                      "system_required",
                      "creation_form_instance_id",
                      "profile_form_instance_id"
                    ]
                  },
                  "categories": {
                    "type": "array"
                  },
                  "fields": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "number"
                      },
                      "name": {
                        "type": "string"
                      },
                      "position": {
                        "type": "number"
                      },
                      "alias": {
                        "type": "string"
                      },
                      "has_unique_data": {
                        "type": "boolean",
                        "description": "whether field requires values to be unique across system"
                      },
                      "has_value": {
                        "type": "boolean",
                        "description": "whether field has at least one value submitted"
                      },
                      "removable": {
                        "type": "boolean",
                        "description": "whether field can be removed from system"
                      },
                      "is_active": {
                        "type": "boolean"
                      },
                      "list": {
                        "type": "boolean",
                        "description": "whether field can handle collection of values"
                      },
                      "read_only": {
                        "type": "boolean",
                        "description": "whether field value can be changed"
                      },
                      "required": {
                        "type": "boolean",
                        "description": "whether field value required by system"
                      },
                      "type": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "number"
                          },
                          "name": {
                            "type": "string"
                          },
                          "alias": {
                            "type": "string"
                          },
                          "settings": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "id": {
                                  "type": "number"
                                },
                                "name": {
                                  "type": "string"
                                },
                                "alias": {
                                  "type": "string"
                                },
                                "is_required": {
                                  "type": "boolean"
                                }
                              },
                              "required": [
                                "id",
                                "name",
                                "alias",
                                "is_required"
                              ]
                            }
                          },
                          "supports_collection": {
                            "type": "boolean"
                          },
                          "supports_read_only": {
                            "type": "boolean"
                          },
                          "supports_unique": {
                            "type": "boolean"
                          }
                        },
                        "required": [
                          "id",
                          "name",
                          "alias",
                          "settings",
                          "supports_collection",
                          "supports_read_only",
                          "supports_unique"
                        ],
                        "additionalProperties": false
                      },
                      "category": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "number"
                          },
                          "alias": {
                            "type": "string"
                          },
                          "position": {
                            "type": "number"
                          },
                          "system_required": {
                            "type": "boolean"
                          },
                          "name": {
                            "type": "string"
                          },
                          "description": {
                            "type": "string"
                          },
                          "is_active": {
                            "type": "boolean"
                          },
                          "pso_type": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "number"
                              },
                              "name": {
                                "type": "string"
                              },
                              "alias": {
                                "type": "string"
                              },
                              "description": {
                                "type": "string"
                              },
                              "is_active": {
                                "type": "boolean"
                              },
                              "system_required": {
                                "type": "boolean"
                              },
                              "creation_form_instance_id": {
                                "type": "number"
                              },
                              "profile_form_instance_id": {
                                "type": "number"
                              }
                            },
                            "required": [
                              "id",
                              "name",
                              "alias",
                              "description",
                              "is_active",
                              "system_required",
                              "creation_form_instance_id",
                              "profile_form_instance_id"
                            ],
                            "additionalProperties": false,
                            "description": "Presented only if `include` was send"
                          }
                        },
                        "required": [
                          "id",
                          "alias",
                          "position",
                          "system_required",
                          "name",
                          "description",
                          "is_active"
                        ],
                        "additionalProperties": false
                      },
                      "domains": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "number"
                            },
                            "alias": {
                              "type": "string"
                            },
                            "name": {
                              "type": "string"
                            },
                            "description": {
                              "type": "string"
                            },
                            "is_editable": {
                              "type": "boolean"
                            },
                            "is_removable": {
                              "type": "boolean"
                            },
                            "is_active": {
                              "type": "boolean"
                            },
                            "pso_type": {
                              "type": "object",
                              "properties": {
                                "id": {
                                  "type": "number"
                                },
                                "name": {
                                  "type": "string"
                                },
                                "alias": {
                                  "type": "string"
                                },
                                "description": {
                                  "type": "string"
                                },
                                "is_active": {
                                  "type": "boolean"
                                },
                                "system_required": {
                                  "type": "boolean"
                                },
                                "creation_form_instance_id": {
                                  "type": "number"
                                },
                                "profile_form_instance_id": {
                                  "type": "number"
                                }
                              },
                              "required": [
                                "id",
                                "name",
                                "alias",
                                "description",
                                "is_active",
                                "system_required",
                                "creation_form_instance_id",
                                "profile_form_instance_id"
                              ],
                              "additionalProperties": false
                            }
                          },
                          "required": [
                            "id",
                            "alias",
                            "name",
                            "description",
                            "is_editable",
                            "is_removable",
                            "is_active"
                          ]
                        }
                      },
                      "privacy_level": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "number"
                          },
                          "alias": {
                            "type": "string"
                          },
                          "name": {
                            "type": "string"
                          },
                          "level": {
                            "type": "number"
                          }
                        },
                        "required": [
                          "id",
                          "alias",
                          "name",
                          "level"
                        ],
                        "additionalProperties": false
                      },
                      "pso_type": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "number"
                          },
                          "name": {
                            "type": "string"
                          },
                          "alias": {
                            "type": "string"
                          },
                          "description": {
                            "type": "string"
                          },
                          "is_active": {
                            "type": "boolean"
                          },
                          "system_required": {
                            "type": "boolean"
                          },
                          "creation_form_instance_id": {
                            "type": "number"
                          },
                          "profile_form_instance_id": {
                            "type": "number"
                          }
                        },
                        "required": [
                          "id",
                          "name",
                          "alias",
                          "description",
                          "is_active",
                          "system_required",
                          "creation_form_instance_id",
                          "profile_form_instance_id"
                        ],
                        "additionalProperties": false
                      },
                      "items": {
                        "type": [
                          "array",
                          "null"
                        ],
                        "items": {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "number"
                            },
                            "name": {
                              "type": "string"
                            },
                            "position": {
                              "type": "number"
                            },
                            "alias": {
                              "type": "string"
                            },
                            "has_unique_data": {
                              "type": "boolean",
                              "description": "whether field requires values to be unique across system"
                            },
                            "has_value": {
                              "type": "boolean",
                              "description": "whether field has at least one value submitted"
                            },
                            "removable": {
                              "type": "boolean",
                              "description": "whether field can be removed from system"
                            },
                            "is_active": {
                              "type": "boolean"
                            },
                            "list": {
                              "type": "boolean",
                              "description": "whether field can handle collection of values"
                            },
                            "read_only": {
                              "type": "boolean",
                              "description": "whether field value can be changed"
                            },
                            "required": {
                              "type": "boolean",
                              "description": "deprecated setting"
                            },
                            "user_required": {
                              "type": "boolean",
                              "description": "whether field value required by user"
                            },
                            "system_required": {
                              "type": "boolean",
                              "description": "whether field value required by system"
                            },
                            "type": {
                              "type": "object",
                              "properties": {
                                "id": {
                                  "type": "number"
                                },
                                "name": {
                                  "type": "string"
                                },
                                "alias": {
                                  "type": "string"
                                },
                                "settings": {
                                  "type": "array",
                                  "items": {
                                    "type": "object",
                                    "properties": {
                                      "id": {
                                        "type": "number"
                                      },
                                      "name": {
                                        "type": "string"
                                      },
                                      "alias": {
                                        "type": "string"
                                      },
                                      "is_required": {
                                        "type": "boolean"
                                      }
                                    },
                                    "required": [
                                      "id",
                                      "name",
                                      "alias",
                                      "is_required"
                                    ]
                                  }
                                },
                                "supports_collection": {
                                  "type": "boolean"
                                },
                                "supports_read_only": {
                                  "type": "boolean"
                                },
                                "supports_unique": {
                                  "type": "boolean"
                                }
                              },
                              "required": [
                                "id",
                                "name",
                                "alias",
                                "settings",
                                "supports_collection",
                                "supports_read_only",
                                "supports_unique"
                              ],
                              "additionalProperties": false
                            },
                            "category": {
                              "type": "object",
                              "properties": {
                                "id": {
                                  "type": "number"
                                },
                                "alias": {
                                  "type": "string"
                                },
                                "position": {
                                  "type": "number"
                                },
                                "system_required": {
                                  "type": "boolean"
                                },
                                "name": {
                                  "type": "string"
                                },
                                "description": {
                                  "type": "string"
                                },
                                "is_active": {
                                  "type": "boolean"
                                },
                                "pso_type": {
                                  "type": "object",
                                  "properties": {
                                    "id": {
                                      "type": "number"
                                    },
                                    "name": {
                                      "type": "string"
                                    },
                                    "alias": {
                                      "type": "string"
                                    },
                                    "description": {
                                      "type": "string"
                                    },
                                    "is_active": {
                                      "type": "boolean"
                                    },
                                    "system_required": {
                                      "type": "boolean"
                                    },
                                    "creation_form_instance_id": {
                                      "type": "number"
                                    },
                                    "profile_form_instance_id": {
                                      "type": "number"
                                    }
                                  },
                                  "required": [
                                    "id",
                                    "name",
                                    "alias",
                                    "description",
                                    "is_active",
                                    "system_required",
                                    "creation_form_instance_id",
                                    "profile_form_instance_id"
                                  ],
                                  "additionalProperties": false,
                                  "description": "Presented only if `include` was send"
                                }
                              },
                              "required": [
                                "id",
                                "alias",
                                "position",
                                "system_required",
                                "name",
                                "description",
                                "is_active"
                              ],
                              "additionalProperties": false
                            },
                            "domains": {
                              "type": "array",
                              "items": {
                                "type": "object",
                                "properties": {
                                  "id": {
                                    "type": "number"
                                  },
                                  "alias": {
                                    "type": "string"
                                  },
                                  "name": {
                                    "type": "string"
                                  },
                                  "description": {
                                    "type": "string"
                                  },
                                  "is_editable": {
                                    "type": "boolean"
                                  },
                                  "is_removable": {
                                    "type": "boolean"
                                  },
                                  "is_active": {
                                    "type": "boolean"
                                  },
                                  "pso_type": {
                                    "type": "object",
                                    "properties": {
                                      "id": {
                                        "type": "number"
                                      },
                                      "name": {
                                        "type": "string"
                                      },
                                      "alias": {
                                        "type": "string"
                                      },
                                      "description": {
                                        "type": "string"
                                      },
                                      "is_active": {
                                        "type": "boolean"
                                      },
                                      "system_required": {
                                        "type": "boolean"
                                      },
                                      "creation_form_instance_id": {
                                        "type": "number"
                                      },
                                      "profile_form_instance_id": {
                                        "type": "number"
                                      }
                                    },
                                    "required": [
                                      "id",
                                      "name",
                                      "alias",
                                      "description",
                                      "is_active",
                                      "system_required",
                                      "creation_form_instance_id",
                                      "profile_form_instance_id"
                                    ],
                                    "additionalProperties": false
                                  }
                                },
                                "required": [
                                  "id",
                                  "alias",
                                  "name",
                                  "description",
                                  "is_editable",
                                  "is_removable",
                                  "is_active"
                                ]
                              }
                            },
                            "privacy_level": {
                              "type": "object",
                              "properties": {
                                "id": {
                                  "type": "number"
                                },
                                "alias": {
                                  "type": "string"
                                },
                                "name": {
                                  "type": "string"
                                },
                                "level": {
                                  "type": "number"
                                }
                              },
                              "required": [
                                "id",
                                "alias",
                                "name",
                                "level"
                              ],
                              "additionalProperties": false
                            },
                            "pso_type": {
                              "type": "object",
                              "properties": {
                                "id": {
                                  "type": "number"
                                },
                                "name": {
                                  "type": "string"
                                },
                                "alias": {
                                  "type": "string"
                                },
                                "description": {
                                  "type": "string"
                                },
                                "is_active": {
                                  "type": "boolean"
                                },
                                "system_required": {
                                  "type": "boolean"
                                },
                                "creation_form_instance_id": {
                                  "type": "number"
                                },
                                "profile_form_instance_id": {
                                  "type": "number"
                                }
                              },
                              "required": [
                                "id",
                                "name",
                                "alias",
                                "description",
                                "is_active",
                                "system_required",
                                "creation_form_instance_id",
                                "profile_form_instance_id"
                              ],
                              "additionalProperties": false
                            },
                            "items": {
                              "type": [
                                "array",
                                "null"
                              ],
                              "items": {
                                "type": "object",
                                "properties": {}
                              }
                            },
                            "options": {
                              "type": [
                                "array",
                                "null"
                              ],
                              "items": {
                                "type": "object",
                                "properties": {
                                  "id": {
                                    "type": "number"
                                  },
                                  "name": {
                                    "type": "string"
                                  },
                                  "position": {
                                    "type": "number"
                                  },
                                  "value": {
                                    "type": "string"
                                  },
                                  "is_active": {
                                    "type": "boolean"
                                  },
                                  "is_selectable": {
                                    "type": "boolean",
                                    "description": "Can select on front this option (Using only in Hierarchy field))"
                                  }
                                },
                                "required": [
                                  "id",
                                  "name",
                                  "position",
                                  "value",
                                  "is_active",
                                  "is_selectable"
                                ]
                              },
                              "description": "List of options with possible (allowed) values."
                            },
                            "settings": {
                              "type": "array",
                              "items": {
                                "type": "string"
                              },
                              "description": "Common field settings"
                            },
                            "validation": {
                              "type": "object",
                              "properties": {
                                "type": {
                                  "type": "string"
                                },
                                "attributes": {
                                  "type": "object",
                                  "properties": {}
                                },
                                "value_example": {
                                  "type": "string"
                                },
                                "error_message": {
                                  "type": "object",
                                  "properties": {
                                    "en": {
                                      "type": "string"
                                    },
                                    "fr": {
                                      "type": "string"
                                    },
                                    "de": {
                                      "type": "string"
                                    },
                                    "es": {
                                      "type": "string"
                                    }
                                  },
                                  "required": [
                                    "en",
                                    "fr",
                                    "de",
                                    "es"
                                  ]
                                }
                              },
                              "required": [
                                "type",
                                "value_example",
                                "error_message"
                              ]
                            },
                            "has_autocomplete_settings": {
                              "type": "boolean"
                            },
                            "autocomplete_settings": {
                              "type": "object",
                              "properties": {
                                "allow_extra_values": {
                                  "type": "boolean"
                                },
                                "autofill": {
                                  "type": "boolean"
                                },
                                "provider": {
                                  "type": "object",
                                  "properties": {
                                    "name": {
                                      "type": "object",
                                      "properties": {
                                        "en": {
                                          "type": "string"
                                        },
                                        "fr": {
                                          "type": "string"
                                        },
                                        "de": {
                                          "type": "string"
                                        },
                                        "es": {
                                          "type": "string"
                                        }
                                      },
                                      "required": [
                                        "en",
                                        "fr",
                                        "de",
                                        "es"
                                      ]
                                    },
                                    "alias": {
                                      "type": "string"
                                    },
                                    "base_url": {
                                      "type": "string"
                                    },
                                    "single_value_supported": {
                                      "type": "boolean"
                                    },
                                    "parameters": {
                                      "type": "array"
                                    }
                                  },
                                  "required": [
                                    "name",
                                    "alias",
                                    "base_url",
                                    "single_value_supported",
                                    "parameters"
                                  ]
                                },
                                "parameters": {
                                  "type": "array"
                                }
                              },
                              "required": [
                                "allow_extra_values",
                                "autofill",
                                "provider",
                                "parameters"
                              ]
                            }
                          },
                          "required": [
                            "id",
                            "name",
                            "position",
                            "alias",
                            "has_unique_data",
                            "has_value",
                            "removable",
                            "is_active",
                            "list",
                            "read_only",
                            "required",
                            "user_required",
                            "system_required",
                            "validation",
                            "has_autocomplete_settings",
                            "autocomplete_settings"
                          ]
                        }
                      },
                      "options": {
                        "type": [
                          "array",
                          "null"
                        ],
                        "items": {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "number"
                            },
                            "name": {
                              "type": "string"
                            },
                            "position": {
                              "type": "number"
                            },
                            "value": {
                              "type": "string"
                            },
                            "is_active": {
                              "type": "boolean"
                            },
                            "is_selectable": {
                              "type": "boolean",
                              "description": "Can select on front this option (Using only in Hierarchy field))"
                            }
                          },
                          "required": [
                            "id",
                            "name",
                            "position",
                            "value",
                            "is_active",
                            "is_selectable"
                          ]
                        },
                        "description": "List of options with possible (allowed) values."
                      },
                      "settings": {
                        "type": "array",
                        "items": {
                          "type": "string"
                        },
                        "description": "Common field settings"
                      },
                      "is_locked": {
                        "type": "boolean"
                      },
                      "value_details": {
                        "type": "array"
                      },
                      "values_count": {
                        "type": "number"
                      },
                      "assignment_settings": {
                        "type": "array"
                      },
                      "access_permissions": {
                        "type": "object",
                        "properties": {
                          "history": {
                            "type": "boolean"
                          },
                          "view": {
                            "type": "boolean"
                          },
                          "edit": {
                            "type": "boolean"
                          }
                        },
                        "required": [
                          "history",
                          "view",
                          "edit"
                        ]
                      },
                      "assignment_permissions": {
                        "type": "object",
                        "properties": {
                          "permissions": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "number"
                              },
                              "name": {
                                "type": "string"
                              },
                              "alias": {
                                "type": "string"
                              }
                            },
                            "required": [
                              "id",
                              "name",
                              "alias"
                            ]
                          },
                          "access_list": {
                            "type": "array",
                            "description": "user, manager, hr"
                          }
                        },
                        "required": [
                          "permissions",
                          "access_list"
                        ]
                      }
                    },
                    "required": [
                      "id",
                      "name",
                      "position",
                      "alias",
                      "has_unique_data",
                      "has_value",
                      "removable",
                      "is_active",
                      "list",
                      "read_only",
                      "required",
                      "is_locked",
                      "value_details",
                      "values_count",
                      "assignment_settings",
                      "access_permissions",
                      "assignment_permissions"
                    ]
                  }
                },
                "required": [
                  "id"
                ]
              }
            },
            "required": [
              "summary",
              "pso"
            ]
          },
          "title": {
            "type": "string"
          },
          "details": {
            "type": "string"
          },
          "read_at": {
            "type": "string"
          },
          "effective_date": {
            "type": "string"
          },
          "expires_at": {
            "type": "string"
          },
          "created_at": {
            "type": "string"
          },
          "updated_at": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "author",
          "title",
          "details",
          "read_at",
          "effective_date",
          "expires_at",
          "created_at",
          "updated_at"
        ]
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number"
            },
            "count": {
              "type": "number"
            },
            "per_page": {
              "type": "number"
            },
            "current_page": {
              "type": "number"
            },
            "total_pages": {
              "type": "number"
            },
            "links": {
              "type": "object",
              "properties": {
                "previous": {
                  "type": "string"
                },
                "next": {
                  "type": "string"
                }
              },
              "required": [
                "previous",
                "next"
              ]
            }
          },
          "required": [
            "total",
            "count",
            "per_page",
            "current_page",
            "total_pages",
            "links"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "pagination"
      ]
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Create
POST/notifications

Create notification

Example URI

POST https://rest.monportailrh.com/notifications
Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Body
{
  "user_id": 1,
  "relation": "user",
  "raw_recipient": "user@email.com",
  "title": {
    "en": "Some text",
    "fr": "Du texte",
    "de": "Setwas Text",
    "es": "Algún texto"
  },
  "details": {
    "en": "Some text",
    "fr": "Du texte",
    "de": "Setwas Text",
    "es": "Algún texto"
  },
  "effective_date": "2019-01-01 23:34:40",
  "expires_at": "2019-01-01 23:34:40",
  "substitutions": [
    "{@usr_first_name}",
    "{$usr_first_name}"
  ],
  "transport": "email"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "user_id": {
      "type": "number",
      "description": "required without raw_recipient"
    },
    "relation": {
      "type": "string",
      "enum": [
        "user",
        "manager",
        "hr",
        "owner",
        "admin"
      ]
    },
    "raw_recipient": {
      "type": "string",
      "description": "required without user_id"
    },
    "title": {
      "type": "object",
      "properties": {
        "en": {
          "type": "string"
        },
        "fr": {
          "type": "string"
        },
        "de": {
          "type": "string"
        },
        "es": {
          "type": "string"
        }
      },
      "required": [
        "en",
        "fr",
        "de",
        "es"
      ]
    },
    "details": {
      "type": "object",
      "properties": {
        "en": {
          "type": "string"
        },
        "fr": {
          "type": "string"
        },
        "de": {
          "type": "string"
        },
        "es": {
          "type": "string"
        }
      },
      "required": [
        "en",
        "fr",
        "de",
        "es"
      ]
    },
    "effective_date": {
      "type": "string"
    },
    "expires_at": {
      "type": "string"
    },
    "substitutions": {
      "type": "array"
    },
    "transport": {
      "type": "string",
      "enum": [
        "email",
        "http",
        "push"
      ]
    }
  },
  "required": [
    "title",
    "effective_date",
    "expires_at",
    "transport"
  ]
}
Response  201
HideShow
Headers
Content-Type: application/json
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 400
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete
DELETE/notifications/{notification}

Delete single notification

Example URI

DELETE https://rest.monportailrh.com/notifications/notification
URI Parameters
HideShow
notification
string (required) Example: notification

id of notification

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Response  204
HideShow
Headers
Content-Type: application/json
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 400
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/notifications/count{?user_id,actual,not-read}

Get notifications count

Example URI

GET https://rest.monportailrh.com/notifications/count?user_id=1&actual=true&not-read=true
URI Parameters
HideShow
user_id
number (required) Example: 1

id of user for filtering

actual
bool (required) Example: true

use only not expired notifications for count

not-read
bool (required) Example: true

use only not read notifications for count

Request
HideShow
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "count": 10
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "count": {
          "type": "number"
        }
      },
      "required": [
        "count"
      ]
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Mark as read
PATCH/notifications/mark-as-read

Mark all unread notifications as read.

Example URI

PATCH https://rest.monportailrh.com/notifications/mark-as-read
Request
HideShow
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>
Response  204
HideShow
Headers
Content-Type: application/json
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Operators

Condition Operators

List

List
GET/operators

Fetch list of available data- type specific operators

Example URI

GET https://rest.monportailrh.com/operators
Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "data_type": "number",
      "comparison_operators": [
        {
          "name": "Is equal to",
          "operator": "==",
          "type": "binary"
        }
      ],
      "arithmetic_operators": [
        {
          "name": "Is equal to",
          "operator": "==",
          "type": "binary"
        }
      ]
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "data_type": {
            "type": "string"
          },
          "comparison_operators": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string"
                },
                "operator": {
                  "type": "string"
                },
                "type": {
                  "type": "string",
                  "enum": [
                    "binary",
                    "unary"
                  ]
                }
              },
              "required": [
                "name",
                "operator"
              ]
            }
          },
          "arithmetic_operators": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string"
                },
                "operator": {
                  "type": "string"
                },
                "type": {
                  "type": "string",
                  "enum": [
                    "binary",
                    "unary"
                  ]
                }
              },
              "required": [
                "name",
                "operator"
              ]
            }
          }
        },
        "required": [
          "data_type"
        ]
      }
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Field item option list

Field item option list
GET/operators/field-items

Fetch list of available data-type specific operators for conditional field

Example URI

GET https://rest.monportailrh.com/operators/field-items
Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "data_type": "number",
      "condition_operators": [
        {
          "name": "Is equal to",
          "operator": "==",
          "type": "binary"
        }
      ],
      "action_operators": [
        {
          "name": "Is equal to",
          "operator": "==",
          "type": "binary"
        }
      ]
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "data_type": {
            "type": "string"
          },
          "condition_operators": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string"
                },
                "operator": {
                  "type": "string"
                },
                "type": {
                  "type": "string",
                  "enum": [
                    "binary",
                    "unary"
                  ]
                }
              },
              "required": [
                "name",
                "operator"
              ]
            }
          },
          "action_operators": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string"
                },
                "operator": {
                  "type": "string"
                },
                "type": {
                  "type": "string",
                  "enum": [
                    "binary",
                    "unary"
                  ]
                }
              },
              "required": [
                "name",
                "operator"
              ]
            }
          }
        },
        "required": [
          "data_type"
        ]
      }
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Organizational chart

Chart

Chart
GET/organizational-hierarchy{?pso-type,relation,group-by,start-pso,fields}

Get organization structure

Permissions: org_chart.view

Example URI

GET https://rest.monportailrh.com/organizational-hierarchy?pso-type=usr&relation=owner&group-by=relation&start-pso=123&fields=field_alias,other_field_alias
URI Parameters
HideShow
pso-type
string (required) Example: usr

Alias of pso type

relation
string (optional) Default: manager Example: owner

Relation between pso

group-by
string (optional) Example: relation

Choices: relation pso

start-pso
number (optional) Example: 123

pso id to start building of chart

fields
array[string] (optional) Example: field_alias,other_field_alias

List of field aliases for display on card

Request
HideShow
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "pso_id": 1,
      "parent_id": 2,
      "data": [
        {
          "field_alias": "some_alias",
          "value": "2020-10-20",
          "data_type": "date",
          "field_name": "Some name"
        }
      ],
      "type": "real",
      "children": 3
    }
  ],
  "meta": {
    "pagination": {
      "total": 238,
      "count": 25,
      "per_page": 25,
      "current_page": 2,
      "total_pages": 10,
      "links": {
        "previous": "http://example.com/api/<endpoint>?page=1",
        "next": "http://example.com/api/<endpoint>?page=3"
      }
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "pso_id": {
            "type": "number"
          },
          "parent_id": {
            "type": "number"
          },
          "data": {
            "type": "array"
          },
          "type": {
            "type": "string",
            "enum": [
              "real",
              "virtual"
            ]
          },
          "children": {
            "type": "number"
          }
        },
        "required": [
          "pso_id",
          "parent_id",
          "data",
          "type",
          "children"
        ]
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number"
            },
            "count": {
              "type": "number"
            },
            "per_page": {
              "type": "number"
            },
            "current_page": {
              "type": "number"
            },
            "total_pages": {
              "type": "number"
            },
            "links": {
              "type": "object",
              "properties": {
                "previous": {
                  "type": "string"
                },
                "next": {
                  "type": "string"
                }
              },
              "required": [
                "previous",
                "next"
              ]
            }
          },
          "required": [
            "total",
            "count",
            "per_page",
            "current_page",
            "total_pages",
            "links"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "pagination"
      ]
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Polls

Access permissions:

  • poll_dashboard.view - ability to view polls

Polls

Show
GET/polls/{poll}/results

Fetch results for specified poll

Example URI

GET https://rest.monportailrh.com/polls/1/results
URI Parameters
HideShow
poll
number (required) Example: 1

id of the poll

Request
HideShow
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 1,
    "name": "Poll Name",
    "starts_at": "2019-01-24 15:34:58",
    "questions": {
      "name": "question name",
      "data_type": "data_type_alias",
      "answers": {
        "value": "value",
        "count": 1
      }
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        },
        "starts_at": {
          "type": "string"
        },
        "questions": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string"
            },
            "data_type": {
              "type": "string"
            },
            "answers": {
              "type": "object",
              "properties": {
                "value": {
                  "type": "string"
                },
                "count": {
                  "type": "number"
                }
              },
              "required": [
                "value",
                "count"
              ]
            }
          },
          "required": [
            "name",
            "data_type",
            "answers"
          ]
        }
      },
      "required": [
        "id",
        "name",
        "starts_at",
        "questions"
      ]
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Pso

Access permissions:

  • global_search.view.* - ability to view any pso and profile fields

  • global_search.view.{pso_type_alias} - ability to view pso and profile fields form specific pso type

Pso

Show
GET/psos/{pso}

Get details of pso

Example URI

GET https://rest.monportailrh.com/psos/1
URI Parameters
HideShow
pso
number (required) Example: 1

id of the pso

Request
HideShow
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "summary": {
      "first_name": {
        "id": 1,
        "alias": "usr_first_name",
        "value": "John"
      },
      "last_name": {
        "id": 1,
        "alias": "usr_first_name",
        "value": "John"
      },
      "image": {
        "id": 1,
        "alias": "usr_first_name",
        "value": "John"
      },
      "is_active": {
        "id": 1,
        "alias": "usr_first_name",
        "value": "John"
      },
      "email": {
        "id": 1,
        "alias": "usr_first_name",
        "value": "John"
      },
      "phone_number": ""
    },
    "pso": {
      "id": 1,
      "profile_form": {
        "id": 1,
        "name": "Profile Form",
        "description": "Profile Form Description",
        "is_active": true,
        "active_field": "null"
      },
      "pso_type": {
        "id": 56,
        "name": "User",
        "alias": "usr",
        "description": "...",
        "is_active": true,
        "system_required": true,
        "creation_form_instance_id": 1,
        "profile_form_instance_id": 1
      },
      "categories": [
        {
          "id": 1,
          "name": "Category Name",
          "alias": "category_alias"
        }
      ],
      "fields": {
        "id": 1,
        "name": "Field Name",
        "position": 5,
        "alias": "usr_first_name",
        "has_unique_data": false,
        "has_value": true,
        "removable": false,
        "is_active": true,
        "list": false,
        "read_only": false,
        "required": true,
        "type": {
          "id": 1,
          "name": "Data Type Name",
          "alias": "data_type_alias",
          "settings": [
            {
              "id": 1,
              "name": "Data Type Setting Name",
              "alias": "data_type_setting_alias",
              "is_required": true
            }
          ],
          "supports_collection": false,
          "supports_read_only": false,
          "supports_unique": false
        },
        "category": {
          "id": 32,
          "alias": "usr_identity",
          "position": 5,
          "system_required": true,
          "name": "Identity",
          "description": "...",
          "is_active": true,
          "pso_type": {
            "id": 56,
            "name": "User",
            "alias": "usr",
            "description": "...",
            "is_active": true,
            "system_required": true,
            "creation_form_instance_id": 1,
            "profile_form_instance_id": 1
          }
        },
        "domains": [
          {
            "id": 46,
            "alias": "usr_global",
            "name": "User Global",
            "description": "...",
            "is_editable": false,
            "is_removable": false,
            "is_active": true,
            "pso_type": {
              "id": 56,
              "name": "User",
              "alias": "usr",
              "description": "...",
              "is_active": true,
              "system_required": true,
              "creation_form_instance_id": 1,
              "profile_form_instance_id": 1
            }
          }
        ],
        "privacy_level": {
          "id": 123,
          "alias": "public",
          "name": "Not Sensitive",
          "level": 100
        },
        "pso_type": {
          "id": 56,
          "name": "User",
          "alias": "usr",
          "description": "...",
          "is_active": true,
          "system_required": true,
          "creation_form_instance_id": 1,
          "profile_form_instance_id": 1
        },
        "items": [
          {
            "id": 1,
            "name": "Field Name",
            "position": 5,
            "alias": "usr_first_name",
            "has_unique_data": false,
            "has_value": true,
            "removable": false,
            "is_active": true,
            "list": false,
            "read_only": false,
            "required": true,
            "user_required": true,
            "system_required": true,
            "type": {
              "id": 1,
              "name": "Data Type Name",
              "alias": "data_type_alias",
              "settings": [
                {
                  "id": 1,
                  "name": "Data Type Setting Name",
                  "alias": "data_type_setting_alias",
                  "is_required": true
                }
              ],
              "supports_collection": false,
              "supports_read_only": false,
              "supports_unique": false
            },
            "category": {
              "id": 32,
              "alias": "usr_identity",
              "position": 5,
              "system_required": true,
              "name": "Identity",
              "description": "...",
              "is_active": true,
              "pso_type": {
                "id": 56,
                "name": "User",
                "alias": "usr",
                "description": "...",
                "is_active": true,
                "system_required": true,
                "creation_form_instance_id": 1,
                "profile_form_instance_id": 1
              }
            },
            "domains": [
              {
                "id": 46,
                "alias": "usr_global",
                "name": "User Global",
                "description": "...",
                "is_editable": false,
                "is_removable": false,
                "is_active": true,
                "pso_type": {
                  "id": 56,
                  "name": "User",
                  "alias": "usr",
                  "description": "...",
                  "is_active": true,
                  "system_required": true,
                  "creation_form_instance_id": 1,
                  "profile_form_instance_id": 1
                }
              }
            ],
            "privacy_level": {
              "id": 123,
              "alias": "public",
              "name": "Not Sensitive",
              "level": 100
            },
            "pso_type": {
              "id": 56,
              "name": "User",
              "alias": "usr",
              "description": "...",
              "is_active": true,
              "system_required": true,
              "creation_form_instance_id": 1,
              "profile_form_instance_id": 1
            },
            "items": [
              {}
            ],
            "options": [
              {
                "id": 198,
                "name": "Choose me!",
                "position": 9,
                "value": "198",
                "is_active": true,
                "is_selectable": true
              }
            ],
            "settings": [],
            "validation": {
              "type": "regexp",
              "attributes": {},
              "value_example": "string",
              "error_message": {
                "en": "Some text",
                "fr": "Du texte",
                "de": "Setwas Text",
                "es": "Algún texto"
              }
            },
            "has_autocomplete_settings": true,
            "autocomplete_settings": {
              "allow_extra_values": true,
              "autofill": true,
              "provider": {
                "name": {
                  "en": "Some text",
                  "fr": "Du texte",
                  "de": "Setwas Text",
                  "es": "Algún texto"
                },
                "alias": "string",
                "base_url": "https://exmaple.com/",
                "single_value_supported": true,
                "parameters": [
                  {
                    "name": "Name",
                    "key": "alias",
                    "required": true
                  }
                ]
              },
              "parameters": [
                {
                  "name": "Name",
                  "key": "alias",
                  "required": true,
                  "value": "value",
                  "field": {
                    "id": 1,
                    "name": "Field Name",
                    "alias": "usr_first_name",
                    "value": "RU",
                    "root_field": {
                      "id": 1,
                      "name": "Field Name",
                      "alias": "usr_first_name",
                      "value": "RU",
                      "root_field": "null"
                    }
                  }
                }
              ]
            }
          }
        ],
        "options": [
          {
            "id": 198,
            "name": "Choose me!",
            "position": 9,
            "value": "198",
            "is_active": true,
            "is_selectable": true
          }
        ],
        "settings": [],
        "is_locked": false,
        "value_details": [
          "value1",
          "value2"
        ],
        "values_count": 2,
        "assignment_settings": [
          {
            "setting": "public",
            "value": "1"
          }
        ],
        "access_permissions": {
          "history": true,
          "view": true,
          "edit": true
        },
        "assignment_permissions": {
          "permissions": {
            "id": 1,
            "name": "View",
            "alias": "view"
          },
          "access_list": [
            "0",
            "1",
            "1"
          ]
        }
      }
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "summary": {
          "type": "object",
          "properties": {
            "first_name": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number"
                },
                "alias": {
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "description": "if field support multiple values it can be array"
                }
              },
              "required": [
                "id",
                "alias",
                "value"
              ]
            },
            "last_name": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number"
                },
                "alias": {
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "description": "if field support multiple values it can be array"
                }
              },
              "required": [
                "id",
                "alias",
                "value"
              ]
            },
            "image": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number"
                },
                "alias": {
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "description": "if field support multiple values it can be array"
                }
              },
              "required": [
                "id",
                "alias",
                "value"
              ]
            },
            "is_active": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number"
                },
                "alias": {
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "description": "if field support multiple values it can be array"
                }
              },
              "required": [
                "id",
                "alias",
                "value"
              ]
            },
            "email": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number"
                },
                "alias": {
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "description": "if field support multiple values it can be array"
                }
              },
              "required": [
                "id",
                "alias",
                "value"
              ]
            },
            "phone_number": {
              "type": "string"
            }
          },
          "required": [
            "first_name",
            "last_name",
            "image",
            "is_active",
            "email",
            "phone_number"
          ]
        },
        "pso": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "profile_form": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number"
                },
                "name": {
                  "type": "string"
                },
                "description": {
                  "type": "string"
                },
                "is_active": {
                  "type": "boolean"
                },
                "active_field": {
                  "type": [
                    "string",
                    "null"
                  ]
                }
              },
              "required": [
                "id",
                "name",
                "description",
                "is_active"
              ]
            },
            "pso_type": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number"
                },
                "name": {
                  "type": "string"
                },
                "alias": {
                  "type": "string"
                },
                "description": {
                  "type": "string"
                },
                "is_active": {
                  "type": "boolean"
                },
                "system_required": {
                  "type": "boolean"
                },
                "creation_form_instance_id": {
                  "type": "number"
                },
                "profile_form_instance_id": {
                  "type": "number"
                }
              },
              "required": [
                "id",
                "name",
                "alias",
                "description",
                "is_active",
                "system_required",
                "creation_form_instance_id",
                "profile_form_instance_id"
              ]
            },
            "categories": {
              "type": "array"
            },
            "fields": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number"
                },
                "name": {
                  "type": "string"
                },
                "position": {
                  "type": "number"
                },
                "alias": {
                  "type": "string"
                },
                "has_unique_data": {
                  "type": "boolean",
                  "description": "whether field requires values to be unique across system"
                },
                "has_value": {
                  "type": "boolean",
                  "description": "whether field has at least one value submitted"
                },
                "removable": {
                  "type": "boolean",
                  "description": "whether field can be removed from system"
                },
                "is_active": {
                  "type": "boolean"
                },
                "list": {
                  "type": "boolean",
                  "description": "whether field can handle collection of values"
                },
                "read_only": {
                  "type": "boolean",
                  "description": "whether field value can be changed"
                },
                "required": {
                  "type": "boolean",
                  "description": "whether field value required by system"
                },
                "type": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "number"
                    },
                    "name": {
                      "type": "string"
                    },
                    "alias": {
                      "type": "string"
                    },
                    "settings": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "number"
                          },
                          "name": {
                            "type": "string"
                          },
                          "alias": {
                            "type": "string"
                          },
                          "is_required": {
                            "type": "boolean"
                          }
                        },
                        "required": [
                          "id",
                          "name",
                          "alias",
                          "is_required"
                        ]
                      }
                    },
                    "supports_collection": {
                      "type": "boolean"
                    },
                    "supports_read_only": {
                      "type": "boolean"
                    },
                    "supports_unique": {
                      "type": "boolean"
                    }
                  },
                  "required": [
                    "id",
                    "name",
                    "alias",
                    "settings",
                    "supports_collection",
                    "supports_read_only",
                    "supports_unique"
                  ],
                  "additionalProperties": false
                },
                "category": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "number"
                    },
                    "alias": {
                      "type": "string"
                    },
                    "position": {
                      "type": "number"
                    },
                    "system_required": {
                      "type": "boolean"
                    },
                    "name": {
                      "type": "string"
                    },
                    "description": {
                      "type": "string"
                    },
                    "is_active": {
                      "type": "boolean"
                    },
                    "pso_type": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "number"
                        },
                        "name": {
                          "type": "string"
                        },
                        "alias": {
                          "type": "string"
                        },
                        "description": {
                          "type": "string"
                        },
                        "is_active": {
                          "type": "boolean"
                        },
                        "system_required": {
                          "type": "boolean"
                        },
                        "creation_form_instance_id": {
                          "type": "number"
                        },
                        "profile_form_instance_id": {
                          "type": "number"
                        }
                      },
                      "required": [
                        "id",
                        "name",
                        "alias",
                        "description",
                        "is_active",
                        "system_required",
                        "creation_form_instance_id",
                        "profile_form_instance_id"
                      ],
                      "additionalProperties": false,
                      "description": "Presented only if `include` was send"
                    }
                  },
                  "required": [
                    "id",
                    "alias",
                    "position",
                    "system_required",
                    "name",
                    "description",
                    "is_active"
                  ],
                  "additionalProperties": false
                },
                "domains": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "number"
                      },
                      "alias": {
                        "type": "string"
                      },
                      "name": {
                        "type": "string"
                      },
                      "description": {
                        "type": "string"
                      },
                      "is_editable": {
                        "type": "boolean"
                      },
                      "is_removable": {
                        "type": "boolean"
                      },
                      "is_active": {
                        "type": "boolean"
                      },
                      "pso_type": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "number"
                          },
                          "name": {
                            "type": "string"
                          },
                          "alias": {
                            "type": "string"
                          },
                          "description": {
                            "type": "string"
                          },
                          "is_active": {
                            "type": "boolean"
                          },
                          "system_required": {
                            "type": "boolean"
                          },
                          "creation_form_instance_id": {
                            "type": "number"
                          },
                          "profile_form_instance_id": {
                            "type": "number"
                          }
                        },
                        "required": [
                          "id",
                          "name",
                          "alias",
                          "description",
                          "is_active",
                          "system_required",
                          "creation_form_instance_id",
                          "profile_form_instance_id"
                        ],
                        "additionalProperties": false
                      }
                    },
                    "required": [
                      "id",
                      "alias",
                      "name",
                      "description",
                      "is_editable",
                      "is_removable",
                      "is_active"
                    ]
                  }
                },
                "privacy_level": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "number"
                    },
                    "alias": {
                      "type": "string"
                    },
                    "name": {
                      "type": "string"
                    },
                    "level": {
                      "type": "number"
                    }
                  },
                  "required": [
                    "id",
                    "alias",
                    "name",
                    "level"
                  ],
                  "additionalProperties": false
                },
                "pso_type": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "number"
                    },
                    "name": {
                      "type": "string"
                    },
                    "alias": {
                      "type": "string"
                    },
                    "description": {
                      "type": "string"
                    },
                    "is_active": {
                      "type": "boolean"
                    },
                    "system_required": {
                      "type": "boolean"
                    },
                    "creation_form_instance_id": {
                      "type": "number"
                    },
                    "profile_form_instance_id": {
                      "type": "number"
                    }
                  },
                  "required": [
                    "id",
                    "name",
                    "alias",
                    "description",
                    "is_active",
                    "system_required",
                    "creation_form_instance_id",
                    "profile_form_instance_id"
                  ],
                  "additionalProperties": false
                },
                "items": {
                  "type": [
                    "array",
                    "null"
                  ],
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "number"
                      },
                      "name": {
                        "type": "string"
                      },
                      "position": {
                        "type": "number"
                      },
                      "alias": {
                        "type": "string"
                      },
                      "has_unique_data": {
                        "type": "boolean",
                        "description": "whether field requires values to be unique across system"
                      },
                      "has_value": {
                        "type": "boolean",
                        "description": "whether field has at least one value submitted"
                      },
                      "removable": {
                        "type": "boolean",
                        "description": "whether field can be removed from system"
                      },
                      "is_active": {
                        "type": "boolean"
                      },
                      "list": {
                        "type": "boolean",
                        "description": "whether field can handle collection of values"
                      },
                      "read_only": {
                        "type": "boolean",
                        "description": "whether field value can be changed"
                      },
                      "required": {
                        "type": "boolean",
                        "description": "deprecated setting"
                      },
                      "user_required": {
                        "type": "boolean",
                        "description": "whether field value required by user"
                      },
                      "system_required": {
                        "type": "boolean",
                        "description": "whether field value required by system"
                      },
                      "type": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "number"
                          },
                          "name": {
                            "type": "string"
                          },
                          "alias": {
                            "type": "string"
                          },
                          "settings": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "id": {
                                  "type": "number"
                                },
                                "name": {
                                  "type": "string"
                                },
                                "alias": {
                                  "type": "string"
                                },
                                "is_required": {
                                  "type": "boolean"
                                }
                              },
                              "required": [
                                "id",
                                "name",
                                "alias",
                                "is_required"
                              ]
                            }
                          },
                          "supports_collection": {
                            "type": "boolean"
                          },
                          "supports_read_only": {
                            "type": "boolean"
                          },
                          "supports_unique": {
                            "type": "boolean"
                          }
                        },
                        "required": [
                          "id",
                          "name",
                          "alias",
                          "settings",
                          "supports_collection",
                          "supports_read_only",
                          "supports_unique"
                        ],
                        "additionalProperties": false
                      },
                      "category": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "number"
                          },
                          "alias": {
                            "type": "string"
                          },
                          "position": {
                            "type": "number"
                          },
                          "system_required": {
                            "type": "boolean"
                          },
                          "name": {
                            "type": "string"
                          },
                          "description": {
                            "type": "string"
                          },
                          "is_active": {
                            "type": "boolean"
                          },
                          "pso_type": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "number"
                              },
                              "name": {
                                "type": "string"
                              },
                              "alias": {
                                "type": "string"
                              },
                              "description": {
                                "type": "string"
                              },
                              "is_active": {
                                "type": "boolean"
                              },
                              "system_required": {
                                "type": "boolean"
                              },
                              "creation_form_instance_id": {
                                "type": "number"
                              },
                              "profile_form_instance_id": {
                                "type": "number"
                              }
                            },
                            "required": [
                              "id",
                              "name",
                              "alias",
                              "description",
                              "is_active",
                              "system_required",
                              "creation_form_instance_id",
                              "profile_form_instance_id"
                            ],
                            "additionalProperties": false,
                            "description": "Presented only if `include` was send"
                          }
                        },
                        "required": [
                          "id",
                          "alias",
                          "position",
                          "system_required",
                          "name",
                          "description",
                          "is_active"
                        ],
                        "additionalProperties": false
                      },
                      "domains": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "number"
                            },
                            "alias": {
                              "type": "string"
                            },
                            "name": {
                              "type": "string"
                            },
                            "description": {
                              "type": "string"
                            },
                            "is_editable": {
                              "type": "boolean"
                            },
                            "is_removable": {
                              "type": "boolean"
                            },
                            "is_active": {
                              "type": "boolean"
                            },
                            "pso_type": {
                              "type": "object",
                              "properties": {
                                "id": {
                                  "type": "number"
                                },
                                "name": {
                                  "type": "string"
                                },
                                "alias": {
                                  "type": "string"
                                },
                                "description": {
                                  "type": "string"
                                },
                                "is_active": {
                                  "type": "boolean"
                                },
                                "system_required": {
                                  "type": "boolean"
                                },
                                "creation_form_instance_id": {
                                  "type": "number"
                                },
                                "profile_form_instance_id": {
                                  "type": "number"
                                }
                              },
                              "required": [
                                "id",
                                "name",
                                "alias",
                                "description",
                                "is_active",
                                "system_required",
                                "creation_form_instance_id",
                                "profile_form_instance_id"
                              ],
                              "additionalProperties": false
                            }
                          },
                          "required": [
                            "id",
                            "alias",
                            "name",
                            "description",
                            "is_editable",
                            "is_removable",
                            "is_active"
                          ]
                        }
                      },
                      "privacy_level": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "number"
                          },
                          "alias": {
                            "type": "string"
                          },
                          "name": {
                            "type": "string"
                          },
                          "level": {
                            "type": "number"
                          }
                        },
                        "required": [
                          "id",
                          "alias",
                          "name",
                          "level"
                        ],
                        "additionalProperties": false
                      },
                      "pso_type": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "number"
                          },
                          "name": {
                            "type": "string"
                          },
                          "alias": {
                            "type": "string"
                          },
                          "description": {
                            "type": "string"
                          },
                          "is_active": {
                            "type": "boolean"
                          },
                          "system_required": {
                            "type": "boolean"
                          },
                          "creation_form_instance_id": {
                            "type": "number"
                          },
                          "profile_form_instance_id": {
                            "type": "number"
                          }
                        },
                        "required": [
                          "id",
                          "name",
                          "alias",
                          "description",
                          "is_active",
                          "system_required",
                          "creation_form_instance_id",
                          "profile_form_instance_id"
                        ],
                        "additionalProperties": false
                      },
                      "items": {
                        "type": [
                          "array",
                          "null"
                        ],
                        "items": {
                          "type": "object",
                          "properties": {}
                        }
                      },
                      "options": {
                        "type": [
                          "array",
                          "null"
                        ],
                        "items": {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "number"
                            },
                            "name": {
                              "type": "string"
                            },
                            "position": {
                              "type": "number"
                            },
                            "value": {
                              "type": "string"
                            },
                            "is_active": {
                              "type": "boolean"
                            },
                            "is_selectable": {
                              "type": "boolean",
                              "description": "Can select on front this option (Using only in Hierarchy field))"
                            }
                          },
                          "required": [
                            "id",
                            "name",
                            "position",
                            "value",
                            "is_active",
                            "is_selectable"
                          ]
                        },
                        "description": "List of options with possible (allowed) values."
                      },
                      "settings": {
                        "type": "array",
                        "items": {
                          "type": "string"
                        },
                        "description": "Common field settings"
                      },
                      "validation": {
                        "type": "object",
                        "properties": {
                          "type": {
                            "type": "string"
                          },
                          "attributes": {
                            "type": "object",
                            "properties": {}
                          },
                          "value_example": {
                            "type": "string"
                          },
                          "error_message": {
                            "type": "object",
                            "properties": {
                              "en": {
                                "type": "string"
                              },
                              "fr": {
                                "type": "string"
                              },
                              "de": {
                                "type": "string"
                              },
                              "es": {
                                "type": "string"
                              }
                            },
                            "required": [
                              "en",
                              "fr",
                              "de",
                              "es"
                            ]
                          }
                        },
                        "required": [
                          "type",
                          "value_example",
                          "error_message"
                        ]
                      },
                      "has_autocomplete_settings": {
                        "type": "boolean"
                      },
                      "autocomplete_settings": {
                        "type": "object",
                        "properties": {
                          "allow_extra_values": {
                            "type": "boolean"
                          },
                          "autofill": {
                            "type": "boolean"
                          },
                          "provider": {
                            "type": "object",
                            "properties": {
                              "name": {
                                "type": "object",
                                "properties": {
                                  "en": {
                                    "type": "string"
                                  },
                                  "fr": {
                                    "type": "string"
                                  },
                                  "de": {
                                    "type": "string"
                                  },
                                  "es": {
                                    "type": "string"
                                  }
                                },
                                "required": [
                                  "en",
                                  "fr",
                                  "de",
                                  "es"
                                ]
                              },
                              "alias": {
                                "type": "string"
                              },
                              "base_url": {
                                "type": "string"
                              },
                              "single_value_supported": {
                                "type": "boolean"
                              },
                              "parameters": {
                                "type": "array"
                              }
                            },
                            "required": [
                              "name",
                              "alias",
                              "base_url",
                              "single_value_supported",
                              "parameters"
                            ]
                          },
                          "parameters": {
                            "type": "array"
                          }
                        },
                        "required": [
                          "allow_extra_values",
                          "autofill",
                          "provider",
                          "parameters"
                        ]
                      }
                    },
                    "required": [
                      "id",
                      "name",
                      "position",
                      "alias",
                      "has_unique_data",
                      "has_value",
                      "removable",
                      "is_active",
                      "list",
                      "read_only",
                      "required",
                      "user_required",
                      "system_required",
                      "validation",
                      "has_autocomplete_settings",
                      "autocomplete_settings"
                    ]
                  }
                },
                "options": {
                  "type": [
                    "array",
                    "null"
                  ],
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "number"
                      },
                      "name": {
                        "type": "string"
                      },
                      "position": {
                        "type": "number"
                      },
                      "value": {
                        "type": "string"
                      },
                      "is_active": {
                        "type": "boolean"
                      },
                      "is_selectable": {
                        "type": "boolean",
                        "description": "Can select on front this option (Using only in Hierarchy field))"
                      }
                    },
                    "required": [
                      "id",
                      "name",
                      "position",
                      "value",
                      "is_active",
                      "is_selectable"
                    ]
                  },
                  "description": "List of options with possible (allowed) values."
                },
                "settings": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  },
                  "description": "Common field settings"
                },
                "is_locked": {
                  "type": "boolean"
                },
                "value_details": {
                  "type": "array"
                },
                "values_count": {
                  "type": "number"
                },
                "assignment_settings": {
                  "type": "array"
                },
                "access_permissions": {
                  "type": "object",
                  "properties": {
                    "history": {
                      "type": "boolean"
                    },
                    "view": {
                      "type": "boolean"
                    },
                    "edit": {
                      "type": "boolean"
                    }
                  },
                  "required": [
                    "history",
                    "view",
                    "edit"
                  ]
                },
                "assignment_permissions": {
                  "type": "object",
                  "properties": {
                    "permissions": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "number"
                        },
                        "name": {
                          "type": "string"
                        },
                        "alias": {
                          "type": "string"
                        }
                      },
                      "required": [
                        "id",
                        "name",
                        "alias"
                      ]
                    },
                    "access_list": {
                      "type": "array",
                      "description": "user, manager, hr"
                    }
                  },
                  "required": [
                    "permissions",
                    "access_list"
                  ]
                }
              },
              "required": [
                "id",
                "name",
                "position",
                "alias",
                "has_unique_data",
                "has_value",
                "removable",
                "is_active",
                "list",
                "read_only",
                "required",
                "is_locked",
                "value_details",
                "values_count",
                "assignment_settings",
                "access_permissions",
                "assignment_permissions"
              ]
            }
          },
          "required": [
            "id"
          ]
        }
      },
      "required": [
        "summary",
        "pso"
      ]
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Fields
GET/psos/fields{?name,active,category,privacy-level,pso-type,data-type,append-profile,target-pso-type,sort-by,sort-direction}

Fetch fields for specified user profile

Example URI

GET https://rest.monportailrh.com/psos/fields?name=Field Name&active=true&category=identity&privacy-level=public&pso-type=usr&data-type=composite&append-profile=true&target-pso-type=usr&sort-by=name&sort-direction=asc
URI Parameters
HideShow
name
string (optional) Example: Field Name

filter by field name

active
boolean (required) Example: true

filter by field activity

category
string (optional) Example: identity

filter by field category

privacy-level
array[string] (optional) Example: public

filter by field privacy level

pso-type
string (optional) Example: usr

filter by field pso type

data-type
array[string] (optional) Example: composite

filter by fields data type

append-profile
boolean (optional) Example: true

if pso-type query param is declared, retrieve only fields which are belong to this pso type profile

target-pso-type
string (optional) Example: usr

retrieve fields with corresponded target_pso_type setting

sort-by
name,pso-type,data-type,category,privacy-level,active (optional) Example: name
sort-direction
asc, desc (optional) Example: asc
Request
HideShow
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": 1,
      "name": "Field Name",
      "position": 5,
      "alias": "usr_first_name",
      "has_unique_data": false,
      "has_value": true,
      "removable": false,
      "is_active": true,
      "list": false,
      "read_only": false,
      "required": true,
      "type": {
        "id": 1,
        "name": "Data Type Name",
        "alias": "data_type_alias",
        "settings": [
          {
            "id": 1,
            "name": "Data Type Setting Name",
            "alias": "data_type_setting_alias",
            "is_required": true
          }
        ],
        "supports_collection": false,
        "supports_read_only": false,
        "supports_unique": false
      },
      "category": {
        "id": 32,
        "alias": "usr_identity",
        "position": 5,
        "system_required": true,
        "name": "Identity",
        "description": "...",
        "is_active": true,
        "pso_type": {
          "id": 56,
          "name": "User",
          "alias": "usr",
          "description": "...",
          "is_active": true,
          "system_required": true,
          "creation_form_instance_id": 1,
          "profile_form_instance_id": 1
        }
      },
      "domains": [
        {
          "id": 46,
          "alias": "usr_global",
          "name": "User Global",
          "description": "...",
          "is_editable": false,
          "is_removable": false,
          "is_active": true,
          "pso_type": {
            "id": 56,
            "name": "User",
            "alias": "usr",
            "description": "...",
            "is_active": true,
            "system_required": true,
            "creation_form_instance_id": 1,
            "profile_form_instance_id": 1
          }
        }
      ],
      "privacy_level": {
        "id": 123,
        "alias": "public",
        "name": "Not Sensitive",
        "level": 100
      },
      "pso_type": {
        "id": 56,
        "name": "User",
        "alias": "usr",
        "description": "...",
        "is_active": true,
        "system_required": true,
        "creation_form_instance_id": 1,
        "profile_form_instance_id": 1
      },
      "items": [
        {
          "id": 1,
          "name": "Field Name",
          "position": 5,
          "alias": "usr_first_name",
          "has_unique_data": false,
          "has_value": true,
          "removable": false,
          "is_active": true,
          "list": false,
          "read_only": false,
          "required": true,
          "user_required": true,
          "system_required": true,
          "type": {
            "id": 1,
            "name": "Data Type Name",
            "alias": "data_type_alias",
            "settings": [
              {
                "id": 1,
                "name": "Data Type Setting Name",
                "alias": "data_type_setting_alias",
                "is_required": true
              }
            ],
            "supports_collection": false,
            "supports_read_only": false,
            "supports_unique": false
          },
          "category": {
            "id": 32,
            "alias": "usr_identity",
            "position": 5,
            "system_required": true,
            "name": "Identity",
            "description": "...",
            "is_active": true,
            "pso_type": {
              "id": 56,
              "name": "User",
              "alias": "usr",
              "description": "...",
              "is_active": true,
              "system_required": true,
              "creation_form_instance_id": 1,
              "profile_form_instance_id": 1
            }
          },
          "domains": [
            {
              "id": 46,
              "alias": "usr_global",
              "name": "User Global",
              "description": "...",
              "is_editable": false,
              "is_removable": false,
              "is_active": true,
              "pso_type": {
                "id": 56,
                "name": "User",
                "alias": "usr",
                "description": "...",
                "is_active": true,
                "system_required": true,
                "creation_form_instance_id": 1,
                "profile_form_instance_id": 1
              }
            }
          ],
          "privacy_level": {
            "id": 123,
            "alias": "public",
            "name": "Not Sensitive",
            "level": 100
          },
          "pso_type": {
            "id": 56,
            "name": "User",
            "alias": "usr",
            "description": "...",
            "is_active": true,
            "system_required": true,
            "creation_form_instance_id": 1,
            "profile_form_instance_id": 1
          },
          "items": [
            {}
          ],
          "options": [
            {
              "id": 198,
              "name": "Choose me!",
              "position": 9,
              "value": "198",
              "is_active": true,
              "is_selectable": true
            }
          ],
          "settings": [],
          "validation": {
            "type": "regexp",
            "attributes": {},
            "value_example": "string",
            "error_message": {
              "en": "Some text",
              "fr": "Du texte",
              "de": "Setwas Text",
              "es": "Algún texto"
            }
          },
          "has_autocomplete_settings": true,
          "autocomplete_settings": {
            "allow_extra_values": true,
            "autofill": true,
            "provider": {
              "name": {
                "en": "Some text",
                "fr": "Du texte",
                "de": "Setwas Text",
                "es": "Algún texto"
              },
              "alias": "string",
              "base_url": "https://exmaple.com/",
              "single_value_supported": true,
              "parameters": [
                {
                  "name": "Name",
                  "key": "alias",
                  "required": true
                }
              ]
            },
            "parameters": [
              {
                "name": "Name",
                "key": "alias",
                "required": true,
                "value": "value",
                "field": {
                  "id": 1,
                  "name": "Field Name",
                  "alias": "usr_first_name",
                  "value": "RU",
                  "root_field": {
                    "id": 1,
                    "name": "Field Name",
                    "alias": "usr_first_name",
                    "value": "RU",
                    "root_field": "null"
                  }
                }
              }
            ]
          }
        }
      ],
      "options": [
        {
          "id": 198,
          "name": "Choose me!",
          "position": 9,
          "value": "198",
          "is_active": true,
          "is_selectable": true
        }
      ],
      "settings": [],
      "is_locked": false,
      "value_details": [
        "value1",
        "value2"
      ],
      "values_count": 2,
      "assignment_settings": [
        {
          "setting": "public",
          "value": "1"
        }
      ],
      "access_permissions": {
        "history": true,
        "view": true,
        "edit": true
      },
      "assignment_permissions": {
        "permissions": {
          "id": 1,
          "name": "View",
          "alias": "view"
        },
        "access_list": [
          "0",
          "1",
          "1"
        ]
      }
    }
  ],
  "meta": {
    "pagination": {
      "total": 238,
      "count": 25,
      "per_page": 25,
      "current_page": 2,
      "total_pages": 10,
      "links": {
        "previous": "http://example.com/api/<endpoint>?page=1",
        "next": "http://example.com/api/<endpoint>?page=3"
      }
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array"
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number"
            },
            "count": {
              "type": "number"
            },
            "per_page": {
              "type": "number"
            },
            "current_page": {
              "type": "number"
            },
            "total_pages": {
              "type": "number"
            },
            "links": {
              "type": "object",
              "properties": {
                "previous": {
                  "type": "string"
                },
                "next": {
                  "type": "string"
                }
              },
              "required": [
                "previous",
                "next"
              ]
            }
          },
          "required": [
            "total",
            "count",
            "per_page",
            "current_page",
            "total_pages",
            "links"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "pagination"
      ]
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Status
POST/psos/{pso}/status

Update status for specified pso

Example URI

POST https://rest.monportailrh.com/psos/1/status
URI Parameters
HideShow
pso
integer (required) Example: 1

id of the pso

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Body
{
  "status": "default",
  "active": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "default",
        "on_leave",
        "on_remote",
        "at_the_office"
      ]
    },
    "active": {
      "type": "boolean"
    }
  },
  "required": [
    "status",
    "active"
  ]
}
Response  202
HideShow
Headers
Content-Type: application/json
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 400
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Pso Types

Resources

Resources is a group of instances which is related to the main system entities. It’s not possible to create new of them or modify existing.

Resources

Action Types
GET/resources/action-types{?page,per-page,no-pagination}

Get list of action types

Example URI

GET https://rest.monportailrh.com/resources/action-types?page=1&per-page=10&no-pagination=false
URI Parameters
HideShow
page
number (required) Example: 1

Page number. 1 by default

per-page
number (required) Example: 10

Number of items per page, 25 by default

no-pagination
boolean (required) Example: false

if presented and positive pagination will not be applied. All available items will be returned.

Note: it may have significant impact on the performance

Note: once this option positive and presented - meta attribute with pagination data will be omit in response

Request
HideShow
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": 1,
      "alias": "action_type_alias",
      "name": "Action Type Name",
      "category": "action_type_category_alias"
    }
  ],
  "meta": {
    "pagination": {
      "total": 238,
      "count": 25,
      "per_page": 25,
      "current_page": 2,
      "total_pages": 10,
      "links": {
        "previous": "http://example.com/api/<endpoint>?page=1",
        "next": "http://example.com/api/<endpoint>?page=3"
      }
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number"
          },
          "alias": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "category": {
            "type": [
              "string",
              "null"
            ]
          }
        },
        "required": [
          "id",
          "alias",
          "name"
        ]
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number"
            },
            "count": {
              "type": "number"
            },
            "per_page": {
              "type": "number"
            },
            "current_page": {
              "type": "number"
            },
            "total_pages": {
              "type": "number"
            },
            "links": {
              "type": "object",
              "properties": {
                "previous": {
                  "type": "string"
                },
                "next": {
                  "type": "string"
                }
              },
              "required": [
                "previous",
                "next"
              ]
            }
          },
          "required": [
            "total",
            "count",
            "per_page",
            "current_page",
            "total_pages",
            "links"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "pagination"
      ]
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Data Types
GET/resources/data-types{?page,per-page,no-pagination}

Get list of data types

Example URI

GET https://rest.monportailrh.com/resources/data-types?page=1&per-page=10&no-pagination=false
URI Parameters
HideShow
page
number (required) Example: 1

Page number. 1 by default

per-page
number (required) Example: 10

Number of items per page, 25 by default

no-pagination
boolean (required) Example: false

if presented and positive pagination will not be applied. All available items will be returned.

Note: it may have significant impact on the performance

Note: once this option positive and presented - meta attribute with pagination data will be omit in response

Request
HideShow
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": 1,
      "name": "Data Type Name",
      "alias": "data_type_alias",
      "settings": [
        {
          "id": 1,
          "name": "Data Type Setting Name",
          "alias": "data_type_setting_alias",
          "is_required": true
        }
      ],
      "supports_collection": false,
      "supports_read_only": false,
      "supports_unique": false
    }
  ],
  "meta": {
    "pagination": {
      "total": 238,
      "count": 25,
      "per_page": 25,
      "current_page": 2,
      "total_pages": 10,
      "links": {
        "previous": "http://example.com/api/<endpoint>?page=1",
        "next": "http://example.com/api/<endpoint>?page=3"
      }
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number"
          },
          "name": {
            "type": "string"
          },
          "alias": {
            "type": "string"
          },
          "settings": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number"
                },
                "name": {
                  "type": "string"
                },
                "alias": {
                  "type": "string"
                },
                "is_required": {
                  "type": "boolean"
                }
              },
              "required": [
                "id",
                "name",
                "alias",
                "is_required"
              ]
            }
          },
          "supports_collection": {
            "type": "boolean"
          },
          "supports_read_only": {
            "type": "boolean"
          },
          "supports_unique": {
            "type": "boolean"
          }
        },
        "required": [
          "id",
          "name",
          "alias",
          "supports_collection",
          "supports_read_only",
          "supports_unique"
        ]
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number"
            },
            "count": {
              "type": "number"
            },
            "per_page": {
              "type": "number"
            },
            "current_page": {
              "type": "number"
            },
            "total_pages": {
              "type": "number"
            },
            "links": {
              "type": "object",
              "properties": {
                "previous": {
                  "type": "string"
                },
                "next": {
                  "type": "string"
                }
              },
              "required": [
                "previous",
                "next"
              ]
            }
          },
          "required": [
            "total",
            "count",
            "per_page",
            "current_page",
            "total_pages",
            "links"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "pagination"
      ]
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Field Categories
GET/resources/field-categories{?page,per-page,no-pagination}

Get list of field categories

Example URI

GET https://rest.monportailrh.com/resources/field-categories?page=1&per-page=10&no-pagination=false
URI Parameters
HideShow
page
number (required) Example: 1

Page number. 1 by default

per-page
number (required) Example: 10

Number of items per page, 25 by default

no-pagination
boolean (required) Example: false

if presented and positive pagination will not be applied. All available items will be returned.

Note: it may have significant impact on the performance

Note: once this option positive and presented - meta attribute with pagination data will be omit in response

Request
HideShow
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": 1,
      "alias": "field_category_alias",
      "name": "Field Category Name",
      "position": 1,
      "system_required": false,
      "description": "Field Category Description",
      "is_active": true,
      "pso_type": {
        "id": 56,
        "name": "User",
        "alias": "usr",
        "description": "...",
        "is_active": true,
        "system_required": true,
        "creation_form_instance_id": 1,
        "profile_form_instance_id": 1
      }
    }
  ],
  "meta": {
    "pagination": {
      "total": 238,
      "count": 25,
      "per_page": 25,
      "current_page": 2,
      "total_pages": 10,
      "links": {
        "previous": "http://example.com/api/<endpoint>?page=1",
        "next": "http://example.com/api/<endpoint>?page=3"
      }
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number"
          },
          "alias": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "position": {
            "type": "number"
          },
          "system_required": {
            "type": "boolean"
          },
          "description": {
            "type": "string"
          },
          "is_active": {
            "type": "boolean"
          },
          "pso_type": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number"
              },
              "name": {
                "type": "string"
              },
              "alias": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "is_active": {
                "type": "boolean"
              },
              "system_required": {
                "type": "boolean"
              },
              "creation_form_instance_id": {
                "type": "number"
              },
              "profile_form_instance_id": {
                "type": "number"
              }
            },
            "required": [
              "id",
              "name",
              "alias",
              "description",
              "is_active",
              "system_required",
              "creation_form_instance_id",
              "profile_form_instance_id"
            ]
          }
        },
        "required": [
          "id",
          "alias",
          "name",
          "position",
          "system_required",
          "description",
          "is_active"
        ]
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number"
            },
            "count": {
              "type": "number"
            },
            "per_page": {
              "type": "number"
            },
            "current_page": {
              "type": "number"
            },
            "total_pages": {
              "type": "number"
            },
            "links": {
              "type": "object",
              "properties": {
                "previous": {
                  "type": "string"
                },
                "next": {
                  "type": "string"
                }
              },
              "required": [
                "previous",
                "next"
              ]
            }
          },
          "required": [
            "total",
            "count",
            "per_page",
            "current_page",
            "total_pages",
            "links"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "pagination"
      ]
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Field Permissions
GET/resources/field-permissions{?page,per-page,no-pagination}

Get list of field permissions

Example URI

GET https://rest.monportailrh.com/resources/field-permissions?page=1&per-page=10&no-pagination=false
URI Parameters
HideShow
page
number (required) Example: 1

Page number. 1 by default

per-page
number (required) Example: 10

Number of items per page, 25 by default

no-pagination
boolean (required) Example: false

if presented and positive pagination will not be applied. All available items will be returned.

Note: it may have significant impact on the performance

Note: once this option positive and presented - meta attribute with pagination data will be omit in response

Request
HideShow
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": 1,
      "alias": "field_permission_alias",
      "name": "Field Permission Name"
    }
  ],
  "meta": {
    "pagination": {
      "total": 238,
      "count": 25,
      "per_page": 25,
      "current_page": 2,
      "total_pages": 10,
      "links": {
        "previous": "http://example.com/api/<endpoint>?page=1",
        "next": "http://example.com/api/<endpoint>?page=3"
      }
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number"
          },
          "alias": {
            "type": "string"
          },
          "name": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "alias",
          "name"
        ]
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number"
            },
            "count": {
              "type": "number"
            },
            "per_page": {
              "type": "number"
            },
            "current_page": {
              "type": "number"
            },
            "total_pages": {
              "type": "number"
            },
            "links": {
              "type": "object",
              "properties": {
                "previous": {
                  "type": "string"
                },
                "next": {
                  "type": "string"
                }
              },
              "required": [
                "previous",
                "next"
              ]
            }
          },
          "required": [
            "total",
            "count",
            "per_page",
            "current_page",
            "total_pages",
            "links"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "pagination"
      ]
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

History Actions
GET/resources/history-actions{?page,per-page,no-pagination}

Get list of history actions

Example URI

GET https://rest.monportailrh.com/resources/history-actions?page=1&per-page=10&no-pagination=false
URI Parameters
HideShow
page
number (required) Example: 1

Page number. 1 by default

per-page
number (required) Example: 10

Number of items per page, 25 by default

no-pagination
boolean (required) Example: false

if presented and positive pagination will not be applied. All available items will be returned.

Note: it may have significant impact on the performance

Note: once this option positive and presented - meta attribute with pagination data will be omit in response

Request
HideShow
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": 1,
      "alias": "history_action_alias",
      "name": "History Action Name"
    }
  ],
  "meta": {
    "pagination": {
      "total": 238,
      "count": 25,
      "per_page": 25,
      "current_page": 2,
      "total_pages": 10,
      "links": {
        "previous": "http://example.com/api/<endpoint>?page=1",
        "next": "http://example.com/api/<endpoint>?page=3"
      }
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number"
          },
          "alias": {
            "type": "string"
          },
          "name": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "alias",
          "name"
        ]
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number"
            },
            "count": {
              "type": "number"
            },
            "per_page": {
              "type": "number"
            },
            "current_page": {
              "type": "number"
            },
            "total_pages": {
              "type": "number"
            },
            "links": {
              "type": "object",
              "properties": {
                "previous": {
                  "type": "string"
                },
                "next": {
                  "type": "string"
                }
              },
              "required": [
                "previous",
                "next"
              ]
            }
          },
          "required": [
            "total",
            "count",
            "per_page",
            "current_page",
            "total_pages",
            "links"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "pagination"
      ]
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Idea Categories
GET/resources/idea-categories{?page,per-page,no-pagination}

Get list of idea categories

Example URI

GET https://rest.monportailrh.com/resources/idea-categories?page=1&per-page=10&no-pagination=false
URI Parameters
HideShow
page
number (required) Example: 1

Page number. 1 by default

per-page
number (required) Example: 10

Number of items per page, 25 by default

no-pagination
boolean (required) Example: false

if presented and positive pagination will not be applied. All available items will be returned.

Note: it may have significant impact on the performance

Note: once this option positive and presented - meta attribute with pagination data will be omit in response

Request
HideShow
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": 1,
      "alias": "idea_category_alias",
      "name": "Idea Category Name"
    }
  ],
  "meta": {
    "pagination": {
      "total": 238,
      "count": 25,
      "per_page": 25,
      "current_page": 2,
      "total_pages": 10,
      "links": {
        "previous": "http://example.com/api/<endpoint>?page=1",
        "next": "http://example.com/api/<endpoint>?page=3"
      }
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number"
          },
          "alias": {
            "type": "string"
          },
          "name": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "alias",
          "name"
        ]
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number"
            },
            "count": {
              "type": "number"
            },
            "per_page": {
              "type": "number"
            },
            "current_page": {
              "type": "number"
            },
            "total_pages": {
              "type": "number"
            },
            "links": {
              "type": "object",
              "properties": {
                "previous": {
                  "type": "string"
                },
                "next": {
                  "type": "string"
                }
              },
              "required": [
                "previous",
                "next"
              ]
            }
          },
          "required": [
            "total",
            "count",
            "per_page",
            "current_page",
            "total_pages",
            "links"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "pagination"
      ]
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Idea Statuses
GET/resources/idea-statuses{?page,per-page,no-pagination}

Get list of idea statuses

Example URI

GET https://rest.monportailrh.com/resources/idea-statuses?page=1&per-page=10&no-pagination=false
URI Parameters
HideShow
page
number (required) Example: 1

Page number. 1 by default

per-page
number (required) Example: 10

Number of items per page, 25 by default

no-pagination
boolean (required) Example: false

if presented and positive pagination will not be applied. All available items will be returned.

Note: it may have significant impact on the performance

Note: once this option positive and presented - meta attribute with pagination data will be omit in response

Request
HideShow
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": 1,
      "alias": "idea_status_alias",
      "name": "Idea Status Name"
    }
  ],
  "meta": {
    "pagination": {
      "total": 238,
      "count": 25,
      "per_page": 25,
      "current_page": 2,
      "total_pages": 10,
      "links": {
        "previous": "http://example.com/api/<endpoint>?page=1",
        "next": "http://example.com/api/<endpoint>?page=3"
      }
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number"
          },
          "alias": {
            "type": "string"
          },
          "name": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "alias",
          "name"
        ]
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number"
            },
            "count": {
              "type": "number"
            },
            "per_page": {
              "type": "number"
            },
            "current_page": {
              "type": "number"
            },
            "total_pages": {
              "type": "number"
            },
            "links": {
              "type": "object",
              "properties": {
                "previous": {
                  "type": "string"
                },
                "next": {
                  "type": "string"
                }
              },
              "required": [
                "previous",
                "next"
              ]
            }
          },
          "required": [
            "total",
            "count",
            "per_page",
            "current_page",
            "total_pages",
            "links"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "pagination"
      ]
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

News Types
GET/resources/news-types{?page,per-page,no-pagination}

Get list of news types

Example URI

GET https://rest.monportailrh.com/resources/news-types?page=1&per-page=10&no-pagination=false
URI Parameters
HideShow
page
number (required) Example: 1

Page number. 1 by default

per-page
number (required) Example: 10

Number of items per page, 25 by default

no-pagination
boolean (required) Example: false

if presented and positive pagination will not be applied. All available items will be returned.

Note: it may have significant impact on the performance

Note: once this option positive and presented - meta attribute with pagination data will be omit in response

Request
HideShow
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": 1,
      "alias": "news_type_alias",
      "name": "News Type Name"
    }
  ],
  "meta": {
    "pagination": {
      "total": 238,
      "count": 25,
      "per_page": 25,
      "current_page": 2,
      "total_pages": 10,
      "links": {
        "previous": "http://example.com/api/<endpoint>?page=1",
        "next": "http://example.com/api/<endpoint>?page=3"
      }
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number"
          },
          "alias": {
            "type": "string"
          },
          "name": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "alias",
          "name"
        ]
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number"
            },
            "count": {
              "type": "number"
            },
            "per_page": {
              "type": "number"
            },
            "current_page": {
              "type": "number"
            },
            "total_pages": {
              "type": "number"
            },
            "links": {
              "type": "object",
              "properties": {
                "previous": {
                  "type": "string"
                },
                "next": {
                  "type": "string"
                }
              },
              "required": [
                "previous",
                "next"
              ]
            }
          },
          "required": [
            "total",
            "count",
            "per_page",
            "current_page",
            "total_pages",
            "links"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "pagination"
      ]
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Notification Types
GET/resources/notification-types{?page,per-page,no-pagination}

Get list of notification types

Example URI

GET https://rest.monportailrh.com/resources/notification-types?page=1&per-page=10&no-pagination=false
URI Parameters
HideShow
page
number (required) Example: 1

Page number. 1 by default

per-page
number (required) Example: 10

Number of items per page, 25 by default

no-pagination
boolean (required) Example: false

if presented and positive pagination will not be applied. All available items will be returned.

Note: it may have significant impact on the performance

Note: once this option positive and presented - meta attribute with pagination data will be omit in response

Request
HideShow
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": 1,
      "alias": "notification_type_alias",
      "name": "Notification Type Name"
    }
  ],
  "meta": {
    "pagination": {
      "total": 238,
      "count": 25,
      "per_page": 25,
      "current_page": 2,
      "total_pages": 10,
      "links": {
        "previous": "http://example.com/api/<endpoint>?page=1",
        "next": "http://example.com/api/<endpoint>?page=3"
      }
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number"
          },
          "alias": {
            "type": "string"
          },
          "name": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "alias",
          "name"
        ]
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number"
            },
            "count": {
              "type": "number"
            },
            "per_page": {
              "type": "number"
            },
            "current_page": {
              "type": "number"
            },
            "total_pages": {
              "type": "number"
            },
            "links": {
              "type": "object",
              "properties": {
                "previous": {
                  "type": "string"
                },
                "next": {
                  "type": "string"
                }
              },
              "required": [
                "previous",
                "next"
              ]
            }
          },
          "required": [
            "total",
            "count",
            "per_page",
            "current_page",
            "total_pages",
            "links"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "pagination"
      ]
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Features
GET/resources/features{?page,per-page,no-pagination}

Get list of features

Example URI

GET https://rest.monportailrh.com/resources/features?page=1&per-page=10&no-pagination=false
URI Parameters
HideShow
page
number (required) Example: 1

Page number. 1 by default

per-page
number (required) Example: 10

Number of items per page, 25 by default

no-pagination
boolean (required) Example: false

if presented and positive pagination will not be applied. All available items will be returned.

Note: it may have significant impact on the performance

Note: once this option positive and presented - meta attribute with pagination data will be omit in response

Request
HideShow
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": 1,
      "alias": "feature_alias",
      "name": "Feature Name"
    }
  ],
  "meta": {
    "pagination": {
      "total": 238,
      "count": 25,
      "per_page": 25,
      "current_page": 2,
      "total_pages": 10,
      "links": {
        "previous": "http://example.com/api/<endpoint>?page=1",
        "next": "http://example.com/api/<endpoint>?page=3"
      }
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number"
          },
          "alias": {
            "type": "string"
          },
          "name": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "alias",
          "name"
        ]
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number"
            },
            "count": {
              "type": "number"
            },
            "per_page": {
              "type": "number"
            },
            "current_page": {
              "type": "number"
            },
            "total_pages": {
              "type": "number"
            },
            "links": {
              "type": "object",
              "properties": {
                "previous": {
                  "type": "string"
                },
                "next": {
                  "type": "string"
                }
              },
              "required": [
                "previous",
                "next"
              ]
            }
          },
          "required": [
            "total",
            "count",
            "per_page",
            "current_page",
            "total_pages",
            "links"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "pagination"
      ]
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Population Types
GET/resources/population-types{?page,per-page,no-pagination}

Get list of population types

Example URI

GET https://rest.monportailrh.com/resources/population-types?page=1&per-page=10&no-pagination=false
URI Parameters
HideShow
page
number (required) Example: 1

Page number. 1 by default

per-page
number (required) Example: 10

Number of items per page, 25 by default

no-pagination
boolean (required) Example: false

if presented and positive pagination will not be applied. All available items will be returned.

Note: it may have significant impact on the performance

Note: once this option positive and presented - meta attribute with pagination data will be omit in response

Request
HideShow
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": 1,
      "alias": "population_type_alias",
      "name": "Population Type Name"
    }
  ],
  "meta": {
    "pagination": {
      "total": 238,
      "count": 25,
      "per_page": 25,
      "current_page": 2,
      "total_pages": 10,
      "links": {
        "previous": "http://example.com/api/<endpoint>?page=1",
        "next": "http://example.com/api/<endpoint>?page=3"
      }
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number"
          },
          "alias": {
            "type": "string"
          },
          "name": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "alias",
          "name"
        ]
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number"
            },
            "count": {
              "type": "number"
            },
            "per_page": {
              "type": "number"
            },
            "current_page": {
              "type": "number"
            },
            "total_pages": {
              "type": "number"
            },
            "links": {
              "type": "object",
              "properties": {
                "previous": {
                  "type": "string"
                },
                "next": {
                  "type": "string"
                }
              },
              "required": [
                "previous",
                "next"
              ]
            }
          },
          "required": [
            "total",
            "count",
            "per_page",
            "current_page",
            "total_pages",
            "links"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "pagination"
      ]
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Privacy Levels
GET/resources/privacy-levels{?page,per-page,no-pagination}

Get list of privacy levels

Example URI

GET https://rest.monportailrh.com/resources/privacy-levels?page=1&per-page=10&no-pagination=false
URI Parameters
HideShow
page
number (required) Example: 1

Page number. 1 by default

per-page
number (required) Example: 10

Number of items per page, 25 by default

no-pagination
boolean (required) Example: false

if presented and positive pagination will not be applied. All available items will be returned.

Note: it may have significant impact on the performance

Note: once this option positive and presented - meta attribute with pagination data will be omit in response

Request
HideShow
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": 1,
      "alias": "privacy_level_alias",
      "name": "Privacy Level Name",
      "level": 500
    }
  ],
  "meta": {
    "pagination": {
      "total": 238,
      "count": 25,
      "per_page": 25,
      "current_page": 2,
      "total_pages": 10,
      "links": {
        "previous": "http://example.com/api/<endpoint>?page=1",
        "next": "http://example.com/api/<endpoint>?page=3"
      }
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number"
          },
          "alias": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "level": {
            "type": "number"
          }
        },
        "required": [
          "id",
          "alias",
          "name",
          "level"
        ]
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number"
            },
            "count": {
              "type": "number"
            },
            "per_page": {
              "type": "number"
            },
            "current_page": {
              "type": "number"
            },
            "total_pages": {
              "type": "number"
            },
            "links": {
              "type": "object",
              "properties": {
                "previous": {
                  "type": "string"
                },
                "next": {
                  "type": "string"
                }
              },
              "required": [
                "previous",
                "next"
              ]
            }
          },
          "required": [
            "total",
            "count",
            "per_page",
            "current_page",
            "total_pages",
            "links"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "pagination"
      ]
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Settings
GET/resources/settings{?page,per-page,no-pagination}

Get list of settings

Example URI

GET https://rest.monportailrh.com/resources/settings?page=1&per-page=10&no-pagination=false
URI Parameters
HideShow
page
number (required) Example: 1

Page number. 1 by default

per-page
number (required) Example: 10

Number of items per page, 25 by default

no-pagination
boolean (required) Example: false

if presented and positive pagination will not be applied. All available items will be returned.

Note: it may have significant impact on the performance

Note: once this option positive and presented - meta attribute with pagination data will be omit in response

Request
HideShow
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": 1,
      "alias": "setting_alias",
      "name": "Setting Name"
    }
  ],
  "meta": {
    "pagination": {
      "total": 238,
      "count": 25,
      "per_page": 25,
      "current_page": 2,
      "total_pages": 10,
      "links": {
        "previous": "http://example.com/api/<endpoint>?page=1",
        "next": "http://example.com/api/<endpoint>?page=3"
      }
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number"
          },
          "alias": {
            "type": "string"
          },
          "name": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "alias",
          "name"
        ]
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number"
            },
            "count": {
              "type": "number"
            },
            "per_page": {
              "type": "number"
            },
            "current_page": {
              "type": "number"
            },
            "total_pages": {
              "type": "number"
            },
            "links": {
              "type": "object",
              "properties": {
                "previous": {
                  "type": "string"
                },
                "next": {
                  "type": "string"
                }
              },
              "required": [
                "previous",
                "next"
              ]
            }
          },
          "required": [
            "total",
            "count",
            "per_page",
            "current_page",
            "total_pages",
            "links"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "pagination"
      ]
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Field access

Field access provide users with access permissions to psos fields.

Management permissions

  • roles.view - ability to view single and list of field access

  • roles.create - ability to create new roles in system

  • roles.edit - ability to edit existing in system roles

  • roles.delete - ability to remove existing in system roles

Field Access Rules

Common List
GET/field-access-rules{?name,active,pso-type,include,sort-by,sort-direction,page,per-page,no-pagination}

Get list of field access rules matches specified filters

Example URI

GET https://rest.monportailrh.com/field-access-rules?name=name of role to search by&active=true&pso-type=usr&include=modules&sort-by=name&sort-direction=asc&page=1&per-page=10&no-pagination=false
URI Parameters
HideShow
name
string (optional) Example: name of role to search by
active
boolean (optional) Example: true
pso-type
string (optional) Example: usr
include
string (optional) Example: modules

The way to include relations in the response. Target relations can be comma separated if you want to get few of them

sort-by
name, pso-type, relation, privacy-level, status (required) Example: name
sort-direction
asc, desc (required) Example: asc
page
number (required) Example: 1

Page number. 1 by default

per-page
number (required) Example: 10

Number of items per page, 25 by default

no-pagination
boolean (required) Example: false

if presented and positive pagination will not be applied. All available items will be returned.

Note: it may have significant impact on the performance

Note: once this option positive and presented - meta attribute with pagination data will be omit in response

Request
HideShow
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": 1,
      "alias": "role_alias",
      "name": "Role Name",
      "description": "Role Description",
      "is_active": true,
      "status": "ok",
      "assignment_mode": "role_driven",
      "permissions": {
        "can_edit": true,
        "can_delete": true
      },
      "relation": "User",
      "relation_type": {
        "alias": "relation_alias",
        "name": "Relation Name"
      },
      "relation_field": {
        "id": 1,
        "name": "Field Name",
        "position": 5,
        "alias": "usr_first_name",
        "has_unique_data": false,
        "has_value": true,
        "removable": false,
        "is_active": true,
        "list": false,
        "read_only": false,
        "required": true,
        "user_required": true,
        "system_required": true,
        "type": {
          "id": 1,
          "name": "Data Type Name",
          "alias": "data_type_alias",
          "settings": [
            {
              "id": 1,
              "name": "Data Type Setting Name",
              "alias": "data_type_setting_alias",
              "is_required": true
            }
          ],
          "supports_collection": false,
          "supports_read_only": false,
          "supports_unique": false
        },
        "category": {
          "id": 32,
          "alias": "usr_identity",
          "position": 5,
          "system_required": true,
          "name": "Identity",
          "description": "...",
          "is_active": true,
          "pso_type": {
            "id": 56,
            "name": "User",
            "alias": "usr",
            "description": "...",
            "is_active": true,
            "system_required": true,
            "creation_form_instance_id": 1,
            "profile_form_instance_id": 1
          }
        },
        "domains": [
          {
            "id": 46,
            "alias": "usr_global",
            "name": "User Global",
            "description": "...",
            "is_editable": false,
            "is_removable": false,
            "is_active": true,
            "pso_type": {
              "id": 56,
              "name": "User",
              "alias": "usr",
              "description": "...",
              "is_active": true,
              "system_required": true,
              "creation_form_instance_id": 1,
              "profile_form_instance_id": 1
            }
          }
        ],
        "privacy_level": {
          "id": 123,
          "alias": "public",
          "name": "Not Sensitive",
          "level": 100
        },
        "pso_type": {
          "id": 56,
          "name": "User",
          "alias": "usr",
          "description": "...",
          "is_active": true,
          "system_required": true,
          "creation_form_instance_id": 1,
          "profile_form_instance_id": 1
        },
        "items": [
          {}
        ],
        "options": [
          {
            "id": 198,
            "name": "Choose me!",
            "position": 9,
            "value": "198",
            "is_active": true,
            "is_selectable": true
          }
        ],
        "settings": [],
        "validation": {
          "type": "regexp",
          "attributes": {},
          "value_example": "string",
          "error_message": {
            "en": "Some text",
            "fr": "Du texte",
            "de": "Setwas Text",
            "es": "Algún texto"
          }
        },
        "has_autocomplete_settings": true,
        "autocomplete_settings": {
          "allow_extra_values": true,
          "autofill": true,
          "provider": {
            "name": {
              "en": "Some text",
              "fr": "Du texte",
              "de": "Setwas Text",
              "es": "Algún texto"
            },
            "alias": "string",
            "base_url": "https://exmaple.com/",
            "single_value_supported": true,
            "parameters": [
              {
                "name": "Name",
                "key": "alias",
                "required": true
              }
            ]
          },
          "parameters": [
            {
              "name": "Name",
              "key": "alias",
              "required": true,
              "value": "value",
              "field": {
                "id": 1,
                "name": "Field Name",
                "alias": "usr_first_name",
                "value": "RU",
                "root_field": {
                  "id": 1,
                  "name": "Field Name",
                  "alias": "usr_first_name",
                  "value": "RU",
                  "root_field": "null"
                }
              }
            }
          ]
        }
      },
      "assignment_rules": [
        {
          "assignee": {
            "type": "all",
            "details": {}
          },
          "population": {
            "type": "all",
            "details": {}
          }
        }
      ],
      "domains": {
        "includes": [
          {
            "id": 46,
            "alias": "usr_global",
            "name": "User Global",
            "description": "...",
            "is_editable": false,
            "is_removable": false,
            "is_active": true,
            "pso_type": {
              "id": 56,
              "name": "User",
              "alias": "usr",
              "description": "...",
              "is_active": true,
              "system_required": true,
              "creation_form_instance_id": 1,
              "profile_form_instance_id": 1
            }
          }
        ],
        "excludes": [
          {
            "id": 46,
            "alias": "usr_global",
            "name": "User Global",
            "description": "...",
            "is_editable": false,
            "is_removable": false,
            "is_active": true,
            "pso_type": {
              "id": 56,
              "name": "User",
              "alias": "usr",
              "description": "...",
              "is_active": true,
              "system_required": true,
              "creation_form_instance_id": 1,
              "profile_form_instance_id": 1
            }
          }
        ]
      },
      "privacy_level": {
        "id": 1,
        "alias": "privacy_level_alias",
        "name": "Privacy Level Name",
        "level": 500
      },
      "pso_type": {
        "id": 56,
        "name": "User",
        "alias": "usr",
        "description": "...",
        "is_active": true,
        "system_required": true,
        "creation_form_instance_id": 1,
        "profile_form_instance_id": 1
      }
    }
  ],
  "meta": {
    "pagination": {
      "total": 238,
      "count": 25,
      "per_page": 25,
      "current_page": 2,
      "total_pages": 10,
      "links": {
        "previous": "http://example.com/api/<endpoint>?page=1",
        "next": "http://example.com/api/<endpoint>?page=3"
      }
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number"
          },
          "alias": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "is_active": {
            "type": "boolean"
          },
          "status": {
            "type": "string",
            "enum": [
              "ok",
              "pending",
              "processing",
              "conflict",
              "failed"
            ]
          },
          "assignment_mode": {
            "type": "string",
            "enum": [
              "user_driven",
              "role_driven",
              "system_driven"
            ]
          },
          "permissions": {
            "type": "object",
            "properties": {
              "can_edit": {
                "type": "boolean"
              },
              "can_delete": {
                "type": "boolean"
              }
            },
            "required": [
              "can_edit",
              "can_delete"
            ]
          },
          "relation": {
            "type": "string"
          },
          "relation_type": {
            "type": "object",
            "properties": {
              "alias": {
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            },
            "required": [
              "alias",
              "name"
            ]
          },
          "relation_field": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number"
              },
              "name": {
                "type": "string"
              },
              "position": {
                "type": "number"
              },
              "alias": {
                "type": "string"
              },
              "has_unique_data": {
                "type": "boolean",
                "description": "whether field requires values to be unique across system"
              },
              "has_value": {
                "type": "boolean",
                "description": "whether field has at least one value submitted"
              },
              "removable": {
                "type": "boolean",
                "description": "whether field can be removed from system"
              },
              "is_active": {
                "type": "boolean"
              },
              "list": {
                "type": "boolean",
                "description": "whether field can handle collection of values"
              },
              "read_only": {
                "type": "boolean",
                "description": "whether field value can be changed"
              },
              "required": {
                "type": "boolean",
                "description": "deprecated setting"
              },
              "user_required": {
                "type": "boolean",
                "description": "whether field value required by user"
              },
              "system_required": {
                "type": "boolean",
                "description": "whether field value required by system"
              },
              "type": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "number"
                  },
                  "name": {
                    "type": "string"
                  },
                  "alias": {
                    "type": "string"
                  },
                  "settings": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "number"
                        },
                        "name": {
                          "type": "string"
                        },
                        "alias": {
                          "type": "string"
                        },
                        "is_required": {
                          "type": "boolean"
                        }
                      },
                      "required": [
                        "id",
                        "name",
                        "alias",
                        "is_required"
                      ]
                    }
                  },
                  "supports_collection": {
                    "type": "boolean"
                  },
                  "supports_read_only": {
                    "type": "boolean"
                  },
                  "supports_unique": {
                    "type": "boolean"
                  }
                },
                "required": [
                  "id",
                  "name",
                  "alias",
                  "settings",
                  "supports_collection",
                  "supports_read_only",
                  "supports_unique"
                ],
                "additionalProperties": false
              },
              "category": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "number"
                  },
                  "alias": {
                    "type": "string"
                  },
                  "position": {
                    "type": "number"
                  },
                  "system_required": {
                    "type": "boolean"
                  },
                  "name": {
                    "type": "string"
                  },
                  "description": {
                    "type": "string"
                  },
                  "is_active": {
                    "type": "boolean"
                  },
                  "pso_type": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "number"
                      },
                      "name": {
                        "type": "string"
                      },
                      "alias": {
                        "type": "string"
                      },
                      "description": {
                        "type": "string"
                      },
                      "is_active": {
                        "type": "boolean"
                      },
                      "system_required": {
                        "type": "boolean"
                      },
                      "creation_form_instance_id": {
                        "type": "number"
                      },
                      "profile_form_instance_id": {
                        "type": "number"
                      }
                    },
                    "required": [
                      "id",
                      "name",
                      "alias",
                      "description",
                      "is_active",
                      "system_required",
                      "creation_form_instance_id",
                      "profile_form_instance_id"
                    ],
                    "additionalProperties": false,
                    "description": "Presented only if `include` was send"
                  }
                },
                "required": [
                  "id",
                  "alias",
                  "position",
                  "system_required",
                  "name",
                  "description",
                  "is_active"
                ],
                "additionalProperties": false
              },
              "domains": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "number"
                    },
                    "alias": {
                      "type": "string"
                    },
                    "name": {
                      "type": "string"
                    },
                    "description": {
                      "type": "string"
                    },
                    "is_editable": {
                      "type": "boolean"
                    },
                    "is_removable": {
                      "type": "boolean"
                    },
                    "is_active": {
                      "type": "boolean"
                    },
                    "pso_type": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "number"
                        },
                        "name": {
                          "type": "string"
                        },
                        "alias": {
                          "type": "string"
                        },
                        "description": {
                          "type": "string"
                        },
                        "is_active": {
                          "type": "boolean"
                        },
                        "system_required": {
                          "type": "boolean"
                        },
                        "creation_form_instance_id": {
                          "type": "number"
                        },
                        "profile_form_instance_id": {
                          "type": "number"
                        }
                      },
                      "required": [
                        "id",
                        "name",
                        "alias",
                        "description",
                        "is_active",
                        "system_required",
                        "creation_form_instance_id",
                        "profile_form_instance_id"
                      ],
                      "additionalProperties": false
                    }
                  },
                  "required": [
                    "id",
                    "alias",
                    "name",
                    "description",
                    "is_editable",
                    "is_removable",
                    "is_active"
                  ]
                }
              },
              "privacy_level": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "number"
                  },
                  "alias": {
                    "type": "string"
                  },
                  "name": {
                    "type": "string"
                  },
                  "level": {
                    "type": "number"
                  }
                },
                "required": [
                  "id",
                  "alias",
                  "name",
                  "level"
                ],
                "additionalProperties": false
              },
              "pso_type": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "number"
                  },
                  "name": {
                    "type": "string"
                  },
                  "alias": {
                    "type": "string"
                  },
                  "description": {
                    "type": "string"
                  },
                  "is_active": {
                    "type": "boolean"
                  },
                  "system_required": {
                    "type": "boolean"
                  },
                  "creation_form_instance_id": {
                    "type": "number"
                  },
                  "profile_form_instance_id": {
                    "type": "number"
                  }
                },
                "required": [
                  "id",
                  "name",
                  "alias",
                  "description",
                  "is_active",
                  "system_required",
                  "creation_form_instance_id",
                  "profile_form_instance_id"
                ],
                "additionalProperties": false
              },
              "items": {
                "type": [
                  "array",
                  "null"
                ],
                "items": {
                  "type": "object",
                  "properties": {}
                }
              },
              "options": {
                "type": [
                  "array",
                  "null"
                ],
                "items": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "number"
                    },
                    "name": {
                      "type": "string"
                    },
                    "position": {
                      "type": "number"
                    },
                    "value": {
                      "type": "string"
                    },
                    "is_active": {
                      "type": "boolean"
                    },
                    "is_selectable": {
                      "type": "boolean",
                      "description": "Can select on front this option (Using only in Hierarchy field))"
                    }
                  },
                  "required": [
                    "id",
                    "name",
                    "position",
                    "value",
                    "is_active",
                    "is_selectable"
                  ]
                },
                "description": "List of options with possible (allowed) values."
              },
              "settings": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": "Common field settings"
              },
              "validation": {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string"
                  },
                  "attributes": {
                    "type": "object",
                    "properties": {}
                  },
                  "value_example": {
                    "type": "string"
                  },
                  "error_message": {
                    "type": "object",
                    "properties": {
                      "en": {
                        "type": "string"
                      },
                      "fr": {
                        "type": "string"
                      },
                      "de": {
                        "type": "string"
                      },
                      "es": {
                        "type": "string"
                      }
                    },
                    "required": [
                      "en",
                      "fr",
                      "de",
                      "es"
                    ]
                  }
                },
                "required": [
                  "type",
                  "value_example",
                  "error_message"
                ]
              },
              "has_autocomplete_settings": {
                "type": "boolean"
              },
              "autocomplete_settings": {
                "type": "object",
                "properties": {
                  "allow_extra_values": {
                    "type": "boolean"
                  },
                  "autofill": {
                    "type": "boolean"
                  },
                  "provider": {
                    "type": "object",
                    "properties": {
                      "name": {
                        "type": "object",
                        "properties": {
                          "en": {
                            "type": "string"
                          },
                          "fr": {
                            "type": "string"
                          },
                          "de": {
                            "type": "string"
                          },
                          "es": {
                            "type": "string"
                          }
                        },
                        "required": [
                          "en",
                          "fr",
                          "de",
                          "es"
                        ]
                      },
                      "alias": {
                        "type": "string"
                      },
                      "base_url": {
                        "type": "string"
                      },
                      "single_value_supported": {
                        "type": "boolean"
                      },
                      "parameters": {
                        "type": "array"
                      }
                    },
                    "required": [
                      "name",
                      "alias",
                      "base_url",
                      "single_value_supported",
                      "parameters"
                    ]
                  },
                  "parameters": {
                    "type": "array"
                  }
                },
                "required": [
                  "allow_extra_values",
                  "autofill",
                  "provider",
                  "parameters"
                ]
              }
            },
            "required": [
              "id",
              "name",
              "position",
              "alias",
              "has_unique_data",
              "has_value",
              "removable",
              "is_active",
              "list",
              "read_only",
              "required",
              "user_required",
              "system_required",
              "validation",
              "has_autocomplete_settings",
              "autocomplete_settings"
            ]
          },
          "assignment_rules": {
            "type": "array"
          },
          "domains": {
            "type": "object",
            "properties": {
              "includes": {
                "type": "array"
              },
              "excludes": {
                "type": "array"
              }
            },
            "required": [
              "includes",
              "excludes"
            ]
          },
          "privacy_level": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number"
              },
              "alias": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "level": {
                "type": "number"
              }
            },
            "required": [
              "id",
              "alias",
              "name",
              "level"
            ]
          },
          "pso_type": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number"
              },
              "name": {
                "type": "string"
              },
              "alias": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "is_active": {
                "type": "boolean"
              },
              "system_required": {
                "type": "boolean"
              },
              "creation_form_instance_id": {
                "type": "number"
              },
              "profile_form_instance_id": {
                "type": "number"
              }
            },
            "required": [
              "id",
              "name",
              "alias",
              "description",
              "is_active",
              "system_required",
              "creation_form_instance_id",
              "profile_form_instance_id"
            ]
          }
        },
        "required": [
          "id",
          "alias",
          "name",
          "description",
          "is_active",
          "status",
          "assignment_mode",
          "permissions",
          "relation",
          "relation_type",
          "domains",
          "privacy_level"
        ]
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number"
            },
            "count": {
              "type": "number"
            },
            "per_page": {
              "type": "number"
            },
            "current_page": {
              "type": "number"
            },
            "total_pages": {
              "type": "number"
            },
            "links": {
              "type": "object",
              "properties": {
                "previous": {
                  "type": "string"
                },
                "next": {
                  "type": "string"
                }
              },
              "required": [
                "previous",
                "next"
              ]
            }
          },
          "required": [
            "total",
            "count",
            "per_page",
            "current_page",
            "total_pages",
            "links"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "pagination"
      ]
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Create
POST/field-access-rules

Create new field access rule

Example URI

POST https://rest.monportailrh.com/field-access-rules
Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Body
{
  "name": {
    "en": "Some text",
    "fr": "Du texte",
    "de": "Setwas Text",
    "es": "Algún texto"
  },
  "description": {
    "en": "Some text",
    "fr": "Du texte",
    "de": "Setwas Text",
    "es": "Algún texto"
  },
  "pso_type": "usr",
  "relation_field": "hr",
  "relation_type": "relation_type",
  "is_active": true,
  "assignment_rules": [
    {
      "assignee": {
        "type": "all",
        "details": {}
      },
      "population": {
        "type": "all",
        "details": {}
      }
    }
  ],
  "domains": {
    "includes": [
      "domain_alias"
    ],
    "excludes": [
      "domain_alias"
    ]
  },
  "privacy_level": "public"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "object",
      "properties": {
        "en": {
          "type": "string"
        },
        "fr": {
          "type": "string"
        },
        "de": {
          "type": "string"
        },
        "es": {
          "type": "string"
        }
      },
      "required": [
        "en",
        "fr",
        "de",
        "es"
      ]
    },
    "description": {
      "type": "object",
      "properties": {
        "en": {
          "type": "string"
        },
        "fr": {
          "type": "string"
        },
        "de": {
          "type": "string"
        },
        "es": {
          "type": "string"
        }
      },
      "required": [
        "en",
        "fr",
        "de",
        "es"
      ]
    },
    "pso_type": {
      "type": "string"
    },
    "relation_field": {
      "type": "string"
    },
    "relation_type": {
      "type": "string"
    },
    "is_active": {
      "type": "boolean"
    },
    "assignment_rules": {
      "type": "array"
    },
    "domains": {
      "type": "object",
      "properties": {
        "includes": {
          "type": "array"
        },
        "excludes": {
          "type": "array"
        }
      },
      "required": [
        "includes",
        "excludes"
      ]
    },
    "privacy_level": {
      "type": "string"
    }
  },
  "required": [
    "name",
    "pso_type",
    "is_active",
    "assignment_rules",
    "domains",
    "privacy_level"
  ]
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 1,
    "alias": "role_alias",
    "name": "Role Name",
    "description": "Role Description",
    "is_active": true,
    "status": "ok",
    "assignment_mode": "role_driven",
    "permissions": {
      "can_edit": true,
      "can_delete": true
    },
    "relation": "User",
    "relation_type": {
      "alias": "relation_alias",
      "name": "Relation Name"
    },
    "relation_field": {
      "id": 1,
      "name": "Field Name",
      "position": 5,
      "alias": "usr_first_name",
      "has_unique_data": false,
      "has_value": true,
      "removable": false,
      "is_active": true,
      "list": false,
      "read_only": false,
      "required": true,
      "user_required": true,
      "system_required": true,
      "type": {
        "id": 1,
        "name": "Data Type Name",
        "alias": "data_type_alias",
        "settings": [
          {
            "id": 1,
            "name": "Data Type Setting Name",
            "alias": "data_type_setting_alias",
            "is_required": true
          }
        ],
        "supports_collection": false,
        "supports_read_only": false,
        "supports_unique": false
      },
      "category": {
        "id": 32,
        "alias": "usr_identity",
        "position": 5,
        "system_required": true,
        "name": "Identity",
        "description": "...",
        "is_active": true,
        "pso_type": {
          "id": 56,
          "name": "User",
          "alias": "usr",
          "description": "...",
          "is_active": true,
          "system_required": true,
          "creation_form_instance_id": 1,
          "profile_form_instance_id": 1
        }
      },
      "domains": [
        {
          "id": 46,
          "alias": "usr_global",
          "name": "User Global",
          "description": "...",
          "is_editable": false,
          "is_removable": false,
          "is_active": true,
          "pso_type": {
            "id": 56,
            "name": "User",
            "alias": "usr",
            "description": "...",
            "is_active": true,
            "system_required": true,
            "creation_form_instance_id": 1,
            "profile_form_instance_id": 1
          }
        }
      ],
      "privacy_level": {
        "id": 123,
        "alias": "public",
        "name": "Not Sensitive",
        "level": 100
      },
      "pso_type": {
        "id": 56,
        "name": "User",
        "alias": "usr",
        "description": "...",
        "is_active": true,
        "system_required": true,
        "creation_form_instance_id": 1,
        "profile_form_instance_id": 1
      },
      "items": [
        {}
      ],
      "options": [
        {
          "id": 198,
          "name": "Choose me!",
          "position": 9,
          "value": "198",
          "is_active": true,
          "is_selectable": true
        }
      ],
      "settings": [],
      "validation": {
        "type": "regexp",
        "attributes": {},
        "value_example": "string",
        "error_message": {
          "en": "Some text",
          "fr": "Du texte",
          "de": "Setwas Text",
          "es": "Algún texto"
        }
      },
      "has_autocomplete_settings": true,
      "autocomplete_settings": {
        "allow_extra_values": true,
        "autofill": true,
        "provider": {
          "name": {
            "en": "Some text",
            "fr": "Du texte",
            "de": "Setwas Text",
            "es": "Algún texto"
          },
          "alias": "string",
          "base_url": "https://exmaple.com/",
          "single_value_supported": true,
          "parameters": [
            {
              "name": "Name",
              "key": "alias",
              "required": true
            }
          ]
        },
        "parameters": [
          {
            "name": "Name",
            "key": "alias",
            "required": true,
            "value": "value",
            "field": {
              "id": 1,
              "name": "Field Name",
              "alias": "usr_first_name",
              "value": "RU",
              "root_field": {
                "id": 1,
                "name": "Field Name",
                "alias": "usr_first_name",
                "value": "RU",
                "root_field": "null"
              }
            }
          }
        ]
      }
    },
    "assignment_rules": [
      {
        "assignee": {
          "type": "all",
          "details": {}
        },
        "population": {
          "type": "all",
          "details": {}
        }
      }
    ],
    "domains": {
      "includes": [
        {
          "id": 46,
          "alias": "usr_global",
          "name": "User Global",
          "description": "...",
          "is_editable": false,
          "is_removable": false,
          "is_active": true,
          "pso_type": {
            "id": 56,
            "name": "User",
            "alias": "usr",
            "description": "...",
            "is_active": true,
            "system_required": true,
            "creation_form_instance_id": 1,
            "profile_form_instance_id": 1
          }
        }
      ],
      "excludes": [
        {
          "id": 46,
          "alias": "usr_global",
          "name": "User Global",
          "description": "...",
          "is_editable": false,
          "is_removable": false,
          "is_active": true,
          "pso_type": {
            "id": 56,
            "name": "User",
            "alias": "usr",
            "description": "...",
            "is_active": true,
            "system_required": true,
            "creation_form_instance_id": 1,
            "profile_form_instance_id": 1
          }
        }
      ]
    },
    "privacy_level": {
      "id": 1,
      "alias": "privacy_level_alias",
      "name": "Privacy Level Name",
      "level": 500
    },
    "pso_type": {
      "id": 56,
      "name": "User",
      "alias": "usr",
      "description": "...",
      "is_active": true,
      "system_required": true,
      "creation_form_instance_id": 1,
      "profile_form_instance_id": 1
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "alias": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "is_active": {
          "type": "boolean"
        },
        "status": {
          "type": "string",
          "enum": [
            "ok",
            "pending",
            "processing",
            "conflict",
            "failed"
          ]
        },
        "assignment_mode": {
          "type": "string",
          "enum": [
            "user_driven",
            "role_driven",
            "system_driven"
          ]
        },
        "permissions": {
          "type": "object",
          "properties": {
            "can_edit": {
              "type": "boolean"
            },
            "can_delete": {
              "type": "boolean"
            }
          },
          "required": [
            "can_edit",
            "can_delete"
          ]
        },
        "relation": {
          "type": "string"
        },
        "relation_type": {
          "type": "object",
          "properties": {
            "alias": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          },
          "required": [
            "alias",
            "name"
          ]
        },
        "relation_field": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "name": {
              "type": "string"
            },
            "position": {
              "type": "number"
            },
            "alias": {
              "type": "string"
            },
            "has_unique_data": {
              "type": "boolean",
              "description": "whether field requires values to be unique across system"
            },
            "has_value": {
              "type": "boolean",
              "description": "whether field has at least one value submitted"
            },
            "removable": {
              "type": "boolean",
              "description": "whether field can be removed from system"
            },
            "is_active": {
              "type": "boolean"
            },
            "list": {
              "type": "boolean",
              "description": "whether field can handle collection of values"
            },
            "read_only": {
              "type": "boolean",
              "description": "whether field value can be changed"
            },
            "required": {
              "type": "boolean",
              "description": "deprecated setting"
            },
            "user_required": {
              "type": "boolean",
              "description": "whether field value required by user"
            },
            "system_required": {
              "type": "boolean",
              "description": "whether field value required by system"
            },
            "type": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number"
                },
                "name": {
                  "type": "string"
                },
                "alias": {
                  "type": "string"
                },
                "settings": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "number"
                      },
                      "name": {
                        "type": "string"
                      },
                      "alias": {
                        "type": "string"
                      },
                      "is_required": {
                        "type": "boolean"
                      }
                    },
                    "required": [
                      "id",
                      "name",
                      "alias",
                      "is_required"
                    ]
                  }
                },
                "supports_collection": {
                  "type": "boolean"
                },
                "supports_read_only": {
                  "type": "boolean"
                },
                "supports_unique": {
                  "type": "boolean"
                }
              },
              "required": [
                "id",
                "name",
                "alias",
                "settings",
                "supports_collection",
                "supports_read_only",
                "supports_unique"
              ],
              "additionalProperties": false
            },
            "category": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number"
                },
                "alias": {
                  "type": "string"
                },
                "position": {
                  "type": "number"
                },
                "system_required": {
                  "type": "boolean"
                },
                "name": {
                  "type": "string"
                },
                "description": {
                  "type": "string"
                },
                "is_active": {
                  "type": "boolean"
                },
                "pso_type": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "number"
                    },
                    "name": {
                      "type": "string"
                    },
                    "alias": {
                      "type": "string"
                    },
                    "description": {
                      "type": "string"
                    },
                    "is_active": {
                      "type": "boolean"
                    },
                    "system_required": {
                      "type": "boolean"
                    },
                    "creation_form_instance_id": {
                      "type": "number"
                    },
                    "profile_form_instance_id": {
                      "type": "number"
                    }
                  },
                  "required": [
                    "id",
                    "name",
                    "alias",
                    "description",
                    "is_active",
                    "system_required",
                    "creation_form_instance_id",
                    "profile_form_instance_id"
                  ],
                  "additionalProperties": false,
                  "description": "Presented only if `include` was send"
                }
              },
              "required": [
                "id",
                "alias",
                "position",
                "system_required",
                "name",
                "description",
                "is_active"
              ],
              "additionalProperties": false
            },
            "domains": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "number"
                  },
                  "alias": {
                    "type": "string"
                  },
                  "name": {
                    "type": "string"
                  },
                  "description": {
                    "type": "string"
                  },
                  "is_editable": {
                    "type": "boolean"
                  },
                  "is_removable": {
                    "type": "boolean"
                  },
                  "is_active": {
                    "type": "boolean"
                  },
                  "pso_type": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "number"
                      },
                      "name": {
                        "type": "string"
                      },
                      "alias": {
                        "type": "string"
                      },
                      "description": {
                        "type": "string"
                      },
                      "is_active": {
                        "type": "boolean"
                      },
                      "system_required": {
                        "type": "boolean"
                      },
                      "creation_form_instance_id": {
                        "type": "number"
                      },
                      "profile_form_instance_id": {
                        "type": "number"
                      }
                    },
                    "required": [
                      "id",
                      "name",
                      "alias",
                      "description",
                      "is_active",
                      "system_required",
                      "creation_form_instance_id",
                      "profile_form_instance_id"
                    ],
                    "additionalProperties": false
                  }
                },
                "required": [
                  "id",
                  "alias",
                  "name",
                  "description",
                  "is_editable",
                  "is_removable",
                  "is_active"
                ]
              }
            },
            "privacy_level": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number"
                },
                "alias": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "level": {
                  "type": "number"
                }
              },
              "required": [
                "id",
                "alias",
                "name",
                "level"
              ],
              "additionalProperties": false
            },
            "pso_type": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number"
                },
                "name": {
                  "type": "string"
                },
                "alias": {
                  "type": "string"
                },
                "description": {
                  "type": "string"
                },
                "is_active": {
                  "type": "boolean"
                },
                "system_required": {
                  "type": "boolean"
                },
                "creation_form_instance_id": {
                  "type": "number"
                },
                "profile_form_instance_id": {
                  "type": "number"
                }
              },
              "required": [
                "id",
                "name",
                "alias",
                "description",
                "is_active",
                "system_required",
                "creation_form_instance_id",
                "profile_form_instance_id"
              ],
              "additionalProperties": false
            },
            "items": {
              "type": [
                "array",
                "null"
              ],
              "items": {
                "type": "object",
                "properties": {}
              }
            },
            "options": {
              "type": [
                "array",
                "null"
              ],
              "items": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "number"
                  },
                  "name": {
                    "type": "string"
                  },
                  "position": {
                    "type": "number"
                  },
                  "value": {
                    "type": "string"
                  },
                  "is_active": {
                    "type": "boolean"
                  },
                  "is_selectable": {
                    "type": "boolean",
                    "description": "Can select on front this option (Using only in Hierarchy field))"
                  }
                },
                "required": [
                  "id",
                  "name",
                  "position",
                  "value",
                  "is_active",
                  "is_selectable"
                ]
              },
              "description": "List of options with possible (allowed) values."
            },
            "settings": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "description": "Common field settings"
            },
            "validation": {
              "type": "object",
              "properties": {
                "type": {
                  "type": "string"
                },
                "attributes": {
                  "type": "object",
                  "properties": {}
                },
                "value_example": {
                  "type": "string"
                },
                "error_message": {
                  "type": "object",
                  "properties": {
                    "en": {
                      "type": "string"
                    },
                    "fr": {
                      "type": "string"
                    },
                    "de": {
                      "type": "string"
                    },
                    "es": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "en",
                    "fr",
                    "de",
                    "es"
                  ]
                }
              },
              "required": [
                "type",
                "value_example",
                "error_message"
              ]
            },
            "has_autocomplete_settings": {
              "type": "boolean"
            },
            "autocomplete_settings": {
              "type": "object",
              "properties": {
                "allow_extra_values": {
                  "type": "boolean"
                },
                "autofill": {
                  "type": "boolean"
                },
                "provider": {
                  "type": "object",
                  "properties": {
                    "name": {
                      "type": "object",
                      "properties": {
                        "en": {
                          "type": "string"
                        },
                        "fr": {
                          "type": "string"
                        },
                        "de": {
                          "type": "string"
                        },
                        "es": {
                          "type": "string"
                        }
                      },
                      "required": [
                        "en",
                        "fr",
                        "de",
                        "es"
                      ]
                    },
                    "alias": {
                      "type": "string"
                    },
                    "base_url": {
                      "type": "string"
                    },
                    "single_value_supported": {
                      "type": "boolean"
                    },
                    "parameters": {
                      "type": "array"
                    }
                  },
                  "required": [
                    "name",
                    "alias",
                    "base_url",
                    "single_value_supported",
                    "parameters"
                  ]
                },
                "parameters": {
                  "type": "array"
                }
              },
              "required": [
                "allow_extra_values",
                "autofill",
                "provider",
                "parameters"
              ]
            }
          },
          "required": [
            "id",
            "name",
            "position",
            "alias",
            "has_unique_data",
            "has_value",
            "removable",
            "is_active",
            "list",
            "read_only",
            "required",
            "user_required",
            "system_required",
            "validation",
            "has_autocomplete_settings",
            "autocomplete_settings"
          ]
        },
        "assignment_rules": {
          "type": "array"
        },
        "domains": {
          "type": "object",
          "properties": {
            "includes": {
              "type": "array"
            },
            "excludes": {
              "type": "array"
            }
          },
          "required": [
            "includes",
            "excludes"
          ]
        },
        "privacy_level": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "alias": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "level": {
              "type": "number"
            }
          },
          "required": [
            "id",
            "alias",
            "name",
            "level"
          ]
        },
        "pso_type": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "name": {
              "type": "string"
            },
            "alias": {
              "type": "string"
            },
            "description": {
              "type": "string"
            },
            "is_active": {
              "type": "boolean"
            },
            "system_required": {
              "type": "boolean"
            },
            "creation_form_instance_id": {
              "type": "number"
            },
            "profile_form_instance_id": {
              "type": "number"
            }
          },
          "required": [
            "id",
            "name",
            "alias",
            "description",
            "is_active",
            "system_required",
            "creation_form_instance_id",
            "profile_form_instance_id"
          ]
        }
      },
      "required": [
        "id",
        "alias",
        "name",
        "description",
        "is_active",
        "status",
        "assignment_mode",
        "permissions",
        "relation",
        "relation_type",
        "domains",
        "privacy_level"
      ],
      "additionalProperties": false
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 400
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/field-access-rules/{alias}/{?include}

Get details for selected field access rule

Example URI

GET https://rest.monportailrh.com/field-access-rules/role_alias/?include=modules,features
URI Parameters
HideShow
alias
string (required) Example: role_alias

alias of the role

include
string (optional) Example: modules,features

The way to include relations in the response. Target relations can be comma separated if you want to get few of them

Request
HideShow
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 1,
    "alias": "role_alias",
    "name": "Role Name",
    "description": "Role Description",
    "is_active": true,
    "status": "ok",
    "assignment_mode": "role_driven",
    "permissions": {
      "can_edit": true,
      "can_delete": true
    },
    "relation": "User",
    "relation_type": {
      "alias": "relation_alias",
      "name": "Relation Name"
    },
    "relation_field": {
      "id": 1,
      "name": "Field Name",
      "position": 5,
      "alias": "usr_first_name",
      "has_unique_data": false,
      "has_value": true,
      "removable": false,
      "is_active": true,
      "list": false,
      "read_only": false,
      "required": true,
      "user_required": true,
      "system_required": true,
      "type": {
        "id": 1,
        "name": "Data Type Name",
        "alias": "data_type_alias",
        "settings": [
          {
            "id": 1,
            "name": "Data Type Setting Name",
            "alias": "data_type_setting_alias",
            "is_required": true
          }
        ],
        "supports_collection": false,
        "supports_read_only": false,
        "supports_unique": false
      },
      "category": {
        "id": 32,
        "alias": "usr_identity",
        "position": 5,
        "system_required": true,
        "name": "Identity",
        "description": "...",
        "is_active": true,
        "pso_type": {
          "id": 56,
          "name": "User",
          "alias": "usr",
          "description": "...",
          "is_active": true,
          "system_required": true,
          "creation_form_instance_id": 1,
          "profile_form_instance_id": 1
        }
      },
      "domains": [
        {
          "id": 46,
          "alias": "usr_global",
          "name": "User Global",
          "description": "...",
          "is_editable": false,
          "is_removable": false,
          "is_active": true,
          "pso_type": {
            "id": 56,
            "name": "User",
            "alias": "usr",
            "description": "...",
            "is_active": true,
            "system_required": true,
            "creation_form_instance_id": 1,
            "profile_form_instance_id": 1
          }
        }
      ],
      "privacy_level": {
        "id": 123,
        "alias": "public",
        "name": "Not Sensitive",
        "level": 100
      },
      "pso_type": {
        "id": 56,
        "name": "User",
        "alias": "usr",
        "description": "...",
        "is_active": true,
        "system_required": true,
        "creation_form_instance_id": 1,
        "profile_form_instance_id": 1
      },
      "items": [
        {}
      ],
      "options": [
        {
          "id": 198,
          "name": "Choose me!",
          "position": 9,
          "value": "198",
          "is_active": true,
          "is_selectable": true
        }
      ],
      "settings": [],
      "validation": {
        "type": "regexp",
        "attributes": {},
        "value_example": "string",
        "error_message": {
          "en": "Some text",
          "fr": "Du texte",
          "de": "Setwas Text",
          "es": "Algún texto"
        }
      },
      "has_autocomplete_settings": true,
      "autocomplete_settings": {
        "allow_extra_values": true,
        "autofill": true,
        "provider": {
          "name": {
            "en": "Some text",
            "fr": "Du texte",
            "de": "Setwas Text",
            "es": "Algún texto"
          },
          "alias": "string",
          "base_url": "https://exmaple.com/",
          "single_value_supported": true,
          "parameters": [
            {
              "name": "Name",
              "key": "alias",
              "required": true
            }
          ]
        },
        "parameters": [
          {
            "name": "Name",
            "key": "alias",
            "required": true,
            "value": "value",
            "field": {
              "id": 1,
              "name": "Field Name",
              "alias": "usr_first_name",
              "value": "RU",
              "root_field": {
                "id": 1,
                "name": "Field Name",
                "alias": "usr_first_name",
                "value": "RU",
                "root_field": "null"
              }
            }
          }
        ]
      }
    },
    "assignment_rules": [
      {
        "assignee": {
          "type": "all",
          "details": {}
        },
        "population": {
          "type": "all",
          "details": {}
        }
      }
    ],
    "domains": {
      "includes": [
        {
          "id": 46,
          "alias": "usr_global",
          "name": "User Global",
          "description": "...",
          "is_editable": false,
          "is_removable": false,
          "is_active": true,
          "pso_type": {
            "id": 56,
            "name": "User",
            "alias": "usr",
            "description": "...",
            "is_active": true,
            "system_required": true,
            "creation_form_instance_id": 1,
            "profile_form_instance_id": 1
          }
        }
      ],
      "excludes": [
        {
          "id": 46,
          "alias": "usr_global",
          "name": "User Global",
          "description": "...",
          "is_editable": false,
          "is_removable": false,
          "is_active": true,
          "pso_type": {
            "id": 56,
            "name": "User",
            "alias": "usr",
            "description": "...",
            "is_active": true,
            "system_required": true,
            "creation_form_instance_id": 1,
            "profile_form_instance_id": 1
          }
        }
      ]
    },
    "privacy_level": {
      "id": 1,
      "alias": "privacy_level_alias",
      "name": "Privacy Level Name",
      "level": 500
    },
    "pso_type": {
      "id": 56,
      "name": "User",
      "alias": "usr",
      "description": "...",
      "is_active": true,
      "system_required": true,
      "creation_form_instance_id": 1,
      "profile_form_instance_id": 1
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "alias": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "is_active": {
          "type": "boolean"
        },
        "status": {
          "type": "string",
          "enum": [
            "ok",
            "pending",
            "processing",
            "conflict",
            "failed"
          ]
        },
        "assignment_mode": {
          "type": "string",
          "enum": [
            "user_driven",
            "role_driven",
            "system_driven"
          ]
        },
        "permissions": {
          "type": "object",
          "properties": {
            "can_edit": {
              "type": "boolean"
            },
            "can_delete": {
              "type": "boolean"
            }
          },
          "required": [
            "can_edit",
            "can_delete"
          ]
        },
        "relation": {
          "type": "string"
        },
        "relation_type": {
          "type": "object",
          "properties": {
            "alias": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          },
          "required": [
            "alias",
            "name"
          ]
        },
        "relation_field": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "name": {
              "type": "string"
            },
            "position": {
              "type": "number"
            },
            "alias": {
              "type": "string"
            },
            "has_unique_data": {
              "type": "boolean",
              "description": "whether field requires values to be unique across system"
            },
            "has_value": {
              "type": "boolean",
              "description": "whether field has at least one value submitted"
            },
            "removable": {
              "type": "boolean",
              "description": "whether field can be removed from system"
            },
            "is_active": {
              "type": "boolean"
            },
            "list": {
              "type": "boolean",
              "description": "whether field can handle collection of values"
            },
            "read_only": {
              "type": "boolean",
              "description": "whether field value can be changed"
            },
            "required": {
              "type": "boolean",
              "description": "deprecated setting"
            },
            "user_required": {
              "type": "boolean",
              "description": "whether field value required by user"
            },
            "system_required": {
              "type": "boolean",
              "description": "whether field value required by system"
            },
            "type": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number"
                },
                "name": {
                  "type": "string"
                },
                "alias": {
                  "type": "string"
                },
                "settings": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "number"
                      },
                      "name": {
                        "type": "string"
                      },
                      "alias": {
                        "type": "string"
                      },
                      "is_required": {
                        "type": "boolean"
                      }
                    },
                    "required": [
                      "id",
                      "name",
                      "alias",
                      "is_required"
                    ]
                  }
                },
                "supports_collection": {
                  "type": "boolean"
                },
                "supports_read_only": {
                  "type": "boolean"
                },
                "supports_unique": {
                  "type": "boolean"
                }
              },
              "required": [
                "id",
                "name",
                "alias",
                "settings",
                "supports_collection",
                "supports_read_only",
                "supports_unique"
              ],
              "additionalProperties": false
            },
            "category": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number"
                },
                "alias": {
                  "type": "string"
                },
                "position": {
                  "type": "number"
                },
                "system_required": {
                  "type": "boolean"
                },
                "name": {
                  "type": "string"
                },
                "description": {
                  "type": "string"
                },
                "is_active": {
                  "type": "boolean"
                },
                "pso_type": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "number"
                    },
                    "name": {
                      "type": "string"
                    },
                    "alias": {
                      "type": "string"
                    },
                    "description": {
                      "type": "string"
                    },
                    "is_active": {
                      "type": "boolean"
                    },
                    "system_required": {
                      "type": "boolean"
                    },
                    "creation_form_instance_id": {
                      "type": "number"
                    },
                    "profile_form_instance_id": {
                      "type": "number"
                    }
                  },
                  "required": [
                    "id",
                    "name",
                    "alias",
                    "description",
                    "is_active",
                    "system_required",
                    "creation_form_instance_id",
                    "profile_form_instance_id"
                  ],
                  "additionalProperties": false,
                  "description": "Presented only if `include` was send"
                }
              },
              "required": [
                "id",
                "alias",
                "position",
                "system_required",
                "name",
                "description",
                "is_active"
              ],
              "additionalProperties": false
            },
            "domains": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "number"
                  },
                  "alias": {
                    "type": "string"
                  },
                  "name": {
                    "type": "string"
                  },
                  "description": {
                    "type": "string"
                  },
                  "is_editable": {
                    "type": "boolean"
                  },
                  "is_removable": {
                    "type": "boolean"
                  },
                  "is_active": {
                    "type": "boolean"
                  },
                  "pso_type": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "number"
                      },
                      "name": {
                        "type": "string"
                      },
                      "alias": {
                        "type": "string"
                      },
                      "description": {
                        "type": "string"
                      },
                      "is_active": {
                        "type": "boolean"
                      },
                      "system_required": {
                        "type": "boolean"
                      },
                      "creation_form_instance_id": {
                        "type": "number"
                      },
                      "profile_form_instance_id": {
                        "type": "number"
                      }
                    },
                    "required": [
                      "id",
                      "name",
                      "alias",
                      "description",
                      "is_active",
                      "system_required",
                      "creation_form_instance_id",
                      "profile_form_instance_id"
                    ],
                    "additionalProperties": false
                  }
                },
                "required": [
                  "id",
                  "alias",
                  "name",
                  "description",
                  "is_editable",
                  "is_removable",
                  "is_active"
                ]
              }
            },
            "privacy_level": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number"
                },
                "alias": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "level": {
                  "type": "number"
                }
              },
              "required": [
                "id",
                "alias",
                "name",
                "level"
              ],
              "additionalProperties": false
            },
            "pso_type": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number"
                },
                "name": {
                  "type": "string"
                },
                "alias": {
                  "type": "string"
                },
                "description": {
                  "type": "string"
                },
                "is_active": {
                  "type": "boolean"
                },
                "system_required": {
                  "type": "boolean"
                },
                "creation_form_instance_id": {
                  "type": "number"
                },
                "profile_form_instance_id": {
                  "type": "number"
                }
              },
              "required": [
                "id",
                "name",
                "alias",
                "description",
                "is_active",
                "system_required",
                "creation_form_instance_id",
                "profile_form_instance_id"
              ],
              "additionalProperties": false
            },
            "items": {
              "type": [
                "array",
                "null"
              ],
              "items": {
                "type": "object",
                "properties": {}
              }
            },
            "options": {
              "type": [
                "array",
                "null"
              ],
              "items": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "number"
                  },
                  "name": {
                    "type": "string"
                  },
                  "position": {
                    "type": "number"
                  },
                  "value": {
                    "type": "string"
                  },
                  "is_active": {
                    "type": "boolean"
                  },
                  "is_selectable": {
                    "type": "boolean",
                    "description": "Can select on front this option (Using only in Hierarchy field))"
                  }
                },
                "required": [
                  "id",
                  "name",
                  "position",
                  "value",
                  "is_active",
                  "is_selectable"
                ]
              },
              "description": "List of options with possible (allowed) values."
            },
            "settings": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "description": "Common field settings"
            },
            "validation": {
              "type": "object",
              "properties": {
                "type": {
                  "type": "string"
                },
                "attributes": {
                  "type": "object",
                  "properties": {}
                },
                "value_example": {
                  "type": "string"
                },
                "error_message": {
                  "type": "object",
                  "properties": {
                    "en": {
                      "type": "string"
                    },
                    "fr": {
                      "type": "string"
                    },
                    "de": {
                      "type": "string"
                    },
                    "es": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "en",
                    "fr",
                    "de",
                    "es"
                  ]
                }
              },
              "required": [
                "type",
                "value_example",
                "error_message"
              ]
            },
            "has_autocomplete_settings": {
              "type": "boolean"
            },
            "autocomplete_settings": {
              "type": "object",
              "properties": {
                "allow_extra_values": {
                  "type": "boolean"
                },
                "autofill": {
                  "type": "boolean"
                },
                "provider": {
                  "type": "object",
                  "properties": {
                    "name": {
                      "type": "object",
                      "properties": {
                        "en": {
                          "type": "string"
                        },
                        "fr": {
                          "type": "string"
                        },
                        "de": {
                          "type": "string"
                        },
                        "es": {
                          "type": "string"
                        }
                      },
                      "required": [
                        "en",
                        "fr",
                        "de",
                        "es"
                      ]
                    },
                    "alias": {
                      "type": "string"
                    },
                    "base_url": {
                      "type": "string"
                    },
                    "single_value_supported": {
                      "type": "boolean"
                    },
                    "parameters": {
                      "type": "array"
                    }
                  },
                  "required": [
                    "name",
                    "alias",
                    "base_url",
                    "single_value_supported",
                    "parameters"
                  ]
                },
                "parameters": {
                  "type": "array"
                }
              },
              "required": [
                "allow_extra_values",
                "autofill",
                "provider",
                "parameters"
              ]
            }
          },
          "required": [
            "id",
            "name",
            "position",
            "alias",
            "has_unique_data",
            "has_value",
            "removable",
            "is_active",
            "list",
            "read_only",
            "required",
            "user_required",
            "system_required",
            "validation",
            "has_autocomplete_settings",
            "autocomplete_settings"
          ]
        },
        "assignment_rules": {
          "type": "array"
        },
        "domains": {
          "type": "object",
          "properties": {
            "includes": {
              "type": "array"
            },
            "excludes": {
              "type": "array"
            }
          },
          "required": [
            "includes",
            "excludes"
          ]
        },
        "privacy_level": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "alias": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "level": {
              "type": "number"
            }
          },
          "required": [
            "id",
            "alias",
            "name",
            "level"
          ]
        },
        "pso_type": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "name": {
              "type": "string"
            },
            "alias": {
              "type": "string"
            },
            "description": {
              "type": "string"
            },
            "is_active": {
              "type": "boolean"
            },
            "system_required": {
              "type": "boolean"
            },
            "creation_form_instance_id": {
              "type": "number"
            },
            "profile_form_instance_id": {
              "type": "number"
            }
          },
          "required": [
            "id",
            "name",
            "alias",
            "description",
            "is_active",
            "system_required",
            "creation_form_instance_id",
            "profile_form_instance_id"
          ]
        }
      },
      "required": [
        "id",
        "alias",
        "name",
        "description",
        "is_active",
        "status",
        "assignment_mode",
        "permissions",
        "relation",
        "relation_type",
        "domains",
        "privacy_level"
      ]
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/field-access-rules/{alias}

Update field access rule

Example URI

PATCH https://rest.monportailrh.com/field-access-rules/role_alias
URI Parameters
HideShow
alias
string (required) Example: role_alias

alias of the rolex

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Body
{
  "name": {
    "en": "Some text",
    "fr": "Du texte",
    "de": "Setwas Text",
    "es": "Algún texto"
  },
  "description": {
    "en": "Some text",
    "fr": "Du texte",
    "de": "Setwas Text",
    "es": "Algún texto"
  },
  "pso_type": "usr",
  "assignment_rules": [
    {
      "assignee": {
        "type": "all",
        "details": {}
      },
      "population": {
        "type": "all",
        "details": {}
      }
    }
  ],
  "field_access_rules": {
    "domains": {
      "includes": [
        "domain_alias"
      ],
      "excludes": [
        "domain_alias"
      ]
    },
    "privacy_level": "public"
  },
  "modules": [
    {
      "id": 1,
      "permissions": {
        "access": true,
        "synchronisation": false
      }
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "object",
      "properties": {
        "en": {
          "type": "string"
        },
        "fr": {
          "type": "string"
        },
        "de": {
          "type": "string"
        },
        "es": {
          "type": "string"
        }
      },
      "required": [
        "en",
        "fr",
        "de",
        "es"
      ]
    },
    "description": {
      "type": "object",
      "properties": {
        "en": {
          "type": "string"
        },
        "fr": {
          "type": "string"
        },
        "de": {
          "type": "string"
        },
        "es": {
          "type": "string"
        }
      },
      "required": [
        "en",
        "fr",
        "de",
        "es"
      ]
    },
    "pso_type": {
      "type": "string"
    },
    "assignment_rules": {
      "type": "array"
    },
    "field_access_rules": {
      "type": "object",
      "properties": {
        "domains": {
          "type": "object",
          "properties": {
            "includes": {
              "type": "array"
            },
            "excludes": {
              "type": "array"
            }
          },
          "required": [
            "includes",
            "excludes"
          ]
        },
        "privacy_level": {
          "type": "string"
        }
      },
      "required": [
        "domains",
        "privacy_level"
      ]
    },
    "modules": {
      "type": "array"
    }
  },
  "required": [
    "pso_type",
    "assignment_rules",
    "field_access_rules"
  ]
}
Response  202
HideShow
Headers
Content-Type: application/json
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 400
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete
DELETE/field-access-rules/{alias}

Remove specified field access rule

Example URI

DELETE https://rest.monportailrh.com/field-access-rules/role_alias
URI Parameters
HideShow
alias
string (required) Example: role_alias

alias of the role

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Response  204
HideShow
Headers
Content-Type: application/json
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 400
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Feature access

Feature access provide users with access permissions (features) to different parts of system.

Management permissions

  • roles.view - ability to view single and list of Feature Access

  • roles.create - ability to create new roles in system

  • roles.edit - ability to edit existing in system roles

  • roles.delete - ability to remove existing in system roles

Feature Access Rules

Common List
GET/feature-access-rules{?name,active,include,page,per-page,no-pagination}

Get list of Feature Access rules matches specified filters

Example URI

GET https://rest.monportailrh.com/feature-access-rules?name=name of role to search by&active=true&include=modules&page=1&per-page=10&no-pagination=false
URI Parameters
HideShow
name
string (optional) Example: name of role to search by
active
boolean (optional) Example: true
pso
string (required) 

type: pso type alias usr (string, optional)

include
string (optional) Example: modules

The way to include relations in the response. Target relations can be comma separated if you want to get few of them

sort
string (required) 

direction: asc (enum[asc, desc])

page
number (required) Example: 1

Page number. 1 by default

per-page
number (required) Example: 10

Number of items per page, 25 by default

no-pagination
boolean (required) Example: false

if presented and positive pagination will not be applied. All available items will be returned.

Note: it may have significant impact on the performance

Note: once this option positive and presented - meta attribute with pagination data will be omit in response

Request
HideShow
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": 1,
      "alias": "role_alias",
      "name": "Role Name",
      "description": "Role Description",
      "is_active": true,
      "status": "ok",
      "permissions": {
        "can_edit": true,
        "can_delete": true
      },
      "population": {
        "type": "all",
        "details": {}
      }
    }
  ],
  "meta": {
    "pagination": {
      "total": 238,
      "count": 25,
      "per_page": 25,
      "current_page": 2,
      "total_pages": 10,
      "links": {
        "previous": "http://example.com/api/<endpoint>?page=1",
        "next": "http://example.com/api/<endpoint>?page=3"
      }
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number"
          },
          "alias": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "is_active": {
            "type": "boolean"
          },
          "status": {
            "type": "string",
            "enum": [
              "ok",
              "pending",
              "processing",
              "conflict",
              "failed"
            ]
          },
          "permissions": {
            "type": "object",
            "properties": {
              "can_edit": {
                "type": "boolean"
              },
              "can_delete": {
                "type": "boolean"
              }
            },
            "required": [
              "can_edit",
              "can_delete"
            ]
          },
          "population": {
            "type": "object",
            "properties": {
              "type": {
                "type": "string",
                "enum": [
                  "all",
                  "user",
                  "group"
                ]
              },
              "details": {
                "type": "object",
                "properties": {}
              }
            },
            "required": [
              "type",
              "details"
            ]
          }
        },
        "required": [
          "id",
          "alias",
          "name",
          "description",
          "is_active",
          "status",
          "permissions",
          "population"
        ]
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number"
            },
            "count": {
              "type": "number"
            },
            "per_page": {
              "type": "number"
            },
            "current_page": {
              "type": "number"
            },
            "total_pages": {
              "type": "number"
            },
            "links": {
              "type": "object",
              "properties": {
                "previous": {
                  "type": "string"
                },
                "next": {
                  "type": "string"
                }
              },
              "required": [
                "previous",
                "next"
              ]
            }
          },
          "required": [
            "total",
            "count",
            "per_page",
            "current_page",
            "total_pages",
            "links"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "pagination"
      ]
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Create
POST/feature-access-rules

Create new Feature Access rule

Example URI

POST https://rest.monportailrh.com/feature-access-rules
Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Body
{
  "name": {
    "en": "Some text",
    "fr": "Du texte",
    "de": "Setwas Text",
    "es": "Algún texto"
  },
  "description": {
    "en": "Some text",
    "fr": "Du texte",
    "de": "Setwas Text",
    "es": "Algún texto"
  },
  "is_active": true,
  "population": {
    "type": "all",
    "details": {}
  },
  "features": [
    {
      "alias": "Feature",
      "items": [
        {
          "actions": [],
          "domains": {
            "includes": [
              "domain_alias"
            ],
            "excludes": [
              "domain_alias"
            ]
          },
          "pso_types": []
        }
      ]
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "object",
      "properties": {
        "en": {
          "type": "string"
        },
        "fr": {
          "type": "string"
        },
        "de": {
          "type": "string"
        },
        "es": {
          "type": "string"
        }
      },
      "required": [
        "en",
        "fr",
        "de",
        "es"
      ]
    },
    "description": {
      "type": "object",
      "properties": {
        "en": {
          "type": "string"
        },
        "fr": {
          "type": "string"
        },
        "de": {
          "type": "string"
        },
        "es": {
          "type": "string"
        }
      },
      "required": [
        "en",
        "fr",
        "de",
        "es"
      ]
    },
    "is_active": {
      "type": "boolean"
    },
    "population": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "all",
            "user",
            "group"
          ]
        },
        "details": {
          "type": "object",
          "properties": {}
        }
      },
      "required": [
        "type",
        "details"
      ]
    },
    "features": {
      "type": "array"
    }
  },
  "required": [
    "name",
    "is_active",
    "population",
    "features"
  ]
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 1,
  "alias": "feature"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "alias": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "alias"
  ]
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 400
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/feature-access-rules/{alias}/{?include}

Get details for selected Feature Access rule

Example URI

GET https://rest.monportailrh.com/feature-access-rules/role_alias/?include=modules,features
URI Parameters
HideShow
alias
string (required) Example: role_alias

alias of the role

include
string (optional) Example: modules,features

The way to include relations in the response. Target relations can be comma separated if you want to get few of them

Request
HideShow
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 1,
    "alias": "role_alias",
    "pso_type": {
      "id": 1,
      "alias": "usr",
      "name": "User"
    },
    "name": "Role Name",
    "description": "Role Description",
    "is_active": true,
    "status": "ok",
    "permissions": {
      "can_edit": true,
      "can_delete": true
    },
    "population": {
      "type": "all",
      "details": {}
    },
    "features": [
      {
        "alias": "Feature",
        "name": "Feature Name",
        "pso_type_specific": true,
        "action_specific": true,
        "domain_specific": true,
        "items": [
          {
            "actions": [
              {
                "id": 0,
                "name": "Action name",
                "alias": "alias"
              }
            ],
            "domains": {
              "includes": [
                {
                  "id": 46,
                  "alias": "usr_global",
                  "name": "User Global",
                  "description": "...",
                  "is_editable": false,
                  "is_removable": false,
                  "is_active": true,
                  "pso_type": {
                    "id": 56,
                    "name": "User",
                    "alias": "usr",
                    "description": "...",
                    "is_active": true,
                    "system_required": true,
                    "creation_form_instance_id": 1,
                    "profile_form_instance_id": 1
                  }
                }
              ],
              "excludes": [
                {
                  "id": 46,
                  "alias": "usr_global",
                  "name": "User Global",
                  "description": "...",
                  "is_editable": false,
                  "is_removable": false,
                  "is_active": true,
                  "pso_type": {
                    "id": 56,
                    "name": "User",
                    "alias": "usr",
                    "description": "...",
                    "is_active": true,
                    "system_required": true,
                    "creation_form_instance_id": 1,
                    "profile_form_instance_id": 1
                  }
                }
              ]
            },
            "pso_types": [
              {
                "id": 0,
                "name": "Always all types",
                "alias": "alias"
              }
            ]
          }
        ],
        "available_actions": [
          {
            "name": "Action Name",
            "alias": "action_alias"
          }
        ]
      }
    ]
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "alias": {
          "type": "string"
        },
        "pso_type": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "alias": {
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          },
          "required": [
            "id",
            "alias",
            "name"
          ]
        },
        "name": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "is_active": {
          "type": "boolean"
        },
        "status": {
          "type": "string",
          "enum": [
            "ok",
            "pending",
            "processing",
            "conflict",
            "failed"
          ]
        },
        "permissions": {
          "type": "object",
          "properties": {
            "can_edit": {
              "type": "boolean"
            },
            "can_delete": {
              "type": "boolean"
            }
          },
          "required": [
            "can_edit",
            "can_delete"
          ]
        },
        "population": {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "enum": [
                "all",
                "user",
                "group"
              ]
            },
            "details": {
              "type": "object",
              "properties": {}
            }
          },
          "required": [
            "type",
            "details"
          ]
        },
        "features": {
          "type": "array"
        }
      },
      "required": [
        "id",
        "alias",
        "pso_type",
        "name",
        "description",
        "is_active",
        "status",
        "permissions",
        "population",
        "features"
      ]
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/feature-access-rules/{alias}

Update Feature Access rule

Example URI

PATCH https://rest.monportailrh.com/feature-access-rules/role_alias
URI Parameters
HideShow
alias
string (required) Example: role_alias

alias of the rolex

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Body
{
  "name": {
    "en": "Some text",
    "fr": "Du texte",
    "de": "Setwas Text",
    "es": "Algún texto"
  },
  "description": {
    "en": "Some text",
    "fr": "Du texte",
    "de": "Setwas Text",
    "es": "Algún texto"
  },
  "is_active": true,
  "population": {
    "type": "all",
    "details": {}
  },
  "features": [
    {
      "alias": "Feature",
      "items": [
        {
          "actions": [],
          "domains": {
            "includes": [
              "domain_alias"
            ],
            "excludes": [
              "domain_alias"
            ]
          },
          "pso_types": []
        }
      ]
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "object",
      "properties": {
        "en": {
          "type": "string"
        },
        "fr": {
          "type": "string"
        },
        "de": {
          "type": "string"
        },
        "es": {
          "type": "string"
        }
      },
      "required": [
        "en",
        "fr",
        "de",
        "es"
      ]
    },
    "description": {
      "type": "object",
      "properties": {
        "en": {
          "type": "string"
        },
        "fr": {
          "type": "string"
        },
        "de": {
          "type": "string"
        },
        "es": {
          "type": "string"
        }
      },
      "required": [
        "en",
        "fr",
        "de",
        "es"
      ]
    },
    "is_active": {
      "type": "boolean"
    },
    "population": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "all",
            "user",
            "group"
          ]
        },
        "details": {
          "type": "object",
          "properties": {}
        }
      },
      "required": [
        "type",
        "details"
      ]
    },
    "features": {
      "type": "array"
    }
  },
  "required": [
    "name",
    "is_active",
    "population",
    "features"
  ]
}
Response  202
HideShow
Headers
Content-Type: application/json
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 400
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete
DELETE/feature-access-rules/{alias}

Remove specified Feature Access rule

Example URI

DELETE https://rest.monportailrh.com/feature-access-rules/role_alias
URI Parameters
HideShow
alias
string (required) Example: role_alias

alias of the role

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Response  204
HideShow
Headers
Content-Type: application/json
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 400
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Features

Field access provide users with access permissions to psos fields.

Management permissions

  • roles.view - ability to view single and list of feature list

Field Access Rules

Common List
GET/features{?name,page,per-page,no-pagination}

Get list of Feature Access rules matches specified filters

Example URI

GET https://rest.monportailrh.com/features?name=name of role to search by&page=1&per-page=10&no-pagination=false
URI Parameters
HideShow
name
string (optional) Example: name of role to search by
page
number (required) Example: 1

Page number. 1 by default

per-page
number (required) Example: 10

Number of items per page, 25 by default

no-pagination
boolean (required) Example: false

if presented and positive pagination will not be applied. All available items will be returned.

Note: it may have significant impact on the performance

Note: once this option positive and presented - meta attribute with pagination data will be omit in response

Request
HideShow
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "alias": "Feature",
      "name": "Feature Name",
      "pso_type_specific": true,
      "action_specific": true,
      "domain_specific": true,
      "available_actions": [
        {
          "name": "Action Name",
          "alias": "action_alias"
        }
      ]
    }
  ],
  "meta": {
    "pagination": {
      "total": 238,
      "count": 25,
      "per_page": 25,
      "current_page": 2,
      "total_pages": 10,
      "links": {
        "previous": "http://example.com/api/<endpoint>?page=1",
        "next": "http://example.com/api/<endpoint>?page=3"
      }
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "alias": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "pso_type_specific": {
            "type": "boolean"
          },
          "action_specific": {
            "type": "boolean"
          },
          "domain_specific": {
            "type": "boolean"
          },
          "available_actions": {
            "type": "array"
          }
        },
        "required": [
          "alias"
        ]
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number"
            },
            "count": {
              "type": "number"
            },
            "per_page": {
              "type": "number"
            },
            "current_page": {
              "type": "number"
            },
            "total_pages": {
              "type": "number"
            },
            "links": {
              "type": "object",
              "properties": {
                "previous": {
                  "type": "string"
                },
                "next": {
                  "type": "string"
                }
              },
              "required": [
                "previous",
                "next"
              ]
            }
          },
          "required": [
            "total",
            "count",
            "per_page",
            "current_page",
            "total_pages",
            "links"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "pagination"
      ]
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Sensitivities

Triggers

Triggers items.

Triggers

List
GET/triggers{?include,name,type,active,sort-by,sort-direction,page,per-page}

Fetch list of triggers

Example URI

GET https://rest.monportailrh.com/triggers?include=conditions,handlers&name=Triggers to search&type=plain&active=Triggers status&sort-by=title&sort-direction=asc&page=1&per-page=25
URI Parameters
HideShow
name
string (optional) Example: Triggers to search

Search by triggers title. Non strict, case-insensitive.

type
plain, pso (optional) Example: plain

Filter by triggers type.

active
bool (optional) Example: Triggers status

Filter by triggers active status.

sort-by
publish-date, title (optional) Default: publish-date Example: title

Field to sort triggers by.

sort-direction
asc, desc (optional) Default: desc Example: asc

Direction to order triggers by.

page
integer (optional) Example: 1
  • Page of results
per-page
integer (optional) Example: 25
  • Triggers per page
include
string (optional) Example: conditions,handlers

Comma separated list of related resources that will be included into response.

Possible values:

  • conditions

  • handlers

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "id": 1,
      "name Trigger title": "",
      "description Some text": "",
      "pso_type": 1,
      "start_at": "2019-04-24 11:47:47",
      "till_at": "2019-04-24 11:47:47",
      "executed_at": "2019-04-24 11:47:47",
      "frequency": "daily",
      "is_active": true,
      "created_at": "2019-04-24 11:47:47",
      "updated_at": "2019-04-24 11:47:47",
      "conditions": [
        {
          "type": "group",
          "combine_with": "and",
          "conditions": [
            {
              "type": "condition",
              "field": "usr_email",
              "raw_value": "john.doe@example.com",
              "operator": "=="
            }
          ]
        }
      ],
      "handlers": [
        {
          "id": 1,
          "type": "notification",
          "population": [
            {
              "type": "group",
              "details": {
                "dynamic": false,
                "includes": [
                  "group_a"
                ],
                "excludes": [
                  "group_b",
                  "group_c"
                ]
              }
            }
          ],
          "payload": {}
        }
      ]
    }
  ],
  "meta": {
    "pagination": {
      "total": 238,
      "count": 25,
      "per_page": 25,
      "current_page": 2,
      "total_pages": 10,
      "links": {
        "previous": "http://example.com/api/<endpoint>?page=1",
        "next": "http://example.com/api/<endpoint>?page=3"
      }
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number"
          },
          "name Trigger title": {
            "type": "string"
          },
          "description Some text": {
            "type": "string"
          },
          "pso_type": {
            "type": "number"
          },
          "start_at": {
            "type": "string"
          },
          "till_at": {
            "type": "string"
          },
          "executed_at": {
            "type": "string"
          },
          "frequency": {
            "type": "string"
          },
          "is_active": {
            "type": "boolean"
          },
          "created_at": {
            "type": "string"
          },
          "updated_at": {
            "type": "string"
          },
          "conditions": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "type": {
                  "type": "string",
                  "enum": [
                    "group"
                  ]
                },
                "combine_with": {
                  "type": "string",
                  "enum": [
                    "and",
                    "or"
                  ]
                },
                "conditions": {
                  "type": "array"
                }
              },
              "required": [
                "type",
                "combine_with",
                "conditions"
              ]
            }
          },
          "handlers": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number"
                },
                "type": {
                  "type": "string",
                  "enum": [
                    "notification",
                    "action_todo",
                    "action_schedule",
                    "field_modification",
                    "form_assignment"
                  ]
                },
                "population": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "type": {
                        "type": "string",
                        "enum": [
                          "all",
                          "group",
                          "pso",
                          "relation",
                          "self"
                        ]
                      },
                      "details": {
                        "anyOf": [
                          {
                            "type": "object",
                            "properties": {
                              "dynamic": {
                                "type": "boolean"
                              },
                              "includes": {
                                "type": "array"
                              },
                              "excludes": {
                                "type": "array"
                              }
                            },
                            "required": [
                              "dynamic",
                              "includes",
                              "excludes"
                            ]
                          },
                          {
                            "type": "array",
                            "enum": [
                              [],
                              []
                            ]
                          }
                        ],
                        "type": "null"
                      }
                    },
                    "required": [
                      "type",
                      "details"
                    ]
                  }
                },
                "payload": {
                  "type": "object",
                  "properties": {},
                  "additionalProperties": false
                }
              },
              "required": [
                "id",
                "type"
              ]
            }
          }
        },
        "required": [
          "id",
          "name Trigger title",
          "description Some text",
          "pso_type",
          "start_at",
          "till_at",
          "executed_at",
          "frequency",
          "is_active",
          "created_at",
          "updated_at"
        ]
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number"
            },
            "count": {
              "type": "number"
            },
            "per_page": {
              "type": "number"
            },
            "current_page": {
              "type": "number"
            },
            "total_pages": {
              "type": "number"
            },
            "links": {
              "type": "object",
              "properties": {
                "previous": {
                  "type": "string"
                },
                "next": {
                  "type": "string"
                }
              },
              "required": [
                "previous",
                "next"
              ]
            }
          },
          "required": [
            "total",
            "count",
            "per_page",
            "current_page",
            "total_pages",
            "links"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "pagination"
      ]
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Create
POST/triggers

Create new trigger entry

Most part of properties are simple and described in JSON schema. But there are 2 properties (conditions and handlers) that need to be explained.

Conditions

Condition uses to describe rules that will be applied as filers on trigger execution.

Condition can be of 2 types - group and condition itself

Group

It should be used to combine set of conditions with logical operator (or, and)

Example

{
    "type": "group",
    "combine_with": "and",
    "conditions": []
}

Condition

It should be used to describe the field based rule (filter)

Compare field value with raw value example

{
    "type": "condition",
    "field": "usr_email",
    "operator": "==",
    "raw_value": "john.doe@example.com"
}

Compare two field values example

{
    "type": "condition",
    "field": "usr_first_name",
    "operator": "==",
    "field_value": "usr_last_name"
}

Nesting conditions

Conditions and groups can be nested into each other to represent complex expressions

Example (usr_name == Foo or usr_email != xxx@example.com)

{
    "type": "group",
    "combine_with": "or",
    "conditions": [
        {
            "type": "condition",
            "field": "usr_name",
            "operator": "==",
            "raw_value": "Foo"        
        },     
        {
            "type": "condition",
            "field": "usr_email",
            "operator": "!=",
            "raw_value": "xxx@example.com"        
        }     
    ]
}

Example ((usr_name == Foo and usr_email != xxx@example.com) or usr_hired_at > 2010-01-12)

{
    "type": "group",
    "combine_with": "or",
    "conditions": [
        {
            "type": "group",
            "combine_with": "and",
            "conditions": [
                {
                    "type": "condition",
                    "field": "usr_name",
                    "operator": "==",
                    "raw_value": "Foo"        
                },     
                {
                    "type": "condition",
                    "field": "usr_email",
                    "operator": "!=",
                    "raw_value": "xxx@example.com"        
                }                 
            ]
        },
        {
            "type": "condition",
            "field": "usr_hired_at",
            "operator": ">",
            "raw_value": "2010-01-12"        
        }
    ]
}

Handlers

Each handler entry has:

  • type (determine payload structure and handling on server side). Allowed options:

    • notification
    • action_todo
    • action_schedule
    • field_modification
    • form_assignment
    • pso_deletion
    • data_deletion

  • population (describes PSO that will be used as population\recipient once trigger executed)

  • payload (additional info that depends on type)

Handler population

Population is array of different populations. Each kind of population item defined by type property. Available types:

  • all (all active PSOs of given type - see pso_type in main section)

  • group (specified groups)

  • pso (specific PSOs)

  • relation (self or alias of field with relation type)

Population items can be combined. So in population array we may have few entries with different types

Examples: For all type:

[
    {
        "type": "all",
        "details": null
    }
]

For self type:

[
    {
        "type": "self",
        "details": null
    }
]

For group type:

[
    {
      "type": "group",
      "details": {
        "dynamic": true,
        "includes": ["group_a", "group_b"],
        "excludes": ["group_c", "group_d"]
      }
    }
]

For pso type:

[
    {
      "type": "pso",
      "details": [123, 456]
    }
]

For relation type:

[
    {
      "type": "relation",
      "details": [
        "user",
        "manager",
        "..."
      ]
    }
]

Mixed types:

[
    {
      "type": "group",
      "details": {
        "dynamic": true,
        "includes": ["group_a", "group_b"],
        "excludes": ["group_c", "group_d"]
      }
    },
    {
      "type": "pso",
      "details": [123, 456]
    },
    {
      "type": "relation",
      "details": [
        "self",
        "manager",
        "..."
      ]
    }
]

Handler substitutions

Supports only for notification, action_todo, action_schedule handler types.

Substitutions is an array of variables that presented in title and message fields. And used to replace these variables in the text to data from trigger recipients (they described at Population section) or from psos found through conditions.

Variables from recipients:

syntax: {$<field_alias>}.

Variables from psos found through conditions:

syntax: {@usr_first_name}.

Example:

[
  "{$usr_first_name}",
  "{$usr_last_name}" 
]

Handler payload examples

For notification type

If the trigger has conditions and {@} variables in substitutions array.

All recipients are getting as many notifications as psos had found through conditions.

If no {@} variable in substitutions array, recipients are getting only one notification.

{
    "title": {
        "en": "...",
        "es": "...",
        "de": "...",
        "fr": "..."
    },
    "message": {
        "en": "...",
        "es": "...",
        "de": "...",
        "fr": "..."
    },
    "channels": [
        "web",
        "email"
    ],
    "raw_recipients": [
        "aaa@email.com",
        "bbb@email.com"
    ],
    "substitutions": [
        "{$usr_first_name}",
        "{$usr_last_name}",
        "{@usr_first_name}",
    ]
}

For action_todo type

If the trigger has conditions and {@} variables in substitutions array.

For each recipient will be created as many actions as psos had found through conditions.

If no {@} variable in substitutions array, only one action will be created for each recipient

{
    "title": {
        "en": "...",
        "es": "...",
        "de": "...",
        "fr": "..."
    },
    "message": {
        "en": "...",
        "es": "...",
        "de": "...",
        "fr": "..."
    },
    "due_date": "2019-02-34 12:34:56",
    "substitutions": [
        "{$usr_first_name}",
        "{$usr_last_name}",
        "{@usr_first_name}",
    ]
}

For action_schedule type

If the trigger has conditions and {@} variables in substitutions array.

For each recipient will be created as many actions as psos had found through conditions.

If no {@} variable in substitutions array, only one action will be created for each recipient

{
    "title": {
        "en": "...",
        "es": "...",
        "de": "...",
        "fr": "..."
    },
    "message": {
        "en": "...",
        "es": "...",
        "de": "...",
        "fr": "..."
    },
    "due_date": "2019-02-34 12:34:56",
    "substitutions": [
        "{$usr_first_name}",
        "{$usr_last_name}",
        "{@usr_first_name}",
    ]
}

For field_modification type

{
    "field": "xxx_field_alias",
    "expression": "new value"
}

For form_assignment type

{
    "title": {
        "en": "...",
        "es": "...",
        "de": "...",
        "fr": "..."
    },
    "description": {
        "en": "...",
        "es": "...",
        "de": "...",
        "fr": "..."
    },
    "form": 12345,
    "assignment_rules": {
        "type": "permanent|unique|periodic",
        "settings": [
            {
                "alias": "start_date",
                "value": "Y-m-d H:i:s"
            }
        ]
    }
}

For pso_deletion type

Should be "null" or even omitted

For data_deletion type

{
    "clear_history": clear_historyfalse,
    "fields": [
        'usr_field_a',
        'usr_field_b'
    ]
}

Example URI

POST https://rest.monportailrh.com/triggers
Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: '*'
Body
{
  "name": {
    "en": "Some text",
    "fr": "Du texte",
    "de": "Setwas Text",
    "es": "Algún texto"
  },
  "description": {
    "en": "Some text",
    "fr": "Du texte",
    "de": "Setwas Text",
    "es": "Algún texto"
  },
  "pso_type": "usr",
  "start_at": "2019-04-24 11:47:47",
  "till_at": "2019-04-24 11:47:47",
  "frequency": "daily",
  "is_active": true,
  "conditions": [
    {
      "type": "group",
      "combine_with": "and",
      "conditions": [
        {
          "type": "condition",
          "field": "usr_email",
          "raw_value": "john.doe@example.com",
          "operator": "=="
        }
      ]
    }
  ],
  "handlers": [
    {
      "id": 1,
      "type": "notification",
      "population": [
        {
          "type": "group",
          "details": {
            "dynamic": false,
            "includes": [
              "group_a"
            ],
            "excludes": [
              "group_b",
              "group_c"
            ]
          }
        }
      ],
      "payload": {}
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "object",
      "properties": {
        "en": {
          "type": "string"
        },
        "fr": {
          "type": "string"
        },
        "de": {
          "type": "string"
        },
        "es": {
          "type": "string"
        }
      },
      "required": [
        "en",
        "fr",
        "de",
        "es"
      ],
      "additionalProperties": false
    },
    "description": {
      "type": "object",
      "properties": {
        "en": {
          "type": "string"
        },
        "fr": {
          "type": "string"
        },
        "de": {
          "type": "string"
        },
        "es": {
          "type": "string"
        }
      },
      "required": [
        "en",
        "fr",
        "de",
        "es"
      ],
      "additionalProperties": false
    },
    "pso_type": {
      "type": "string"
    },
    "start_at": {
      "type": "string"
    },
    "till_at": {
      "type": "string"
    },
    "frequency": {
      "type": "string",
      "description": "can be one of: daily,weekly,monthly,yearly"
    },
    "is_active": {
      "type": "boolean"
    },
    "conditions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "group"
            ]
          },
          "combine_with": {
            "type": "string",
            "enum": [
              "and",
              "or"
            ]
          },
          "conditions": {
            "type": "array"
          }
        },
        "required": [
          "type",
          "combine_with",
          "conditions"
        ]
      }
    },
    "handlers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number"
          },
          "type": {
            "type": "string",
            "enum": [
              "notification",
              "action_todo",
              "action_schedule",
              "field_modification",
              "form_assignment"
            ]
          },
          "population": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "type": {
                  "type": "string",
                  "enum": [
                    "all",
                    "group",
                    "pso",
                    "relation",
                    "self"
                  ]
                },
                "details": {
                  "anyOf": [
                    {
                      "type": "object",
                      "properties": {
                        "dynamic": {
                          "type": "boolean"
                        },
                        "includes": {
                          "type": "array"
                        },
                        "excludes": {
                          "type": "array"
                        }
                      },
                      "required": [
                        "dynamic",
                        "includes",
                        "excludes"
                      ]
                    },
                    {
                      "type": "array",
                      "enum": [
                        [],
                        []
                      ]
                    }
                  ],
                  "type": "null"
                }
              },
              "required": [
                "type",
                "details"
              ]
            }
          },
          "payload": {
            "type": "object",
            "properties": {},
            "additionalProperties": false
          }
        },
        "required": [
          "id",
          "type"
        ]
      }
    }
  },
  "required": [
    "pso_type",
    "start_at",
    "till_at",
    "frequency",
    "is_active"
  ]
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 1,
    "name Trigger title": "",
    "description Some text": "",
    "pso_type": 1,
    "start_at": "2019-04-24 11:47:47",
    "till_at": "2019-04-24 11:47:47",
    "executed_at": "2019-04-24 11:47:47",
    "frequency": "daily",
    "is_active": true,
    "created_at": "2019-04-24 11:47:47",
    "updated_at": "2019-04-24 11:47:47",
    "conditions": [
      {
        "type": "group",
        "combine_with": "and",
        "conditions": [
          {
            "type": "condition",
            "field": "usr_email",
            "raw_value": "john.doe@example.com",
            "operator": "=="
          }
        ]
      }
    ],
    "handlers": [
      {
        "id": 1,
        "type": "notification",
        "population": [
          {
            "type": "group",
            "details": {
              "dynamic": false,
              "includes": [
                "group_a"
              ],
              "excludes": [
                "group_b",
                "group_c"
              ]
            }
          }
        ],
        "payload": {}
      }
    ]
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name Trigger title": {
          "type": "string"
        },
        "description Some text": {
          "type": "string"
        },
        "pso_type": {
          "type": "number"
        },
        "start_at": {
          "type": "string"
        },
        "till_at": {
          "type": "string"
        },
        "executed_at": {
          "type": "string"
        },
        "frequency": {
          "type": "string"
        },
        "is_active": {
          "type": "boolean"
        },
        "created_at": {
          "type": "string"
        },
        "updated_at": {
          "type": "string"
        },
        "conditions": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "type": {
                "type": "string",
                "enum": [
                  "group"
                ]
              },
              "combine_with": {
                "type": "string",
                "enum": [
                  "and",
                  "or"
                ]
              },
              "conditions": {
                "type": "array"
              }
            },
            "required": [
              "type",
              "combine_with",
              "conditions"
            ]
          }
        },
        "handlers": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number"
              },
              "type": {
                "type": "string",
                "enum": [
                  "notification",
                  "action_todo",
                  "action_schedule",
                  "field_modification",
                  "form_assignment"
                ]
              },
              "population": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "type": {
                      "type": "string",
                      "enum": [
                        "all",
                        "group",
                        "pso",
                        "relation",
                        "self"
                      ]
                    },
                    "details": {
                      "anyOf": [
                        {
                          "type": "object",
                          "properties": {
                            "dynamic": {
                              "type": "boolean"
                            },
                            "includes": {
                              "type": "array"
                            },
                            "excludes": {
                              "type": "array"
                            }
                          },
                          "required": [
                            "dynamic",
                            "includes",
                            "excludes"
                          ]
                        },
                        {
                          "type": "array",
                          "enum": [
                            [],
                            []
                          ]
                        }
                      ],
                      "type": "null"
                    }
                  },
                  "required": [
                    "type",
                    "details"
                  ]
                }
              },
              "payload": {
                "type": "object",
                "properties": {},
                "additionalProperties": false
              }
            },
            "required": [
              "id",
              "type"
            ]
          }
        }
      },
      "required": [
        "id",
        "name Trigger title",
        "description Some text",
        "pso_type",
        "start_at",
        "till_at",
        "executed_at",
        "frequency",
        "is_active",
        "created_at",
        "updated_at",
        "conditions",
        "handlers"
      ],
      "additionalProperties": false
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 400
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show
GET/triggers/{id}

Fetch single trigger item

Example URI

GET https://rest.monportailrh.com/triggers/query
URI Parameters
HideShow
id
number (required) Example: query

Id of the Trigger item.

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: '*'
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 1,
    "name Trigger title": "",
    "description Some text": "",
    "pso_type": 1,
    "start_at": "2019-04-24 11:47:47",
    "till_at": "2019-04-24 11:47:47",
    "executed_at": "2019-04-24 11:47:47",
    "frequency": "daily",
    "is_active": true,
    "created_at": "2019-04-24 11:47:47",
    "updated_at": "2019-04-24 11:47:47",
    "conditions": [
      {
        "type": "group",
        "combine_with": "and",
        "conditions": [
          {
            "type": "condition",
            "field": "usr_email",
            "raw_value": "john.doe@example.com",
            "operator": "=="
          }
        ]
      }
    ],
    "handlers": [
      {
        "id": 1,
        "type": "notification",
        "population": [
          {
            "type": "group",
            "details": {
              "dynamic": false,
              "includes": [
                "group_a"
              ],
              "excludes": [
                "group_b",
                "group_c"
              ]
            }
          }
        ],
        "payload": {}
      }
    ]
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name Trigger title": {
          "type": "string"
        },
        "description Some text": {
          "type": "string"
        },
        "pso_type": {
          "type": "number"
        },
        "start_at": {
          "type": "string"
        },
        "till_at": {
          "type": "string"
        },
        "executed_at": {
          "type": "string"
        },
        "frequency": {
          "type": "string"
        },
        "is_active": {
          "type": "boolean"
        },
        "created_at": {
          "type": "string"
        },
        "updated_at": {
          "type": "string"
        },
        "conditions": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "type": {
                "type": "string",
                "enum": [
                  "group"
                ]
              },
              "combine_with": {
                "type": "string",
                "enum": [
                  "and",
                  "or"
                ]
              },
              "conditions": {
                "type": "array"
              }
            },
            "required": [
              "type",
              "combine_with",
              "conditions"
            ]
          }
        },
        "handlers": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number"
              },
              "type": {
                "type": "string",
                "enum": [
                  "notification",
                  "action_todo",
                  "action_schedule",
                  "field_modification",
                  "form_assignment"
                ]
              },
              "population": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "type": {
                      "type": "string",
                      "enum": [
                        "all",
                        "group",
                        "pso",
                        "relation",
                        "self"
                      ]
                    },
                    "details": {
                      "anyOf": [
                        {
                          "type": "object",
                          "properties": {
                            "dynamic": {
                              "type": "boolean"
                            },
                            "includes": {
                              "type": "array"
                            },
                            "excludes": {
                              "type": "array"
                            }
                          },
                          "required": [
                            "dynamic",
                            "includes",
                            "excludes"
                          ]
                        },
                        {
                          "type": "array",
                          "enum": [
                            [],
                            []
                          ]
                        }
                      ],
                      "type": "null"
                    }
                  },
                  "required": [
                    "type",
                    "details"
                  ]
                }
              },
              "payload": {
                "type": "object",
                "properties": {},
                "additionalProperties": false
              }
            },
            "required": [
              "id",
              "type"
            ]
          }
        }
      },
      "required": [
        "id",
        "name Trigger title",
        "description Some text",
        "pso_type",
        "start_at",
        "till_at",
        "executed_at",
        "frequency",
        "is_active",
        "created_at",
        "updated_at",
        "conditions",
        "handlers"
      ],
      "additionalProperties": false
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete
DELETE/triggers/{id}

Delete trigger item

Example URI

DELETE https://rest.monportailrh.com/triggers/123
URI Parameters
HideShow
id
number (required) Example: 123

Id of the Trigger item.

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: '*'
Response  204
HideShow
Headers
Content-Type: application/json
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Update
PATCH/triggers/{id}

Update trigger item

Example URI

PATCH https://rest.monportailrh.com/triggers/123
URI Parameters
HideShow
id
number (required) Example: 123

Id of the trigger item.

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Body
{
  "name": {
    "en": "Some text",
    "fr": "Du texte",
    "de": "Setwas Text",
    "es": "Algún texto"
  },
  "description": {
    "en": "Some text",
    "fr": "Du texte",
    "de": "Setwas Text",
    "es": "Algún texto"
  },
  "pso_type": "usr",
  "start_at": "2019-04-24 11:47:47",
  "till_at": "2019-04-24 11:47:47",
  "frequency": "daily",
  "is_active": true,
  "conditions": [
    {
      "type": "group",
      "combine_with": "and",
      "conditions": [
        {
          "type": "condition",
          "field": "usr_email",
          "raw_value": "john.doe@example.com",
          "operator": "=="
        }
      ]
    }
  ],
  "handlers": [
    {
      "id": 1,
      "type": "notification",
      "population": [
        {
          "type": "group",
          "details": {
            "dynamic": false,
            "includes": [
              "group_a"
            ],
            "excludes": [
              "group_b",
              "group_c"
            ]
          }
        }
      ],
      "payload": {}
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "object",
      "properties": {
        "en": {
          "type": "string"
        },
        "fr": {
          "type": "string"
        },
        "de": {
          "type": "string"
        },
        "es": {
          "type": "string"
        }
      },
      "required": [
        "en",
        "fr",
        "de",
        "es"
      ],
      "additionalProperties": false
    },
    "description": {
      "type": "object",
      "properties": {
        "en": {
          "type": "string"
        },
        "fr": {
          "type": "string"
        },
        "de": {
          "type": "string"
        },
        "es": {
          "type": "string"
        }
      },
      "required": [
        "en",
        "fr",
        "de",
        "es"
      ],
      "additionalProperties": false
    },
    "pso_type": {
      "type": "string"
    },
    "start_at": {
      "type": "string"
    },
    "till_at": {
      "type": "string"
    },
    "frequency": {
      "type": "string",
      "description": "can be one of: daily,weekly,monthly,yearly"
    },
    "is_active": {
      "type": "boolean"
    },
    "conditions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "group"
            ]
          },
          "combine_with": {
            "type": "string",
            "enum": [
              "and",
              "or"
            ]
          },
          "conditions": {
            "type": "array"
          }
        },
        "required": [
          "type",
          "combine_with",
          "conditions"
        ]
      }
    },
    "handlers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number"
          },
          "type": {
            "type": "string",
            "enum": [
              "notification",
              "action_todo",
              "action_schedule",
              "field_modification",
              "form_assignment"
            ]
          },
          "population": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "type": {
                  "type": "string",
                  "enum": [
                    "all",
                    "group",
                    "pso",
                    "relation",
                    "self"
                  ]
                },
                "details": {
                  "anyOf": [
                    {
                      "type": "object",
                      "properties": {
                        "dynamic": {
                          "type": "boolean"
                        },
                        "includes": {
                          "type": "array"
                        },
                        "excludes": {
                          "type": "array"
                        }
                      },
                      "required": [
                        "dynamic",
                        "includes",
                        "excludes"
                      ]
                    },
                    {
                      "type": "array",
                      "enum": [
                        [],
                        []
                      ]
                    }
                  ],
                  "type": "null"
                }
              },
              "required": [
                "type",
                "details"
              ]
            }
          },
          "payload": {
            "type": "object",
            "properties": {},
            "additionalProperties": false
          }
        },
        "required": [
          "id",
          "type"
        ]
      }
    }
  }
}
Response  202
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 1,
    "name Trigger title": "",
    "description Some text": "",
    "pso_type": 1,
    "start_at": "2019-04-24 11:47:47",
    "till_at": "2019-04-24 11:47:47",
    "executed_at": "2019-04-24 11:47:47",
    "frequency": "daily",
    "is_active": true,
    "created_at": "2019-04-24 11:47:47",
    "updated_at": "2019-04-24 11:47:47",
    "conditions": [
      {
        "type": "group",
        "combine_with": "and",
        "conditions": [
          {
            "type": "condition",
            "field": "usr_email",
            "raw_value": "john.doe@example.com",
            "operator": "=="
          }
        ]
      }
    ],
    "handlers": [
      {
        "id": 1,
        "type": "notification",
        "population": [
          {
            "type": "group",
            "details": {
              "dynamic": false,
              "includes": [
                "group_a"
              ],
              "excludes": [
                "group_b",
                "group_c"
              ]
            }
          }
        ],
        "payload": {}
      }
    ]
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name Trigger title": {
          "type": "string"
        },
        "description Some text": {
          "type": "string"
        },
        "pso_type": {
          "type": "number"
        },
        "start_at": {
          "type": "string"
        },
        "till_at": {
          "type": "string"
        },
        "executed_at": {
          "type": "string"
        },
        "frequency": {
          "type": "string"
        },
        "is_active": {
          "type": "boolean"
        },
        "created_at": {
          "type": "string"
        },
        "updated_at": {
          "type": "string"
        },
        "conditions": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "type": {
                "type": "string",
                "enum": [
                  "group"
                ]
              },
              "combine_with": {
                "type": "string",
                "enum": [
                  "and",
                  "or"
                ]
              },
              "conditions": {
                "type": "array"
              }
            },
            "required": [
              "type",
              "combine_with",
              "conditions"
            ]
          }
        },
        "handlers": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number"
              },
              "type": {
                "type": "string",
                "enum": [
                  "notification",
                  "action_todo",
                  "action_schedule",
                  "field_modification",
                  "form_assignment"
                ]
              },
              "population": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "type": {
                      "type": "string",
                      "enum": [
                        "all",
                        "group",
                        "pso",
                        "relation",
                        "self"
                      ]
                    },
                    "details": {
                      "anyOf": [
                        {
                          "type": "object",
                          "properties": {
                            "dynamic": {
                              "type": "boolean"
                            },
                            "includes": {
                              "type": "array"
                            },
                            "excludes": {
                              "type": "array"
                            }
                          },
                          "required": [
                            "dynamic",
                            "includes",
                            "excludes"
                          ]
                        },
                        {
                          "type": "array",
                          "enum": [
                            [],
                            []
                          ]
                        }
                      ],
                      "type": "null"
                    }
                  },
                  "required": [
                    "type",
                    "details"
                  ]
                }
              },
              "payload": {
                "type": "object",
                "properties": {},
                "additionalProperties": false
              }
            },
            "required": [
              "id",
              "type"
            ]
          }
        }
      },
      "required": [
        "id",
        "name Trigger title",
        "description Some text",
        "pso_type",
        "start_at",
        "till_at",
        "executed_at",
        "frequency",
        "is_active",
        "created_at",
        "updated_at",
        "conditions",
        "handlers"
      ],
      "additionalProperties": false
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 400
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Scheduled Approvals

Scheduled Approvals items.

Scheduled Approvals

List
GET/scheduled-approvals{?expired,sort-by,sort-direction,include,page,per-page,no-pagination}

Fetch list of scheduled approvals

Example URI

GET https://rest.monportailrh.com/scheduled-approvals?expired=true&sort-by=author&sort-direction=asc&include=author&page=1&per-page=10&no-pagination=false
URI Parameters
HideShow
expired
boolean (optional) Default: false Example: true

Include expired approvals.

sort-by
form_instance, author, approval_scheduled_date, status (optional) Example: author

Field to sort by. If not provided will be sorted by creation date.

sort-direction
asc, desc (optional) Default: desc Example: asc

Direction to order approvals by.

include
string (optional) Example: author

Comma separated list of related resources that will be included into response. Possible values:

  • author

  • form_instance

page
number (required) Example: 1

Page number. 1 by default

per-page
number (required) Example: 10

Number of items per page, 25 by default

no-pagination
boolean (required) Example: false

if presented and positive pagination will not be applied. All available items will be returned.

Note: it may have significant impact on the performance

Note: once this option positive and presented - meta attribute with pagination data will be omit in response

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "uuid": "34425f31-d9f3-37bd-b90d-e5a7f7f85fc1",
      "status": "pending",
      "is_mass_edit": true,
      "approval_scheduled_date": "2019-04-24 11:47:47",
      "author": {
        "id": 1,
        "external_id": 1,
        "first_name": "John",
        "last_name": "Snow",
        "username": "john_snow",
        "professional_email": "jsnow@example.com",
        "professional_mobile_phone": "00 33 1 40 00 00 00",
        "professional_phone": "00 33 1 40 00 00 00",
        "role": [
          "bastard",
          "king"
        ],
        "is_active": true,
        "status": "remote",
        "settings": [
          "[]"
        ],
        "user_photo": "http://example.com/images/1.jpg"
      },
      "form_instance": {
        "id": 1,
        "name": {
          "en": "Some text",
          "fr": "Du texte",
          "de": "Setwas Text",
          "es": "Algún texto"
        },
        "description": {
          "en": "Some text",
          "fr": "Du texte",
          "de": "Setwas Text",
          "es": "Algún texto"
        },
        "form_id": 123,
        "is_active": true,
        "removable": false,
        "effective_date": "2019-04-24 11:47:47"
      },
      "scheduled_approvals": [
        {
          "id": 1,
          "status": "pending",
          "approval_scheduled_date": "2019-04-24 11:47:47",
          "pso": {
            "id": 1,
            "external_id": 1,
            "first_name": "John",
            "last_name": "Snow",
            "username": "john_snow",
            "professional_email": "jsnow@example.com",
            "professional_mobile_phone": "00 33 1 40 00 00 00",
            "professional_phone": "00 33 1 40 00 00 00",
            "role": [
              "bastard",
              "king"
            ],
            "is_active": true,
            "status": "remote",
            "settings": [
              "[]"
            ],
            "user_photo": "http://example.com/images/1.jpg"
          },
          "fields": [
            {
              "id": 1,
              "name": "Field Name",
              "position": 5,
              "alias": "usr_first_name",
              "has_unique_data": false,
              "has_value": true,
              "removable": false,
              "is_active": true,
              "list": false,
              "read_only": false,
              "required": true,
              "type": {
                "id": 1,
                "name": "Data Type Name",
                "alias": "data_type_alias",
                "settings": [
                  {
                    "id": 1,
                    "name": "Data Type Setting Name",
                    "alias": "data_type_setting_alias",
                    "is_required": true
                  }
                ],
                "supports_collection": false,
                "supports_read_only": false,
                "supports_unique": false
              },
              "category": {
                "id": 32,
                "alias": "usr_identity",
                "position": 5,
                "system_required": true,
                "name": "Identity",
                "description": "...",
                "is_active": true,
                "pso_type": {
                  "id": 56,
                  "name": "User",
                  "alias": "usr",
                  "description": "...",
                  "is_active": true,
                  "system_required": true,
                  "creation_form_instance_id": 1,
                  "profile_form_instance_id": 1
                }
              },
              "domains": [
                {
                  "id": 46,
                  "alias": "usr_global",
                  "name": "User Global",
                  "description": "...",
                  "is_editable": false,
                  "is_removable": false,
                  "is_active": true,
                  "pso_type": {
                    "id": 56,
                    "name": "User",
                    "alias": "usr",
                    "description": "...",
                    "is_active": true,
                    "system_required": true,
                    "creation_form_instance_id": 1,
                    "profile_form_instance_id": 1
                  }
                }
              ],
              "privacy_level": {
                "id": 123,
                "alias": "public",
                "name": "Not Sensitive",
                "level": 100
              },
              "pso_type": {
                "id": 56,
                "name": "User",
                "alias": "usr",
                "description": "...",
                "is_active": true,
                "system_required": true,
                "creation_form_instance_id": 1,
                "profile_form_instance_id": 1
              },
              "items": [
                {
                  "id": 1,
                  "name": "Field Name",
                  "position": 5,
                  "alias": "usr_first_name",
                  "has_unique_data": false,
                  "has_value": true,
                  "removable": false,
                  "is_active": true,
                  "list": false,
                  "read_only": false,
                  "required": true,
                  "user_required": true,
                  "system_required": true,
                  "type": {
                    "id": 1,
                    "name": "Data Type Name",
                    "alias": "data_type_alias",
                    "settings": [
                      {
                        "id": 1,
                        "name": "Data Type Setting Name",
                        "alias": "data_type_setting_alias",
                        "is_required": true
                      }
                    ],
                    "supports_collection": false,
                    "supports_read_only": false,
                    "supports_unique": false
                  },
                  "category": {
                    "id": 32,
                    "alias": "usr_identity",
                    "position": 5,
                    "system_required": true,
                    "name": "Identity",
                    "description": "...",
                    "is_active": true,
                    "pso_type": {
                      "id": 56,
                      "name": "User",
                      "alias": "usr",
                      "description": "...",
                      "is_active": true,
                      "system_required": true,
                      "creation_form_instance_id": 1,
                      "profile_form_instance_id": 1
                    }
                  },
                  "domains": [
                    {
                      "id": 46,
                      "alias": "usr_global",
                      "name": "User Global",
                      "description": "...",
                      "is_editable": false,
                      "is_removable": false,
                      "is_active": true,
                      "pso_type": {
                        "id": 56,
                        "name": "User",
                        "alias": "usr",
                        "description": "...",
                        "is_active": true,
                        "system_required": true,
                        "creation_form_instance_id": 1,
                        "profile_form_instance_id": 1
                      }
                    }
                  ],
                  "privacy_level": {
                    "id": 123,
                    "alias": "public",
                    "name": "Not Sensitive",
                    "level": 100
                  },
                  "pso_type": {
                    "id": 56,
                    "name": "User",
                    "alias": "usr",
                    "description": "...",
                    "is_active": true,
                    "system_required": true,
                    "creation_form_instance_id": 1,
                    "profile_form_instance_id": 1
                  },
                  "items": [
                    {}
                  ],
                  "options": [
                    {
                      "id": 198,
                      "name": "Choose me!",
                      "position": 9,
                      "value": "198",
                      "is_active": true,
                      "is_selectable": true
                    }
                  ],
                  "settings": [],
                  "validation": {
                    "type": "regexp",
                    "attributes": {},
                    "value_example": "string",
                    "error_message": {
                      "en": "Some text",
                      "fr": "Du texte",
                      "de": "Setwas Text",
                      "es": "Algún texto"
                    }
                  },
                  "has_autocomplete_settings": true,
                  "autocomplete_settings": {
                    "allow_extra_values": true,
                    "autofill": true,
                    "provider": {
                      "name": {
                        "en": "Some text",
                        "fr": "Du texte",
                        "de": "Setwas Text",
                        "es": "Algún texto"
                      },
                      "alias": "string",
                      "base_url": "https://exmaple.com/",
                      "single_value_supported": true,
                      "parameters": [
                        {
                          "name": "Name",
                          "key": "alias",
                          "required": true
                        }
                      ]
                    },
                    "parameters": [
                      {
                        "name": "Name",
                        "key": "alias",
                        "required": true,
                        "value": "value",
                        "field": {
                          "id": 1,
                          "name": "Field Name",
                          "alias": "usr_first_name",
                          "value": "RU",
                          "root_field": {
                            "id": 1,
                            "name": "Field Name",
                            "alias": "usr_first_name",
                            "value": "RU",
                            "root_field": "null"
                          }
                        }
                      }
                    ]
                  }
                }
              ],
              "options": [
                {
                  "id": 198,
                  "name": "Choose me!",
                  "position": 9,
                  "value": "198",
                  "is_active": true,
                  "is_selectable": true
                }
              ],
              "settings": [],
              "is_locked": false,
              "value_details": [
                "value1",
                "value2"
              ],
              "values_count": 2,
              "assignment_settings": [
                {
                  "setting": "public",
                  "value": "1"
                }
              ],
              "access_permissions": {
                "history": true,
                "view": true,
                "edit": true
              },
              "assignment_permissions": {
                "permissions": {
                  "id": 1,
                  "name": "View",
                  "alias": "view"
                },
                "access_list": [
                  "0",
                  "1",
                  "1"
                ]
              }
            }
          ]
        }
      ]
    }
  ],
  "meta": {
    "pagination": {
      "total": 238,
      "count": 25,
      "per_page": 25,
      "current_page": 2,
      "total_pages": 10,
      "links": {
        "previous": "http://example.com/api/<endpoint>?page=1",
        "next": "http://example.com/api/<endpoint>?page=3"
      }
    }
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "uuid": {
            "type": "string"
          },
          "status": {
            "type": "string",
            "enum": [
              "pending",
              "done",
              "failed"
            ]
          },
          "is_mass_edit": {
            "type": "boolean"
          },
          "approval_scheduled_date": {
            "type": "string"
          },
          "author": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number"
              },
              "external_id": {
                "type": "number"
              },
              "first_name": {
                "type": "string"
              },
              "last_name": {
                "type": "string"
              },
              "username": {
                "type": "string"
              },
              "professional_email": {
                "type": "string"
              },
              "professional_mobile_phone": {
                "type": "string"
              },
              "professional_phone": {
                "type": "string"
              },
              "role": {
                "type": "array"
              },
              "is_active": {
                "type": "boolean"
              },
              "status": {
                "type": "string"
              },
              "settings": {
                "type": "array"
              },
              "user_photo": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "external_id",
              "first_name",
              "last_name",
              "username",
              "professional_email",
              "professional_mobile_phone",
              "professional_phone",
              "role",
              "is_active",
              "status",
              "settings",
              "user_photo"
            ],
            "additionalProperties": false
          },
          "form_instance": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number"
              },
              "name": {
                "type": "object",
                "properties": {
                  "en": {
                    "type": "string"
                  },
                  "fr": {
                    "type": "string"
                  },
                  "de": {
                    "type": "string"
                  },
                  "es": {
                    "type": "string"
                  }
                },
                "required": [
                  "en",
                  "fr",
                  "de",
                  "es"
                ]
              },
              "description": {
                "type": "object",
                "properties": {
                  "en": {
                    "type": "string"
                  },
                  "fr": {
                    "type": "string"
                  },
                  "de": {
                    "type": "string"
                  },
                  "es": {
                    "type": "string"
                  }
                },
                "required": [
                  "en",
                  "fr",
                  "de",
                  "es"
                ]
              },
              "form_id": {
                "type": "number"
              },
              "is_active": {
                "type": "boolean"
              },
              "removable": {
                "type": "boolean"
              },
              "effective_date": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "name",
              "description",
              "form_id",
              "is_active",
              "removable",
              "effective_date"
            ],
            "additionalProperties": false
          },
          "scheduled_approvals": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number"
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "pending",
                    "done",
                    "failed"
                  ]
                },
                "approval_scheduled_date": {
                  "type": "string"
                },
                "pso": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "number"
                    },
                    "external_id": {
                      "type": "number"
                    },
                    "first_name": {
                      "type": "string"
                    },
                    "last_name": {
                      "type": "string"
                    },
                    "username": {
                      "type": "string"
                    },
                    "professional_email": {
                      "type": "string"
                    },
                    "professional_mobile_phone": {
                      "type": "string"
                    },
                    "professional_phone": {
                      "type": "string"
                    },
                    "role": {
                      "type": "array"
                    },
                    "is_active": {
                      "type": "boolean"
                    },
                    "status": {
                      "type": "string"
                    },
                    "settings": {
                      "type": "array"
                    },
                    "user_photo": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "id",
                    "external_id",
                    "first_name",
                    "last_name",
                    "username",
                    "professional_email",
                    "professional_mobile_phone",
                    "professional_phone",
                    "role",
                    "is_active",
                    "status",
                    "settings",
                    "user_photo"
                  ],
                  "additionalProperties": false
                },
                "fields": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "number"
                      },
                      "name": {
                        "type": "string"
                      },
                      "position": {
                        "type": "number"
                      },
                      "alias": {
                        "type": "string"
                      },
                      "has_unique_data": {
                        "type": "boolean",
                        "description": "whether field requires values to be unique across system"
                      },
                      "has_value": {
                        "type": "boolean",
                        "description": "whether field has at least one value submitted"
                      },
                      "removable": {
                        "type": "boolean",
                        "description": "whether field can be removed from system"
                      },
                      "is_active": {
                        "type": "boolean"
                      },
                      "list": {
                        "type": "boolean",
                        "description": "whether field can handle collection of values"
                      },
                      "read_only": {
                        "type": "boolean",
                        "description": "whether field value can be changed"
                      },
                      "required": {
                        "type": "boolean",
                        "description": "whether field value required by system"
                      },
                      "type": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "number"
                          },
                          "name": {
                            "type": "string"
                          },
                          "alias": {
                            "type": "string"
                          },
                          "settings": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "id": {
                                  "type": "number"
                                },
                                "name": {
                                  "type": "string"
                                },
                                "alias": {
                                  "type": "string"
                                },
                                "is_required": {
                                  "type": "boolean"
                                }
                              },
                              "required": [
                                "id",
                                "name",
                                "alias",
                                "is_required"
                              ]
                            }
                          },
                          "supports_collection": {
                            "type": "boolean"
                          },
                          "supports_read_only": {
                            "type": "boolean"
                          },
                          "supports_unique": {
                            "type": "boolean"
                          }
                        },
                        "required": [
                          "id",
                          "name",
                          "alias",
                          "settings",
                          "supports_collection",
                          "supports_read_only",
                          "supports_unique"
                        ],
                        "additionalProperties": false
                      },
                      "category": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "number"
                          },
                          "alias": {
                            "type": "string"
                          },
                          "position": {
                            "type": "number"
                          },
                          "system_required": {
                            "type": "boolean"
                          },
                          "name": {
                            "type": "string"
                          },
                          "description": {
                            "type": "string"
                          },
                          "is_active": {
                            "type": "boolean"
                          },
                          "pso_type": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "number"
                              },
                              "name": {
                                "type": "string"
                              },
                              "alias": {
                                "type": "string"
                              },
                              "description": {
                                "type": "string"
                              },
                              "is_active": {
                                "type": "boolean"
                              },
                              "system_required": {
                                "type": "boolean"
                              },
                              "creation_form_instance_id": {
                                "type": "number"
                              },
                              "profile_form_instance_id": {
                                "type": "number"
                              }
                            },
                            "required": [
                              "id",
                              "name",
                              "alias",
                              "description",
                              "is_active",
                              "system_required",
                              "creation_form_instance_id",
                              "profile_form_instance_id"
                            ],
                            "additionalProperties": false,
                            "description": "Presented only if `include` was send"
                          }
                        },
                        "required": [
                          "id",
                          "alias",
                          "position",
                          "system_required",
                          "name",
                          "description",
                          "is_active"
                        ],
                        "additionalProperties": false
                      },
                      "domains": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "number"
                            },
                            "alias": {
                              "type": "string"
                            },
                            "name": {
                              "type": "string"
                            },
                            "description": {
                              "type": "string"
                            },
                            "is_editable": {
                              "type": "boolean"
                            },
                            "is_removable": {
                              "type": "boolean"
                            },
                            "is_active": {
                              "type": "boolean"
                            },
                            "pso_type": {
                              "type": "object",
                              "properties": {
                                "id": {
                                  "type": "number"
                                },
                                "name": {
                                  "type": "string"
                                },
                                "alias": {
                                  "type": "string"
                                },
                                "description": {
                                  "type": "string"
                                },
                                "is_active": {
                                  "type": "boolean"
                                },
                                "system_required": {
                                  "type": "boolean"
                                },
                                "creation_form_instance_id": {
                                  "type": "number"
                                },
                                "profile_form_instance_id": {
                                  "type": "number"
                                }
                              },
                              "required": [
                                "id",
                                "name",
                                "alias",
                                "description",
                                "is_active",
                                "system_required",
                                "creation_form_instance_id",
                                "profile_form_instance_id"
                              ],
                              "additionalProperties": false
                            }
                          },
                          "required": [
                            "id",
                            "alias",
                            "name",
                            "description",
                            "is_editable",
                            "is_removable",
                            "is_active"
                          ]
                        }
                      },
                      "privacy_level": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "number"
                          },
                          "alias": {
                            "type": "string"
                          },
                          "name": {
                            "type": "string"
                          },
                          "level": {
                            "type": "number"
                          }
                        },
                        "required": [
                          "id",
                          "alias",
                          "name",
                          "level"
                        ],
                        "additionalProperties": false
                      },
                      "pso_type": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "number"
                          },
                          "name": {
                            "type": "string"
                          },
                          "alias": {
                            "type": "string"
                          },
                          "description": {
                            "type": "string"
                          },
                          "is_active": {
                            "type": "boolean"
                          },
                          "system_required": {
                            "type": "boolean"
                          },
                          "creation_form_instance_id": {
                            "type": "number"
                          },
                          "profile_form_instance_id": {
                            "type": "number"
                          }
                        },
                        "required": [
                          "id",
                          "name",
                          "alias",
                          "description",
                          "is_active",
                          "system_required",
                          "creation_form_instance_id",
                          "profile_form_instance_id"
                        ],
                        "additionalProperties": false
                      },
                      "items": {
                        "type": [
                          "array",
                          "null"
                        ],
                        "items": {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "number"
                            },
                            "name": {
                              "type": "string"
                            },
                            "position": {
                              "type": "number"
                            },
                            "alias": {
                              "type": "string"
                            },
                            "has_unique_data": {
                              "type": "boolean",
                              "description": "whether field requires values to be unique across system"
                            },
                            "has_value": {
                              "type": "boolean",
                              "description": "whether field has at least one value submitted"
                            },
                            "removable": {
                              "type": "boolean",
                              "description": "whether field can be removed from system"
                            },
                            "is_active": {
                              "type": "boolean"
                            },
                            "list": {
                              "type": "boolean",
                              "description": "whether field can handle collection of values"
                            },
                            "read_only": {
                              "type": "boolean",
                              "description": "whether field value can be changed"
                            },
                            "required": {
                              "type": "boolean",
                              "description": "deprecated setting"
                            },
                            "user_required": {
                              "type": "boolean",
                              "description": "whether field value required by user"
                            },
                            "system_required": {
                              "type": "boolean",
                              "description": "whether field value required by system"
                            },
                            "type": {
                              "type": "object",
                              "properties": {
                                "id": {
                                  "type": "number"
                                },
                                "name": {
                                  "type": "string"
                                },
                                "alias": {
                                  "type": "string"
                                },
                                "settings": {
                                  "type": "array",
                                  "items": {
                                    "type": "object",
                                    "properties": {
                                      "id": {
                                        "type": "number"
                                      },
                                      "name": {
                                        "type": "string"
                                      },
                                      "alias": {
                                        "type": "string"
                                      },
                                      "is_required": {
                                        "type": "boolean"
                                      }
                                    },
                                    "required": [
                                      "id",
                                      "name",
                                      "alias",
                                      "is_required"
                                    ]
                                  }
                                },
                                "supports_collection": {
                                  "type": "boolean"
                                },
                                "supports_read_only": {
                                  "type": "boolean"
                                },
                                "supports_unique": {
                                  "type": "boolean"
                                }
                              },
                              "required": [
                                "id",
                                "name",
                                "alias",
                                "settings",
                                "supports_collection",
                                "supports_read_only",
                                "supports_unique"
                              ],
                              "additionalProperties": false
                            },
                            "category": {
                              "type": "object",
                              "properties": {
                                "id": {
                                  "type": "number"
                                },
                                "alias": {
                                  "type": "string"
                                },
                                "position": {
                                  "type": "number"
                                },
                                "system_required": {
                                  "type": "boolean"
                                },
                                "name": {
                                  "type": "string"
                                },
                                "description": {
                                  "type": "string"
                                },
                                "is_active": {
                                  "type": "boolean"
                                },
                                "pso_type": {
                                  "type": "object",
                                  "properties": {
                                    "id": {
                                      "type": "number"
                                    },
                                    "name": {
                                      "type": "string"
                                    },
                                    "alias": {
                                      "type": "string"
                                    },
                                    "description": {
                                      "type": "string"
                                    },
                                    "is_active": {
                                      "type": "boolean"
                                    },
                                    "system_required": {
                                      "type": "boolean"
                                    },
                                    "creation_form_instance_id": {
                                      "type": "number"
                                    },
                                    "profile_form_instance_id": {
                                      "type": "number"
                                    }
                                  },
                                  "required": [
                                    "id",
                                    "name",
                                    "alias",
                                    "description",
                                    "is_active",
                                    "system_required",
                                    "creation_form_instance_id",
                                    "profile_form_instance_id"
                                  ],
                                  "additionalProperties": false,
                                  "description": "Presented only if `include` was send"
                                }
                              },
                              "required": [
                                "id",
                                "alias",
                                "position",
                                "system_required",
                                "name",
                                "description",
                                "is_active"
                              ],
                              "additionalProperties": false
                            },
                            "domains": {
                              "type": "array",
                              "items": {
                                "type": "object",
                                "properties": {
                                  "id": {
                                    "type": "number"
                                  },
                                  "alias": {
                                    "type": "string"
                                  },
                                  "name": {
                                    "type": "string"
                                  },
                                  "description": {
                                    "type": "string"
                                  },
                                  "is_editable": {
                                    "type": "boolean"
                                  },
                                  "is_removable": {
                                    "type": "boolean"
                                  },
                                  "is_active": {
                                    "type": "boolean"
                                  },
                                  "pso_type": {
                                    "type": "object",
                                    "properties": {
                                      "id": {
                                        "type": "number"
                                      },
                                      "name": {
                                        "type": "string"
                                      },
                                      "alias": {
                                        "type": "string"
                                      },
                                      "description": {
                                        "type": "string"
                                      },
                                      "is_active": {
                                        "type": "boolean"
                                      },
                                      "system_required": {
                                        "type": "boolean"
                                      },
                                      "creation_form_instance_id": {
                                        "type": "number"
                                      },
                                      "profile_form_instance_id": {
                                        "type": "number"
                                      }
                                    },
                                    "required": [
                                      "id",
                                      "name",
                                      "alias",
                                      "description",
                                      "is_active",
                                      "system_required",
                                      "creation_form_instance_id",
                                      "profile_form_instance_id"
                                    ],
                                    "additionalProperties": false
                                  }
                                },
                                "required": [
                                  "id",
                                  "alias",
                                  "name",
                                  "description",
                                  "is_editable",
                                  "is_removable",
                                  "is_active"
                                ]
                              }
                            },
                            "privacy_level": {
                              "type": "object",
                              "properties": {
                                "id": {
                                  "type": "number"
                                },
                                "alias": {
                                  "type": "string"
                                },
                                "name": {
                                  "type": "string"
                                },
                                "level": {
                                  "type": "number"
                                }
                              },
                              "required": [
                                "id",
                                "alias",
                                "name",
                                "level"
                              ],
                              "additionalProperties": false
                            },
                            "pso_type": {
                              "type": "object",
                              "properties": {
                                "id": {
                                  "type": "number"
                                },
                                "name": {
                                  "type": "string"
                                },
                                "alias": {
                                  "type": "string"
                                },
                                "description": {
                                  "type": "string"
                                },
                                "is_active": {
                                  "type": "boolean"
                                },
                                "system_required": {
                                  "type": "boolean"
                                },
                                "creation_form_instance_id": {
                                  "type": "number"
                                },
                                "profile_form_instance_id": {
                                  "type": "number"
                                }
                              },
                              "required": [
                                "id",
                                "name",
                                "alias",
                                "description",
                                "is_active",
                                "system_required",
                                "creation_form_instance_id",
                                "profile_form_instance_id"
                              ],
                              "additionalProperties": false
                            },
                            "items": {
                              "type": [
                                "array",
                                "null"
                              ],
                              "items": {
                                "type": "object",
                                "properties": {}
                              }
                            },
                            "options": {
                              "type": [
                                "array",
                                "null"
                              ],
                              "items": {
                                "type": "object",
                                "properties": {
                                  "id": {
                                    "type": "number"
                                  },
                                  "name": {
                                    "type": "string"
                                  },
                                  "position": {
                                    "type": "number"
                                  },
                                  "value": {
                                    "type": "string"
                                  },
                                  "is_active": {
                                    "type": "boolean"
                                  },
                                  "is_selectable": {
                                    "type": "boolean",
                                    "description": "Can select on front this option (Using only in Hierarchy field))"
                                  }
                                },
                                "required": [
                                  "id",
                                  "name",
                                  "position",
                                  "value",
                                  "is_active",
                                  "is_selectable"
                                ]
                              },
                              "description": "List of options with possible (allowed) values."
                            },
                            "settings": {
                              "type": "array",
                              "items": {
                                "type": "string"
                              },
                              "description": "Common field settings"
                            },
                            "validation": {
                              "type": "object",
                              "properties": {
                                "type": {
                                  "type": "string"
                                },
                                "attributes": {
                                  "type": "object",
                                  "properties": {}
                                },
                                "value_example": {
                                  "type": "string"
                                },
                                "error_message": {
                                  "type": "object",
                                  "properties": {
                                    "en": {
                                      "type": "string"
                                    },
                                    "fr": {
                                      "type": "string"
                                    },
                                    "de": {
                                      "type": "string"
                                    },
                                    "es": {
                                      "type": "string"
                                    }
                                  },
                                  "required": [
                                    "en",
                                    "fr",
                                    "de",
                                    "es"
                                  ]
                                }
                              },
                              "required": [
                                "type",
                                "value_example",
                                "error_message"
                              ]
                            },
                            "has_autocomplete_settings": {
                              "type": "boolean"
                            },
                            "autocomplete_settings": {
                              "type": "object",
                              "properties": {
                                "allow_extra_values": {
                                  "type": "boolean"
                                },
                                "autofill": {
                                  "type": "boolean"
                                },
                                "provider": {
                                  "type": "object",
                                  "properties": {
                                    "name": {
                                      "type": "object",
                                      "properties": {
                                        "en": {
                                          "type": "string"
                                        },
                                        "fr": {
                                          "type": "string"
                                        },
                                        "de": {
                                          "type": "string"
                                        },
                                        "es": {
                                          "type": "string"
                                        }
                                      },
                                      "required": [
                                        "en",
                                        "fr",
                                        "de",
                                        "es"
                                      ]
                                    },
                                    "alias": {
                                      "type": "string"
                                    },
                                    "base_url": {
                                      "type": "string"
                                    },
                                    "single_value_supported": {
                                      "type": "boolean"
                                    },
                                    "parameters": {
                                      "type": "array"
                                    }
                                  },
                                  "required": [
                                    "name",
                                    "alias",
                                    "base_url",
                                    "single_value_supported",
                                    "parameters"
                                  ]
                                },
                                "parameters": {
                                  "type": "array"
                                }
                              },
                              "required": [
                                "allow_extra_values",
                                "autofill",
                                "provider",
                                "parameters"
                              ]
                            }
                          },
                          "required": [
                            "id",
                            "name",
                            "position",
                            "alias",
                            "has_unique_data",
                            "has_value",
                            "removable",
                            "is_active",
                            "list",
                            "read_only",
                            "required",
                            "user_required",
                            "system_required",
                            "validation",
                            "has_autocomplete_settings",
                            "autocomplete_settings"
                          ]
                        }
                      },
                      "options": {
                        "type": [
                          "array",
                          "null"
                        ],
                        "items": {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "number"
                            },
                            "name": {
                              "type": "string"
                            },
                            "position": {
                              "type": "number"
                            },
                            "value": {
                              "type": "string"
                            },
                            "is_active": {
                              "type": "boolean"
                            },
                            "is_selectable": {
                              "type": "boolean",
                              "description": "Can select on front this option (Using only in Hierarchy field))"
                            }
                          },
                          "required": [
                            "id",
                            "name",
                            "position",
                            "value",
                            "is_active",
                            "is_selectable"
                          ]
                        },
                        "description": "List of options with possible (allowed) values."
                      },
                      "settings": {
                        "type": "array",
                        "items": {
                          "type": "string"
                        },
                        "description": "Common field settings"
                      },
                      "is_locked": {
                        "type": "boolean"
                      },
                      "value_details": {
                        "type": "array"
                      },
                      "values_count": {
                        "type": "number"
                      },
                      "assignment_settings": {
                        "type": "array"
                      },
                      "access_permissions": {
                        "type": "object",
                        "properties": {
                          "history": {
                            "type": "boolean"
                          },
                          "view": {
                            "type": "boolean"
                          },
                          "edit": {
                            "type": "boolean"
                          }
                        },
                        "required": [
                          "history",
                          "view",
                          "edit"
                        ]
                      },
                      "assignment_permissions": {
                        "type": "object",
                        "properties": {
                          "permissions": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "number"
                              },
                              "name": {
                                "type": "string"
                              },
                              "alias": {
                                "type": "string"
                              }
                            },
                            "required": [
                              "id",
                              "name",
                              "alias"
                            ]
                          },
                          "access_list": {
                            "type": "array",
                            "description": "user, manager, hr"
                          }
                        },
                        "required": [
                          "permissions",
                          "access_list"
                        ]
                      }
                    },
                    "required": [
                      "id",
                      "name",
                      "position",
                      "alias",
                      "has_unique_data",
                      "has_value",
                      "removable",
                      "is_active",
                      "list",
                      "read_only",
                      "required",
                      "is_locked",
                      "value_details",
                      "values_count",
                      "assignment_settings",
                      "access_permissions",
                      "assignment_permissions"
                    ]
                  }
                }
              },
              "required": [
                "id",
                "status",
                "approval_scheduled_date"
              ]
            }
          }
        },
        "required": [
          "uuid",
          "status",
          "is_mass_edit",
          "approval_scheduled_date"
        ]
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "pagination": {
          "type": "object",
          "properties": {
            "total": {
              "type": "number"
            },
            "count": {
              "type": "number"
            },
            "per_page": {
              "type": "number"
            },
            "current_page": {
              "type": "number"
            },
            "total_pages": {
              "type": "number"
            },
            "links": {
              "type": "object",
              "properties": {
                "previous": {
                  "type": "string"
                },
                "next": {
                  "type": "string"
                }
              },
              "required": [
                "previous",
                "next"
              ]
            }
          },
          "required": [
            "total",
            "count",
            "per_page",
            "current_page",
            "total_pages",
            "links"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "pagination"
      ]
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show batch
GET/scheduled-approvals/{uuid}/{?include}

Fetch batch of scheduled approvals items.

Example URI

GET https://rest.monportailrh.com/scheduled-approvals/123/?include=author
URI Parameters
HideShow
uuid
number (required) Example: 123

Uuid of the Scheduled Approval batch.

include
string (optional) Example: author

Comma separated list of related resources that will be included into response. Possible values:

  • author

  • form_instance

  • scheduled_approvals.fields

  • scheduled_approvals.fields.type

  • scheduled_approvals.fields.category

  • scheduled_approvals.fields.category.pso_type

  • scheduled_approvals.fields.domains

  • scheduled_approvals.fields.domains.pso_type

  • scheduled_approvals.fields.pso_type

  • scheduled_approvals.fields.items

  • scheduled_approvals.fields.options

Note that includes uses kind of inheritance. So if you put include=scheduled_approvals.fields.items.type it will also populate items property for all fields

If you need to dive into and include related resources for sub-items you can use same options that fields property has.

For example: include=scheduled_approvals.fields.items.type will attach to the response all fields that assignment has.
Every included field will have items property populated. Every item in items property will have type property populated

But, note: Unlike other forms with values array, “values” of composite will contain the structured tree of all subfields values.

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: '*'
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "uuid": "34425f31-d9f3-37bd-b90d-e5a7f7f85fc1",
    "status": "pending",
    "is_mass_edit": true,
    "approval_scheduled_date": "2019-04-24 11:47:47",
    "author": {
      "id": 1,
      "external_id": 1,
      "first_name": "John",
      "last_name": "Snow",
      "username": "john_snow",
      "professional_email": "jsnow@example.com",
      "professional_mobile_phone": "00 33 1 40 00 00 00",
      "professional_phone": "00 33 1 40 00 00 00",
      "role": [
        "bastard",
        "king"
      ],
      "is_active": true,
      "status": "remote",
      "settings": [
        "[]"
      ],
      "user_photo": "http://example.com/images/1.jpg"
    },
    "form_instance": {
      "id": 1,
      "name": {
        "en": "Some text",
        "fr": "Du texte",
        "de": "Setwas Text",
        "es": "Algún texto"
      },
      "description": {
        "en": "Some text",
        "fr": "Du texte",
        "de": "Setwas Text",
        "es": "Algún texto"
      },
      "form_id": 123,
      "is_active": true,
      "removable": false,
      "effective_date": "2019-04-24 11:47:47"
    },
    "scheduled_approvals": [
      {
        "id": 1,
        "status": "pending",
        "approval_scheduled_date": "2019-04-24 11:47:47",
        "pso": {
          "id": 1,
          "external_id": 1,
          "first_name": "John",
          "last_name": "Snow",
          "username": "john_snow",
          "professional_email": "jsnow@example.com",
          "professional_mobile_phone": "00 33 1 40 00 00 00",
          "professional_phone": "00 33 1 40 00 00 00",
          "role": [
            "bastard",
            "king"
          ],
          "is_active": true,
          "status": "remote",
          "settings": [
            "[]"
          ],
          "user_photo": "http://example.com/images/1.jpg"
        },
        "fields": [
          {
            "id": 1,
            "name": "Field Name",
            "position": 5,
            "alias": "usr_first_name",
            "has_unique_data": false,
            "has_value": true,
            "removable": false,
            "is_active": true,
            "list": false,
            "read_only": false,
            "required": true,
            "type": {
              "id": 1,
              "name": "Data Type Name",
              "alias": "data_type_alias",
              "settings": [
                {
                  "id": 1,
                  "name": "Data Type Setting Name",
                  "alias": "data_type_setting_alias",
                  "is_required": true
                }
              ],
              "supports_collection": false,
              "supports_read_only": false,
              "supports_unique": false
            },
            "category": {
              "id": 32,
              "alias": "usr_identity",
              "position": 5,
              "system_required": true,
              "name": "Identity",
              "description": "...",
              "is_active": true,
              "pso_type": {
                "id": 56,
                "name": "User",
                "alias": "usr",
                "description": "...",
                "is_active": true,
                "system_required": true,
                "creation_form_instance_id": 1,
                "profile_form_instance_id": 1
              }
            },
            "domains": [
              {
                "id": 46,
                "alias": "usr_global",
                "name": "User Global",
                "description": "...",
                "is_editable": false,
                "is_removable": false,
                "is_active": true,
                "pso_type": {
                  "id": 56,
                  "name": "User",
                  "alias": "usr",
                  "description": "...",
                  "is_active": true,
                  "system_required": true,
                  "creation_form_instance_id": 1,
                  "profile_form_instance_id": 1
                }
              }
            ],
            "privacy_level": {
              "id": 123,
              "alias": "public",
              "name": "Not Sensitive",
              "level": 100
            },
            "pso_type": {
              "id": 56,
              "name": "User",
              "alias": "usr",
              "description": "...",
              "is_active": true,
              "system_required": true,
              "creation_form_instance_id": 1,
              "profile_form_instance_id": 1
            },
            "items": [
              {
                "id": 1,
                "name": "Field Name",
                "position": 5,
                "alias": "usr_first_name",
                "has_unique_data": false,
                "has_value": true,
                "removable": false,
                "is_active": true,
                "list": false,
                "read_only": false,
                "required": true,
                "user_required": true,
                "system_required": true,
                "type": {
                  "id": 1,
                  "name": "Data Type Name",
                  "alias": "data_type_alias",
                  "settings": [
                    {
                      "id": 1,
                      "name": "Data Type Setting Name",
                      "alias": "data_type_setting_alias",
                      "is_required": true
                    }
                  ],
                  "supports_collection": false,
                  "supports_read_only": false,
                  "supports_unique": false
                },
                "category": {
                  "id": 32,
                  "alias": "usr_identity",
                  "position": 5,
                  "system_required": true,
                  "name": "Identity",
                  "description": "...",
                  "is_active": true,
                  "pso_type": {
                    "id": 56,
                    "name": "User",
                    "alias": "usr",
                    "description": "...",
                    "is_active": true,
                    "system_required": true,
                    "creation_form_instance_id": 1,
                    "profile_form_instance_id": 1
                  }
                },
                "domains": [
                  {
                    "id": 46,
                    "alias": "usr_global",
                    "name": "User Global",
                    "description": "...",
                    "is_editable": false,
                    "is_removable": false,
                    "is_active": true,
                    "pso_type": {
                      "id": 56,
                      "name": "User",
                      "alias": "usr",
                      "description": "...",
                      "is_active": true,
                      "system_required": true,
                      "creation_form_instance_id": 1,
                      "profile_form_instance_id": 1
                    }
                  }
                ],
                "privacy_level": {
                  "id": 123,
                  "alias": "public",
                  "name": "Not Sensitive",
                  "level": 100
                },
                "pso_type": {
                  "id": 56,
                  "name": "User",
                  "alias": "usr",
                  "description": "...",
                  "is_active": true,
                  "system_required": true,
                  "creation_form_instance_id": 1,
                  "profile_form_instance_id": 1
                },
                "items": [
                  {}
                ],
                "options": [
                  {
                    "id": 198,
                    "name": "Choose me!",
                    "position": 9,
                    "value": "198",
                    "is_active": true,
                    "is_selectable": true
                  }
                ],
                "settings": [],
                "validation": {
                  "type": "regexp",
                  "attributes": {},
                  "value_example": "string",
                  "error_message": {
                    "en": "Some text",
                    "fr": "Du texte",
                    "de": "Setwas Text",
                    "es": "Algún texto"
                  }
                },
                "has_autocomplete_settings": true,
                "autocomplete_settings": {
                  "allow_extra_values": true,
                  "autofill": true,
                  "provider": {
                    "name": {
                      "en": "Some text",
                      "fr": "Du texte",
                      "de": "Setwas Text",
                      "es": "Algún texto"
                    },
                    "alias": "string",
                    "base_url": "https://exmaple.com/",
                    "single_value_supported": true,
                    "parameters": [
                      {
                        "name": "Name",
                        "key": "alias",
                        "required": true
                      }
                    ]
                  },
                  "parameters": [
                    {
                      "name": "Name",
                      "key": "alias",
                      "required": true,
                      "value": "value",
                      "field": {
                        "id": 1,
                        "name": "Field Name",
                        "alias": "usr_first_name",
                        "value": "RU",
                        "root_field": {
                          "id": 1,
                          "name": "Field Name",
                          "alias": "usr_first_name",
                          "value": "RU",
                          "root_field": "null"
                        }
                      }
                    }
                  ]
                }
              }
            ],
            "options": [
              {
                "id": 198,
                "name": "Choose me!",
                "position": 9,
                "value": "198",
                "is_active": true,
                "is_selectable": true
              }
            ],
            "settings": [],
            "is_locked": false,
            "value_details": [
              "value1",
              "value2"
            ],
            "values_count": 2,
            "assignment_settings": [
              {
                "setting": "public",
                "value": "1"
              }
            ],
            "access_permissions": {
              "history": true,
              "view": true,
              "edit": true
            },
            "assignment_permissions": {
              "permissions": {
                "id": 1,
                "name": "View",
                "alias": "view"
              },
              "access_list": [
                "0",
                "1",
                "1"
              ]
            }
          }
        ]
      }
    ]
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "uuid": {
          "type": "string"
        },
        "status": {
          "type": "string",
          "enum": [
            "pending",
            "done",
            "failed"
          ]
        },
        "is_mass_edit": {
          "type": "boolean"
        },
        "approval_scheduled_date": {
          "type": "string"
        },
        "author": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "external_id": {
              "type": "number"
            },
            "first_name": {
              "type": "string"
            },
            "last_name": {
              "type": "string"
            },
            "username": {
              "type": "string"
            },
            "professional_email": {
              "type": "string"
            },
            "professional_mobile_phone": {
              "type": "string"
            },
            "professional_phone": {
              "type": "string"
            },
            "role": {
              "type": "array"
            },
            "is_active": {
              "type": "boolean"
            },
            "status": {
              "type": "string"
            },
            "settings": {
              "type": "array"
            },
            "user_photo": {
              "type": "string"
            }
          },
          "required": [
            "id",
            "external_id",
            "first_name",
            "last_name",
            "username",
            "professional_email",
            "professional_mobile_phone",
            "professional_phone",
            "role",
            "is_active",
            "status",
            "settings",
            "user_photo"
          ],
          "additionalProperties": false
        },
        "form_instance": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "name": {
              "type": "object",
              "properties": {
                "en": {
                  "type": "string"
                },
                "fr": {
                  "type": "string"
                },
                "de": {
                  "type": "string"
                },
                "es": {
                  "type": "string"
                }
              },
              "required": [
                "en",
                "fr",
                "de",
                "es"
              ]
            },
            "description": {
              "type": "object",
              "properties": {
                "en": {
                  "type": "string"
                },
                "fr": {
                  "type": "string"
                },
                "de": {
                  "type": "string"
                },
                "es": {
                  "type": "string"
                }
              },
              "required": [
                "en",
                "fr",
                "de",
                "es"
              ]
            },
            "form_id": {
              "type": "number"
            },
            "is_active": {
              "type": "boolean"
            },
            "removable": {
              "type": "boolean"
            },
            "effective_date": {
              "type": "string"
            }
          },
          "required": [
            "id",
            "name",
            "description",
            "form_id",
            "is_active",
            "removable",
            "effective_date"
          ],
          "additionalProperties": false
        },
        "scheduled_approvals": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number"
              },
              "status": {
                "type": "string",
                "enum": [
                  "pending",
                  "done",
                  "failed"
                ]
              },
              "approval_scheduled_date": {
                "type": "string"
              },
              "pso": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "number"
                  },
                  "external_id": {
                    "type": "number"
                  },
                  "first_name": {
                    "type": "string"
                  },
                  "last_name": {
                    "type": "string"
                  },
                  "username": {
                    "type": "string"
                  },
                  "professional_email": {
                    "type": "string"
                  },
                  "professional_mobile_phone": {
                    "type": "string"
                  },
                  "professional_phone": {
                    "type": "string"
                  },
                  "role": {
                    "type": "array"
                  },
                  "is_active": {
                    "type": "boolean"
                  },
                  "status": {
                    "type": "string"
                  },
                  "settings": {
                    "type": "array"
                  },
                  "user_photo": {
                    "type": "string"
                  }
                },
                "required": [
                  "id",
                  "external_id",
                  "first_name",
                  "last_name",
                  "username",
                  "professional_email",
                  "professional_mobile_phone",
                  "professional_phone",
                  "role",
                  "is_active",
                  "status",
                  "settings",
                  "user_photo"
                ],
                "additionalProperties": false
              },
              "fields": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "number"
                    },
                    "name": {
                      "type": "string"
                    },
                    "position": {
                      "type": "number"
                    },
                    "alias": {
                      "type": "string"
                    },
                    "has_unique_data": {
                      "type": "boolean",
                      "description": "whether field requires values to be unique across system"
                    },
                    "has_value": {
                      "type": "boolean",
                      "description": "whether field has at least one value submitted"
                    },
                    "removable": {
                      "type": "boolean",
                      "description": "whether field can be removed from system"
                    },
                    "is_active": {
                      "type": "boolean"
                    },
                    "list": {
                      "type": "boolean",
                      "description": "whether field can handle collection of values"
                    },
                    "read_only": {
                      "type": "boolean",
                      "description": "whether field value can be changed"
                    },
                    "required": {
                      "type": "boolean",
                      "description": "whether field value required by system"
                    },
                    "type": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "number"
                        },
                        "name": {
                          "type": "string"
                        },
                        "alias": {
                          "type": "string"
                        },
                        "settings": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "number"
                              },
                              "name": {
                                "type": "string"
                              },
                              "alias": {
                                "type": "string"
                              },
                              "is_required": {
                                "type": "boolean"
                              }
                            },
                            "required": [
                              "id",
                              "name",
                              "alias",
                              "is_required"
                            ]
                          }
                        },
                        "supports_collection": {
                          "type": "boolean"
                        },
                        "supports_read_only": {
                          "type": "boolean"
                        },
                        "supports_unique": {
                          "type": "boolean"
                        }
                      },
                      "required": [
                        "id",
                        "name",
                        "alias",
                        "settings",
                        "supports_collection",
                        "supports_read_only",
                        "supports_unique"
                      ],
                      "additionalProperties": false
                    },
                    "category": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "number"
                        },
                        "alias": {
                          "type": "string"
                        },
                        "position": {
                          "type": "number"
                        },
                        "system_required": {
                          "type": "boolean"
                        },
                        "name": {
                          "type": "string"
                        },
                        "description": {
                          "type": "string"
                        },
                        "is_active": {
                          "type": "boolean"
                        },
                        "pso_type": {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "number"
                            },
                            "name": {
                              "type": "string"
                            },
                            "alias": {
                              "type": "string"
                            },
                            "description": {
                              "type": "string"
                            },
                            "is_active": {
                              "type": "boolean"
                            },
                            "system_required": {
                              "type": "boolean"
                            },
                            "creation_form_instance_id": {
                              "type": "number"
                            },
                            "profile_form_instance_id": {
                              "type": "number"
                            }
                          },
                          "required": [
                            "id",
                            "name",
                            "alias",
                            "description",
                            "is_active",
                            "system_required",
                            "creation_form_instance_id",
                            "profile_form_instance_id"
                          ],
                          "additionalProperties": false,
                          "description": "Presented only if `include` was send"
                        }
                      },
                      "required": [
                        "id",
                        "alias",
                        "position",
                        "system_required",
                        "name",
                        "description",
                        "is_active"
                      ],
                      "additionalProperties": false
                    },
                    "domains": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "number"
                          },
                          "alias": {
                            "type": "string"
                          },
                          "name": {
                            "type": "string"
                          },
                          "description": {
                            "type": "string"
                          },
                          "is_editable": {
                            "type": "boolean"
                          },
                          "is_removable": {
                            "type": "boolean"
                          },
                          "is_active": {
                            "type": "boolean"
                          },
                          "pso_type": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "number"
                              },
                              "name": {
                                "type": "string"
                              },
                              "alias": {
                                "type": "string"
                              },
                              "description": {
                                "type": "string"
                              },
                              "is_active": {
                                "type": "boolean"
                              },
                              "system_required": {
                                "type": "boolean"
                              },
                              "creation_form_instance_id": {
                                "type": "number"
                              },
                              "profile_form_instance_id": {
                                "type": "number"
                              }
                            },
                            "required": [
                              "id",
                              "name",
                              "alias",
                              "description",
                              "is_active",
                              "system_required",
                              "creation_form_instance_id",
                              "profile_form_instance_id"
                            ],
                            "additionalProperties": false
                          }
                        },
                        "required": [
                          "id",
                          "alias",
                          "name",
                          "description",
                          "is_editable",
                          "is_removable",
                          "is_active"
                        ]
                      }
                    },
                    "privacy_level": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "number"
                        },
                        "alias": {
                          "type": "string"
                        },
                        "name": {
                          "type": "string"
                        },
                        "level": {
                          "type": "number"
                        }
                      },
                      "required": [
                        "id",
                        "alias",
                        "name",
                        "level"
                      ],
                      "additionalProperties": false
                    },
                    "pso_type": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "number"
                        },
                        "name": {
                          "type": "string"
                        },
                        "alias": {
                          "type": "string"
                        },
                        "description": {
                          "type": "string"
                        },
                        "is_active": {
                          "type": "boolean"
                        },
                        "system_required": {
                          "type": "boolean"
                        },
                        "creation_form_instance_id": {
                          "type": "number"
                        },
                        "profile_form_instance_id": {
                          "type": "number"
                        }
                      },
                      "required": [
                        "id",
                        "name",
                        "alias",
                        "description",
                        "is_active",
                        "system_required",
                        "creation_form_instance_id",
                        "profile_form_instance_id"
                      ],
                      "additionalProperties": false
                    },
                    "items": {
                      "type": [
                        "array",
                        "null"
                      ],
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "number"
                          },
                          "name": {
                            "type": "string"
                          },
                          "position": {
                            "type": "number"
                          },
                          "alias": {
                            "type": "string"
                          },
                          "has_unique_data": {
                            "type": "boolean",
                            "description": "whether field requires values to be unique across system"
                          },
                          "has_value": {
                            "type": "boolean",
                            "description": "whether field has at least one value submitted"
                          },
                          "removable": {
                            "type": "boolean",
                            "description": "whether field can be removed from system"
                          },
                          "is_active": {
                            "type": "boolean"
                          },
                          "list": {
                            "type": "boolean",
                            "description": "whether field can handle collection of values"
                          },
                          "read_only": {
                            "type": "boolean",
                            "description": "whether field value can be changed"
                          },
                          "required": {
                            "type": "boolean",
                            "description": "deprecated setting"
                          },
                          "user_required": {
                            "type": "boolean",
                            "description": "whether field value required by user"
                          },
                          "system_required": {
                            "type": "boolean",
                            "description": "whether field value required by system"
                          },
                          "type": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "number"
                              },
                              "name": {
                                "type": "string"
                              },
                              "alias": {
                                "type": "string"
                              },
                              "settings": {
                                "type": "array",
                                "items": {
                                  "type": "object",
                                  "properties": {
                                    "id": {
                                      "type": "number"
                                    },
                                    "name": {
                                      "type": "string"
                                    },
                                    "alias": {
                                      "type": "string"
                                    },
                                    "is_required": {
                                      "type": "boolean"
                                    }
                                  },
                                  "required": [
                                    "id",
                                    "name",
                                    "alias",
                                    "is_required"
                                  ]
                                }
                              },
                              "supports_collection": {
                                "type": "boolean"
                              },
                              "supports_read_only": {
                                "type": "boolean"
                              },
                              "supports_unique": {
                                "type": "boolean"
                              }
                            },
                            "required": [
                              "id",
                              "name",
                              "alias",
                              "settings",
                              "supports_collection",
                              "supports_read_only",
                              "supports_unique"
                            ],
                            "additionalProperties": false
                          },
                          "category": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "number"
                              },
                              "alias": {
                                "type": "string"
                              },
                              "position": {
                                "type": "number"
                              },
                              "system_required": {
                                "type": "boolean"
                              },
                              "name": {
                                "type": "string"
                              },
                              "description": {
                                "type": "string"
                              },
                              "is_active": {
                                "type": "boolean"
                              },
                              "pso_type": {
                                "type": "object",
                                "properties": {
                                  "id": {
                                    "type": "number"
                                  },
                                  "name": {
                                    "type": "string"
                                  },
                                  "alias": {
                                    "type": "string"
                                  },
                                  "description": {
                                    "type": "string"
                                  },
                                  "is_active": {
                                    "type": "boolean"
                                  },
                                  "system_required": {
                                    "type": "boolean"
                                  },
                                  "creation_form_instance_id": {
                                    "type": "number"
                                  },
                                  "profile_form_instance_id": {
                                    "type": "number"
                                  }
                                },
                                "required": [
                                  "id",
                                  "name",
                                  "alias",
                                  "description",
                                  "is_active",
                                  "system_required",
                                  "creation_form_instance_id",
                                  "profile_form_instance_id"
                                ],
                                "additionalProperties": false,
                                "description": "Presented only if `include` was send"
                              }
                            },
                            "required": [
                              "id",
                              "alias",
                              "position",
                              "system_required",
                              "name",
                              "description",
                              "is_active"
                            ],
                            "additionalProperties": false
                          },
                          "domains": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "id": {
                                  "type": "number"
                                },
                                "alias": {
                                  "type": "string"
                                },
                                "name": {
                                  "type": "string"
                                },
                                "description": {
                                  "type": "string"
                                },
                                "is_editable": {
                                  "type": "boolean"
                                },
                                "is_removable": {
                                  "type": "boolean"
                                },
                                "is_active": {
                                  "type": "boolean"
                                },
                                "pso_type": {
                                  "type": "object",
                                  "properties": {
                                    "id": {
                                      "type": "number"
                                    },
                                    "name": {
                                      "type": "string"
                                    },
                                    "alias": {
                                      "type": "string"
                                    },
                                    "description": {
                                      "type": "string"
                                    },
                                    "is_active": {
                                      "type": "boolean"
                                    },
                                    "system_required": {
                                      "type": "boolean"
                                    },
                                    "creation_form_instance_id": {
                                      "type": "number"
                                    },
                                    "profile_form_instance_id": {
                                      "type": "number"
                                    }
                                  },
                                  "required": [
                                    "id",
                                    "name",
                                    "alias",
                                    "description",
                                    "is_active",
                                    "system_required",
                                    "creation_form_instance_id",
                                    "profile_form_instance_id"
                                  ],
                                  "additionalProperties": false
                                }
                              },
                              "required": [
                                "id",
                                "alias",
                                "name",
                                "description",
                                "is_editable",
                                "is_removable",
                                "is_active"
                              ]
                            }
                          },
                          "privacy_level": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "number"
                              },
                              "alias": {
                                "type": "string"
                              },
                              "name": {
                                "type": "string"
                              },
                              "level": {
                                "type": "number"
                              }
                            },
                            "required": [
                              "id",
                              "alias",
                              "name",
                              "level"
                            ],
                            "additionalProperties": false
                          },
                          "pso_type": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "number"
                              },
                              "name": {
                                "type": "string"
                              },
                              "alias": {
                                "type": "string"
                              },
                              "description": {
                                "type": "string"
                              },
                              "is_active": {
                                "type": "boolean"
                              },
                              "system_required": {
                                "type": "boolean"
                              },
                              "creation_form_instance_id": {
                                "type": "number"
                              },
                              "profile_form_instance_id": {
                                "type": "number"
                              }
                            },
                            "required": [
                              "id",
                              "name",
                              "alias",
                              "description",
                              "is_active",
                              "system_required",
                              "creation_form_instance_id",
                              "profile_form_instance_id"
                            ],
                            "additionalProperties": false
                          },
                          "items": {
                            "type": [
                              "array",
                              "null"
                            ],
                            "items": {
                              "type": "object",
                              "properties": {}
                            }
                          },
                          "options": {
                            "type": [
                              "array",
                              "null"
                            ],
                            "items": {
                              "type": "object",
                              "properties": {
                                "id": {
                                  "type": "number"
                                },
                                "name": {
                                  "type": "string"
                                },
                                "position": {
                                  "type": "number"
                                },
                                "value": {
                                  "type": "string"
                                },
                                "is_active": {
                                  "type": "boolean"
                                },
                                "is_selectable": {
                                  "type": "boolean",
                                  "description": "Can select on front this option (Using only in Hierarchy field))"
                                }
                              },
                              "required": [
                                "id",
                                "name",
                                "position",
                                "value",
                                "is_active",
                                "is_selectable"
                              ]
                            },
                            "description": "List of options with possible (allowed) values."
                          },
                          "settings": {
                            "type": "array",
                            "items": {
                              "type": "string"
                            },
                            "description": "Common field settings"
                          },
                          "validation": {
                            "type": "object",
                            "properties": {
                              "type": {
                                "type": "string"
                              },
                              "attributes": {
                                "type": "object",
                                "properties": {}
                              },
                              "value_example": {
                                "type": "string"
                              },
                              "error_message": {
                                "type": "object",
                                "properties": {
                                  "en": {
                                    "type": "string"
                                  },
                                  "fr": {
                                    "type": "string"
                                  },
                                  "de": {
                                    "type": "string"
                                  },
                                  "es": {
                                    "type": "string"
                                  }
                                },
                                "required": [
                                  "en",
                                  "fr",
                                  "de",
                                  "es"
                                ]
                              }
                            },
                            "required": [
                              "type",
                              "value_example",
                              "error_message"
                            ]
                          },
                          "has_autocomplete_settings": {
                            "type": "boolean"
                          },
                          "autocomplete_settings": {
                            "type": "object",
                            "properties": {
                              "allow_extra_values": {
                                "type": "boolean"
                              },
                              "autofill": {
                                "type": "boolean"
                              },
                              "provider": {
                                "type": "object",
                                "properties": {
                                  "name": {
                                    "type": "object",
                                    "properties": {
                                      "en": {
                                        "type": "string"
                                      },
                                      "fr": {
                                        "type": "string"
                                      },
                                      "de": {
                                        "type": "string"
                                      },
                                      "es": {
                                        "type": "string"
                                      }
                                    },
                                    "required": [
                                      "en",
                                      "fr",
                                      "de",
                                      "es"
                                    ]
                                  },
                                  "alias": {
                                    "type": "string"
                                  },
                                  "base_url": {
                                    "type": "string"
                                  },
                                  "single_value_supported": {
                                    "type": "boolean"
                                  },
                                  "parameters": {
                                    "type": "array"
                                  }
                                },
                                "required": [
                                  "name",
                                  "alias",
                                  "base_url",
                                  "single_value_supported",
                                  "parameters"
                                ]
                              },
                              "parameters": {
                                "type": "array"
                              }
                            },
                            "required": [
                              "allow_extra_values",
                              "autofill",
                              "provider",
                              "parameters"
                            ]
                          }
                        },
                        "required": [
                          "id",
                          "name",
                          "position",
                          "alias",
                          "has_unique_data",
                          "has_value",
                          "removable",
                          "is_active",
                          "list",
                          "read_only",
                          "required",
                          "user_required",
                          "system_required",
                          "validation",
                          "has_autocomplete_settings",
                          "autocomplete_settings"
                        ]
                      }
                    },
                    "options": {
                      "type": [
                        "array",
                        "null"
                      ],
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "number"
                          },
                          "name": {
                            "type": "string"
                          },
                          "position": {
                            "type": "number"
                          },
                          "value": {
                            "type": "string"
                          },
                          "is_active": {
                            "type": "boolean"
                          },
                          "is_selectable": {
                            "type": "boolean",
                            "description": "Can select on front this option (Using only in Hierarchy field))"
                          }
                        },
                        "required": [
                          "id",
                          "name",
                          "position",
                          "value",
                          "is_active",
                          "is_selectable"
                        ]
                      },
                      "description": "List of options with possible (allowed) values."
                    },
                    "settings": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      },
                      "description": "Common field settings"
                    },
                    "is_locked": {
                      "type": "boolean"
                    },
                    "value_details": {
                      "type": "array"
                    },
                    "values_count": {
                      "type": "number"
                    },
                    "assignment_settings": {
                      "type": "array"
                    },
                    "access_permissions": {
                      "type": "object",
                      "properties": {
                        "history": {
                          "type": "boolean"
                        },
                        "view": {
                          "type": "boolean"
                        },
                        "edit": {
                          "type": "boolean"
                        }
                      },
                      "required": [
                        "history",
                        "view",
                        "edit"
                      ]
                    },
                    "assignment_permissions": {
                      "type": "object",
                      "properties": {
                        "permissions": {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "number"
                            },
                            "name": {
                              "type": "string"
                            },
                            "alias": {
                              "type": "string"
                            }
                          },
                          "required": [
                            "id",
                            "name",
                            "alias"
                          ]
                        },
                        "access_list": {
                          "type": "array",
                          "description": "user, manager, hr"
                        }
                      },
                      "required": [
                        "permissions",
                        "access_list"
                      ]
                    }
                  },
                  "required": [
                    "id",
                    "name",
                    "position",
                    "alias",
                    "has_unique_data",
                    "has_value",
                    "removable",
                    "is_active",
                    "list",
                    "read_only",
                    "required",
                    "is_locked",
                    "value_details",
                    "values_count",
                    "assignment_settings",
                    "access_permissions",
                    "assignment_permissions"
                  ]
                }
              }
            },
            "required": [
              "id",
              "status",
              "approval_scheduled_date"
            ]
          }
        }
      },
      "required": [
        "uuid",
        "status",
        "is_mass_edit",
        "approval_scheduled_date",
        "author",
        "form_instance",
        "scheduled_approvals"
      ],
      "additionalProperties": false
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Show item
GET/scheduled-approvals/{uuid}/items/{id}{?include}

Fetch single scheduled approval item.

Example URI

GET https://rest.monportailrh.com/scheduled-approvals/123/items/123?include=author
URI Parameters
HideShow
uuid
number (required) Example: 123

Uuid of the Scheduled Approval batch.

id
number (required) Example: 123

Id of the Scheduled Approval item.

include
string (optional) Example: author

Comma separated list of related resources that will be included into response. Possible values:

  • author

  • form_instance

  • fields

  • fields.type

  • fields.category

  • fields.category.pso_type

  • fields.domains

  • fields.domains.pso_type

  • fields.pso_type

  • fields.items

  • fields.options

Note that includes uses kind of inheritance. So if you put include=fields.items.type it will also populate items property for all fields

If you need to dive into and include related resources for sub-items you can use same options that fields property has.

For example: include=fields.items.type will attach to the response all fields that assignment has.
Every included field will have items property populated. Every item in items property will have type property populated

But, note: Unlike other forms with values array, “values” of composite will contain the structured tree of all subfields values.

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: '*'
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": 1,
    "status": "pending",
    "approval_scheduled_date": "2019-04-24 11:47:47",
    "pso": {
      "id": 1,
      "external_id": 1,
      "first_name": "John",
      "last_name": "Snow",
      "username": "john_snow",
      "professional_email": "jsnow@example.com",
      "professional_mobile_phone": "00 33 1 40 00 00 00",
      "professional_phone": "00 33 1 40 00 00 00",
      "role": [
        "bastard",
        "king"
      ],
      "is_active": true,
      "status": "remote",
      "settings": [
        "[]"
      ],
      "user_photo": "http://example.com/images/1.jpg"
    },
    "fields": [
      {
        "id": 1,
        "name": "Field Name",
        "position": 5,
        "alias": "usr_first_name",
        "has_unique_data": false,
        "has_value": true,
        "removable": false,
        "is_active": true,
        "list": false,
        "read_only": false,
        "required": true,
        "type": {
          "id": 1,
          "name": "Data Type Name",
          "alias": "data_type_alias",
          "settings": [
            {
              "id": 1,
              "name": "Data Type Setting Name",
              "alias": "data_type_setting_alias",
              "is_required": true
            }
          ],
          "supports_collection": false,
          "supports_read_only": false,
          "supports_unique": false
        },
        "category": {
          "id": 32,
          "alias": "usr_identity",
          "position": 5,
          "system_required": true,
          "name": "Identity",
          "description": "...",
          "is_active": true,
          "pso_type": {
            "id": 56,
            "name": "User",
            "alias": "usr",
            "description": "...",
            "is_active": true,
            "system_required": true,
            "creation_form_instance_id": 1,
            "profile_form_instance_id": 1
          }
        },
        "domains": [
          {
            "id": 46,
            "alias": "usr_global",
            "name": "User Global",
            "description": "...",
            "is_editable": false,
            "is_removable": false,
            "is_active": true,
            "pso_type": {
              "id": 56,
              "name": "User",
              "alias": "usr",
              "description": "...",
              "is_active": true,
              "system_required": true,
              "creation_form_instance_id": 1,
              "profile_form_instance_id": 1
            }
          }
        ],
        "privacy_level": {
          "id": 123,
          "alias": "public",
          "name": "Not Sensitive",
          "level": 100
        },
        "pso_type": {
          "id": 56,
          "name": "User",
          "alias": "usr",
          "description": "...",
          "is_active": true,
          "system_required": true,
          "creation_form_instance_id": 1,
          "profile_form_instance_id": 1
        },
        "items": [
          {
            "id": 1,
            "name": "Field Name",
            "position": 5,
            "alias": "usr_first_name",
            "has_unique_data": false,
            "has_value": true,
            "removable": false,
            "is_active": true,
            "list": false,
            "read_only": false,
            "required": true,
            "user_required": true,
            "system_required": true,
            "type": {
              "id": 1,
              "name": "Data Type Name",
              "alias": "data_type_alias",
              "settings": [
                {
                  "id": 1,
                  "name": "Data Type Setting Name",
                  "alias": "data_type_setting_alias",
                  "is_required": true
                }
              ],
              "supports_collection": false,
              "supports_read_only": false,
              "supports_unique": false
            },
            "category": {
              "id": 32,
              "alias": "usr_identity",
              "position": 5,
              "system_required": true,
              "name": "Identity",
              "description": "...",
              "is_active": true,
              "pso_type": {
                "id": 56,
                "name": "User",
                "alias": "usr",
                "description": "...",
                "is_active": true,
                "system_required": true,
                "creation_form_instance_id": 1,
                "profile_form_instance_id": 1
              }
            },
            "domains": [
              {
                "id": 46,
                "alias": "usr_global",
                "name": "User Global",
                "description": "...",
                "is_editable": false,
                "is_removable": false,
                "is_active": true,
                "pso_type": {
                  "id": 56,
                  "name": "User",
                  "alias": "usr",
                  "description": "...",
                  "is_active": true,
                  "system_required": true,
                  "creation_form_instance_id": 1,
                  "profile_form_instance_id": 1
                }
              }
            ],
            "privacy_level": {
              "id": 123,
              "alias": "public",
              "name": "Not Sensitive",
              "level": 100
            },
            "pso_type": {
              "id": 56,
              "name": "User",
              "alias": "usr",
              "description": "...",
              "is_active": true,
              "system_required": true,
              "creation_form_instance_id": 1,
              "profile_form_instance_id": 1
            },
            "items": [
              {}
            ],
            "options": [
              {
                "id": 198,
                "name": "Choose me!",
                "position": 9,
                "value": "198",
                "is_active": true,
                "is_selectable": true
              }
            ],
            "settings": [],
            "validation": {
              "type": "regexp",
              "attributes": {},
              "value_example": "string",
              "error_message": {
                "en": "Some text",
                "fr": "Du texte",
                "de": "Setwas Text",
                "es": "Algún texto"
              }
            },
            "has_autocomplete_settings": true,
            "autocomplete_settings": {
              "allow_extra_values": true,
              "autofill": true,
              "provider": {
                "name": {
                  "en": "Some text",
                  "fr": "Du texte",
                  "de": "Setwas Text",
                  "es": "Algún texto"
                },
                "alias": "string",
                "base_url": "https://exmaple.com/",
                "single_value_supported": true,
                "parameters": [
                  {
                    "name": "Name",
                    "key": "alias",
                    "required": true
                  }
                ]
              },
              "parameters": [
                {
                  "name": "Name",
                  "key": "alias",
                  "required": true,
                  "value": "value",
                  "field": {
                    "id": 1,
                    "name": "Field Name",
                    "alias": "usr_first_name",
                    "value": "RU",
                    "root_field": {
                      "id": 1,
                      "name": "Field Name",
                      "alias": "usr_first_name",
                      "value": "RU",
                      "root_field": "null"
                    }
                  }
                }
              ]
            }
          }
        ],
        "options": [
          {
            "id": 198,
            "name": "Choose me!",
            "position": 9,
            "value": "198",
            "is_active": true,
            "is_selectable": true
          }
        ],
        "settings": [],
        "is_locked": false,
        "value_details": [
          "value1",
          "value2"
        ],
        "values_count": 2,
        "assignment_settings": [
          {
            "setting": "public",
            "value": "1"
          }
        ],
        "access_permissions": {
          "history": true,
          "view": true,
          "edit": true
        },
        "assignment_permissions": {
          "permissions": {
            "id": 1,
            "name": "View",
            "alias": "view"
          },
          "access_list": [
            "0",
            "1",
            "1"
          ]
        }
      }
    ]
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "status": {
          "type": "string",
          "enum": [
            "pending",
            "done",
            "failed"
          ]
        },
        "approval_scheduled_date": {
          "type": "string"
        },
        "pso": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number"
            },
            "external_id": {
              "type": "number"
            },
            "first_name": {
              "type": "string"
            },
            "last_name": {
              "type": "string"
            },
            "username": {
              "type": "string"
            },
            "professional_email": {
              "type": "string"
            },
            "professional_mobile_phone": {
              "type": "string"
            },
            "professional_phone": {
              "type": "string"
            },
            "role": {
              "type": "array"
            },
            "is_active": {
              "type": "boolean"
            },
            "status": {
              "type": "string"
            },
            "settings": {
              "type": "array"
            },
            "user_photo": {
              "type": "string"
            }
          },
          "required": [
            "id",
            "external_id",
            "first_name",
            "last_name",
            "username",
            "professional_email",
            "professional_mobile_phone",
            "professional_phone",
            "role",
            "is_active",
            "status",
            "settings",
            "user_photo"
          ],
          "additionalProperties": false
        },
        "fields": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number"
              },
              "name": {
                "type": "string"
              },
              "position": {
                "type": "number"
              },
              "alias": {
                "type": "string"
              },
              "has_unique_data": {
                "type": "boolean",
                "description": "whether field requires values to be unique across system"
              },
              "has_value": {
                "type": "boolean",
                "description": "whether field has at least one value submitted"
              },
              "removable": {
                "type": "boolean",
                "description": "whether field can be removed from system"
              },
              "is_active": {
                "type": "boolean"
              },
              "list": {
                "type": "boolean",
                "description": "whether field can handle collection of values"
              },
              "read_only": {
                "type": "boolean",
                "description": "whether field value can be changed"
              },
              "required": {
                "type": "boolean",
                "description": "whether field value required by system"
              },
              "type": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "number"
                  },
                  "name": {
                    "type": "string"
                  },
                  "alias": {
                    "type": "string"
                  },
                  "settings": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "number"
                        },
                        "name": {
                          "type": "string"
                        },
                        "alias": {
                          "type": "string"
                        },
                        "is_required": {
                          "type": "boolean"
                        }
                      },
                      "required": [
                        "id",
                        "name",
                        "alias",
                        "is_required"
                      ]
                    }
                  },
                  "supports_collection": {
                    "type": "boolean"
                  },
                  "supports_read_only": {
                    "type": "boolean"
                  },
                  "supports_unique": {
                    "type": "boolean"
                  }
                },
                "required": [
                  "id",
                  "name",
                  "alias",
                  "settings",
                  "supports_collection",
                  "supports_read_only",
                  "supports_unique"
                ],
                "additionalProperties": false
              },
              "category": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "number"
                  },
                  "alias": {
                    "type": "string"
                  },
                  "position": {
                    "type": "number"
                  },
                  "system_required": {
                    "type": "boolean"
                  },
                  "name": {
                    "type": "string"
                  },
                  "description": {
                    "type": "string"
                  },
                  "is_active": {
                    "type": "boolean"
                  },
                  "pso_type": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "number"
                      },
                      "name": {
                        "type": "string"
                      },
                      "alias": {
                        "type": "string"
                      },
                      "description": {
                        "type": "string"
                      },
                      "is_active": {
                        "type": "boolean"
                      },
                      "system_required": {
                        "type": "boolean"
                      },
                      "creation_form_instance_id": {
                        "type": "number"
                      },
                      "profile_form_instance_id": {
                        "type": "number"
                      }
                    },
                    "required": [
                      "id",
                      "name",
                      "alias",
                      "description",
                      "is_active",
                      "system_required",
                      "creation_form_instance_id",
                      "profile_form_instance_id"
                    ],
                    "additionalProperties": false,
                    "description": "Presented only if `include` was send"
                  }
                },
                "required": [
                  "id",
                  "alias",
                  "position",
                  "system_required",
                  "name",
                  "description",
                  "is_active"
                ],
                "additionalProperties": false
              },
              "domains": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "number"
                    },
                    "alias": {
                      "type": "string"
                    },
                    "name": {
                      "type": "string"
                    },
                    "description": {
                      "type": "string"
                    },
                    "is_editable": {
                      "type": "boolean"
                    },
                    "is_removable": {
                      "type": "boolean"
                    },
                    "is_active": {
                      "type": "boolean"
                    },
                    "pso_type": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "number"
                        },
                        "name": {
                          "type": "string"
                        },
                        "alias": {
                          "type": "string"
                        },
                        "description": {
                          "type": "string"
                        },
                        "is_active": {
                          "type": "boolean"
                        },
                        "system_required": {
                          "type": "boolean"
                        },
                        "creation_form_instance_id": {
                          "type": "number"
                        },
                        "profile_form_instance_id": {
                          "type": "number"
                        }
                      },
                      "required": [
                        "id",
                        "name",
                        "alias",
                        "description",
                        "is_active",
                        "system_required",
                        "creation_form_instance_id",
                        "profile_form_instance_id"
                      ],
                      "additionalProperties": false
                    }
                  },
                  "required": [
                    "id",
                    "alias",
                    "name",
                    "description",
                    "is_editable",
                    "is_removable",
                    "is_active"
                  ]
                }
              },
              "privacy_level": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "number"
                  },
                  "alias": {
                    "type": "string"
                  },
                  "name": {
                    "type": "string"
                  },
                  "level": {
                    "type": "number"
                  }
                },
                "required": [
                  "id",
                  "alias",
                  "name",
                  "level"
                ],
                "additionalProperties": false
              },
              "pso_type": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "number"
                  },
                  "name": {
                    "type": "string"
                  },
                  "alias": {
                    "type": "string"
                  },
                  "description": {
                    "type": "string"
                  },
                  "is_active": {
                    "type": "boolean"
                  },
                  "system_required": {
                    "type": "boolean"
                  },
                  "creation_form_instance_id": {
                    "type": "number"
                  },
                  "profile_form_instance_id": {
                    "type": "number"
                  }
                },
                "required": [
                  "id",
                  "name",
                  "alias",
                  "description",
                  "is_active",
                  "system_required",
                  "creation_form_instance_id",
                  "profile_form_instance_id"
                ],
                "additionalProperties": false
              },
              "items": {
                "type": [
                  "array",
                  "null"
                ],
                "items": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "number"
                    },
                    "name": {
                      "type": "string"
                    },
                    "position": {
                      "type": "number"
                    },
                    "alias": {
                      "type": "string"
                    },
                    "has_unique_data": {
                      "type": "boolean",
                      "description": "whether field requires values to be unique across system"
                    },
                    "has_value": {
                      "type": "boolean",
                      "description": "whether field has at least one value submitted"
                    },
                    "removable": {
                      "type": "boolean",
                      "description": "whether field can be removed from system"
                    },
                    "is_active": {
                      "type": "boolean"
                    },
                    "list": {
                      "type": "boolean",
                      "description": "whether field can handle collection of values"
                    },
                    "read_only": {
                      "type": "boolean",
                      "description": "whether field value can be changed"
                    },
                    "required": {
                      "type": "boolean",
                      "description": "deprecated setting"
                    },
                    "user_required": {
                      "type": "boolean",
                      "description": "whether field value required by user"
                    },
                    "system_required": {
                      "type": "boolean",
                      "description": "whether field value required by system"
                    },
                    "type": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "number"
                        },
                        "name": {
                          "type": "string"
                        },
                        "alias": {
                          "type": "string"
                        },
                        "settings": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "number"
                              },
                              "name": {
                                "type": "string"
                              },
                              "alias": {
                                "type": "string"
                              },
                              "is_required": {
                                "type": "boolean"
                              }
                            },
                            "required": [
                              "id",
                              "name",
                              "alias",
                              "is_required"
                            ]
                          }
                        },
                        "supports_collection": {
                          "type": "boolean"
                        },
                        "supports_read_only": {
                          "type": "boolean"
                        },
                        "supports_unique": {
                          "type": "boolean"
                        }
                      },
                      "required": [
                        "id",
                        "name",
                        "alias",
                        "settings",
                        "supports_collection",
                        "supports_read_only",
                        "supports_unique"
                      ],
                      "additionalProperties": false
                    },
                    "category": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "number"
                        },
                        "alias": {
                          "type": "string"
                        },
                        "position": {
                          "type": "number"
                        },
                        "system_required": {
                          "type": "boolean"
                        },
                        "name": {
                          "type": "string"
                        },
                        "description": {
                          "type": "string"
                        },
                        "is_active": {
                          "type": "boolean"
                        },
                        "pso_type": {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "number"
                            },
                            "name": {
                              "type": "string"
                            },
                            "alias": {
                              "type": "string"
                            },
                            "description": {
                              "type": "string"
                            },
                            "is_active": {
                              "type": "boolean"
                            },
                            "system_required": {
                              "type": "boolean"
                            },
                            "creation_form_instance_id": {
                              "type": "number"
                            },
                            "profile_form_instance_id": {
                              "type": "number"
                            }
                          },
                          "required": [
                            "id",
                            "name",
                            "alias",
                            "description",
                            "is_active",
                            "system_required",
                            "creation_form_instance_id",
                            "profile_form_instance_id"
                          ],
                          "additionalProperties": false,
                          "description": "Presented only if `include` was send"
                        }
                      },
                      "required": [
                        "id",
                        "alias",
                        "position",
                        "system_required",
                        "name",
                        "description",
                        "is_active"
                      ],
                      "additionalProperties": false
                    },
                    "domains": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "number"
                          },
                          "alias": {
                            "type": "string"
                          },
                          "name": {
                            "type": "string"
                          },
                          "description": {
                            "type": "string"
                          },
                          "is_editable": {
                            "type": "boolean"
                          },
                          "is_removable": {
                            "type": "boolean"
                          },
                          "is_active": {
                            "type": "boolean"
                          },
                          "pso_type": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "number"
                              },
                              "name": {
                                "type": "string"
                              },
                              "alias": {
                                "type": "string"
                              },
                              "description": {
                                "type": "string"
                              },
                              "is_active": {
                                "type": "boolean"
                              },
                              "system_required": {
                                "type": "boolean"
                              },
                              "creation_form_instance_id": {
                                "type": "number"
                              },
                              "profile_form_instance_id": {
                                "type": "number"
                              }
                            },
                            "required": [
                              "id",
                              "name",
                              "alias",
                              "description",
                              "is_active",
                              "system_required",
                              "creation_form_instance_id",
                              "profile_form_instance_id"
                            ],
                            "additionalProperties": false
                          }
                        },
                        "required": [
                          "id",
                          "alias",
                          "name",
                          "description",
                          "is_editable",
                          "is_removable",
                          "is_active"
                        ]
                      }
                    },
                    "privacy_level": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "number"
                        },
                        "alias": {
                          "type": "string"
                        },
                        "name": {
                          "type": "string"
                        },
                        "level": {
                          "type": "number"
                        }
                      },
                      "required": [
                        "id",
                        "alias",
                        "name",
                        "level"
                      ],
                      "additionalProperties": false
                    },
                    "pso_type": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "number"
                        },
                        "name": {
                          "type": "string"
                        },
                        "alias": {
                          "type": "string"
                        },
                        "description": {
                          "type": "string"
                        },
                        "is_active": {
                          "type": "boolean"
                        },
                        "system_required": {
                          "type": "boolean"
                        },
                        "creation_form_instance_id": {
                          "type": "number"
                        },
                        "profile_form_instance_id": {
                          "type": "number"
                        }
                      },
                      "required": [
                        "id",
                        "name",
                        "alias",
                        "description",
                        "is_active",
                        "system_required",
                        "creation_form_instance_id",
                        "profile_form_instance_id"
                      ],
                      "additionalProperties": false
                    },
                    "items": {
                      "type": [
                        "array",
                        "null"
                      ],
                      "items": {
                        "type": "object",
                        "properties": {}
                      }
                    },
                    "options": {
                      "type": [
                        "array",
                        "null"
                      ],
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "number"
                          },
                          "name": {
                            "type": "string"
                          },
                          "position": {
                            "type": "number"
                          },
                          "value": {
                            "type": "string"
                          },
                          "is_active": {
                            "type": "boolean"
                          },
                          "is_selectable": {
                            "type": "boolean",
                            "description": "Can select on front this option (Using only in Hierarchy field))"
                          }
                        },
                        "required": [
                          "id",
                          "name",
                          "position",
                          "value",
                          "is_active",
                          "is_selectable"
                        ]
                      },
                      "description": "List of options with possible (allowed) values."
                    },
                    "settings": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      },
                      "description": "Common field settings"
                    },
                    "validation": {
                      "type": "object",
                      "properties": {
                        "type": {
                          "type": "string"
                        },
                        "attributes": {
                          "type": "object",
                          "properties": {}
                        },
                        "value_example": {
                          "type": "string"
                        },
                        "error_message": {
                          "type": "object",
                          "properties": {
                            "en": {
                              "type": "string"
                            },
                            "fr": {
                              "type": "string"
                            },
                            "de": {
                              "type": "string"
                            },
                            "es": {
                              "type": "string"
                            }
                          },
                          "required": [
                            "en",
                            "fr",
                            "de",
                            "es"
                          ]
                        }
                      },
                      "required": [
                        "type",
                        "value_example",
                        "error_message"
                      ]
                    },
                    "has_autocomplete_settings": {
                      "type": "boolean"
                    },
                    "autocomplete_settings": {
                      "type": "object",
                      "properties": {
                        "allow_extra_values": {
                          "type": "boolean"
                        },
                        "autofill": {
                          "type": "boolean"
                        },
                        "provider": {
                          "type": "object",
                          "properties": {
                            "name": {
                              "type": "object",
                              "properties": {
                                "en": {
                                  "type": "string"
                                },
                                "fr": {
                                  "type": "string"
                                },
                                "de": {
                                  "type": "string"
                                },
                                "es": {
                                  "type": "string"
                                }
                              },
                              "required": [
                                "en",
                                "fr",
                                "de",
                                "es"
                              ]
                            },
                            "alias": {
                              "type": "string"
                            },
                            "base_url": {
                              "type": "string"
                            },
                            "single_value_supported": {
                              "type": "boolean"
                            },
                            "parameters": {
                              "type": "array"
                            }
                          },
                          "required": [
                            "name",
                            "alias",
                            "base_url",
                            "single_value_supported",
                            "parameters"
                          ]
                        },
                        "parameters": {
                          "type": "array"
                        }
                      },
                      "required": [
                        "allow_extra_values",
                        "autofill",
                        "provider",
                        "parameters"
                      ]
                    }
                  },
                  "required": [
                    "id",
                    "name",
                    "position",
                    "alias",
                    "has_unique_data",
                    "has_value",
                    "removable",
                    "is_active",
                    "list",
                    "read_only",
                    "required",
                    "user_required",
                    "system_required",
                    "validation",
                    "has_autocomplete_settings",
                    "autocomplete_settings"
                  ]
                }
              },
              "options": {
                "type": [
                  "array",
                  "null"
                ],
                "items": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "number"
                    },
                    "name": {
                      "type": "string"
                    },
                    "position": {
                      "type": "number"
                    },
                    "value": {
                      "type": "string"
                    },
                    "is_active": {
                      "type": "boolean"
                    },
                    "is_selectable": {
                      "type": "boolean",
                      "description": "Can select on front this option (Using only in Hierarchy field))"
                    }
                  },
                  "required": [
                    "id",
                    "name",
                    "position",
                    "value",
                    "is_active",
                    "is_selectable"
                  ]
                },
                "description": "List of options with possible (allowed) values."
              },
              "settings": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": "Common field settings"
              },
              "is_locked": {
                "type": "boolean"
              },
              "value_details": {
                "type": "array"
              },
              "values_count": {
                "type": "number"
              },
              "assignment_settings": {
                "type": "array"
              },
              "access_permissions": {
                "type": "object",
                "properties": {
                  "history": {
                    "type": "boolean"
                  },
                  "view": {
                    "type": "boolean"
                  },
                  "edit": {
                    "type": "boolean"
                  }
                },
                "required": [
                  "history",
                  "view",
                  "edit"
                ]
              },
              "assignment_permissions": {
                "type": "object",
                "properties": {
                  "permissions": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "number"
                      },
                      "name": {
                        "type": "string"
                      },
                      "alias": {
                        "type": "string"
                      }
                    },
                    "required": [
                      "id",
                      "name",
                      "alias"
                    ]
                  },
                  "access_list": {
                    "type": "array",
                    "description": "user, manager, hr"
                  }
                },
                "required": [
                  "permissions",
                  "access_list"
                ]
              }
            },
            "required": [
              "id",
              "name",
              "position",
              "alias",
              "has_unique_data",
              "has_value",
              "removable",
              "is_active",
              "list",
              "read_only",
              "required",
              "is_locked",
              "value_details",
              "values_count",
              "assignment_settings",
              "access_permissions",
              "assignment_permissions"
            ]
          }
        }
      },
      "required": [
        "id",
        "status",
        "approval_scheduled_date",
        "pso",
        "fields"
      ],
      "additionalProperties": false
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete batch
DELETE/scheduled-approvals/{uuid}

Delete all scheduled approvals in mass edit batch

Example URI

DELETE https://rest.monportailrh.com/scheduled-approvals/123
URI Parameters
HideShow
uuid
number (required) Example: 123

Uuid of the Scheduled Approval batch.

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: '*'
Response  204
HideShow
Headers
Content-Type: application/json
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delete item
DELETE/scheduled-approvals/{uuid}/items/{id}

Delete scheduled approval item

Example URI

DELETE https://rest.monportailrh.com/scheduled-approvals/123/items/123
URI Parameters
HideShow
uuid
number (required) Example: 123

Uuid of the Scheduled Approval batch.

id
number (required) Example: 123

Id of the Scheduled Approval item.

Request
HideShow
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: '*'
Response  204
HideShow
Headers
Content-Type: application/json
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Delegation Center

Ability to delegate permissions from one user to another

Me rules

Me Rules
GET/me/delegation-rules

Get my rules

Example URI

GET https://rest.monportailrh.com/me/delegation-rules
Request
HideShow

  • Permissions

    delegation_rules.user
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "alias": "form",
      "name": "Form",
      "rules": [
        {
          "id": 1,
          "delegate_to": 0,
          "start_date": "2020-01-01",
          "end_date": "null",
          "type": "period"
        }
      ]
    },
    {
      "alias": "other",
      "name": "Other",
      "rules": [
        {
          "id": 1,
          "delegate_to": 0,
          "start_date": "2020-01-01",
          "end_date": "null",
          "type": "period"
        }
      ]
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": [
        {
          "type": "object",
          "properties": {
            "alias": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "rules": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "number"
                  },
                  "delegate_to": {
                    "type": "number"
                  },
                  "start_date": {
                    "type": "string"
                  },
                  "end_date": {
                    "type": [
                      "string",
                      "null"
                    ]
                  },
                  "type": {
                    "type": "string",
                    "enum": [
                      "period",
                      "permanent"
                    ]
                  }
                }
              }
            }
          }
        },
        {
          "type": "object",
          "properties": {
            "alias": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "rules": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "number"
                  },
                  "delegate_to": {
                    "type": "number"
                  },
                  "start_date": {
                    "type": "string"
                  },
                  "end_date": {
                    "type": [
                      "string",
                      "null"
                    ]
                  },
                  "type": {
                    "type": "string",
                    "enum": [
                      "period",
                      "permanent"
                    ]
                  }
                }
              }
            }
          }
        }
      ]
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Me Store All
PUT/me/delegation-rules/all

Store delegation rules for all categories

Example URI

PUT https://rest.monportailrh.com/me/delegation-rules/all
Request
HideShow

  • Permissions

    delegation_rules.user
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Body
[
  {
    "delegate_to": 0,
    "start_date": "2020-01-01",
    "end_date": "2020-01-01",
    "type": "period"
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}
Response  201
HideShow
Headers
Content-Type: application/json
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Me Store For Category
PUT/me/delegation-rules/{category}

Store delegation rules for category

Example URI

PUT https://rest.monportailrh.com/me/delegation-rules/form
URI Parameters
HideShow
category
form,other (required) Example: form

Action category alias.

Request
HideShow

  • Permissions

    delegation_rules.user
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Body
[
  {
    "delegate_to": 0,
    "start_date": "2020-01-01",
    "end_date": "2020-01-01",
    "type": "period"
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}
Response  201
HideShow
Headers
Content-Type: application/json
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

User rules

User Rules
GET/user/{user}/delegation-rules

Get user’s rules

Example URI

GET https://rest.monportailrh.com/user/1/delegation-rules
URI Parameters
HideShow
user
number (required) Example: 1
Request
HideShow

  • Permissions

    delegation_rules.admin
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "alias": "form",
      "name": "Form",
      "rules": [
        {
          "id": 1,
          "delegate_to": 0,
          "start_date": "2020-01-01",
          "end_date": "null",
          "type": "period"
        }
      ]
    },
    {
      "alias": "other",
      "name": "Other",
      "rules": [
        {
          "id": 1,
          "delegate_to": 0,
          "start_date": "2020-01-01",
          "end_date": "null",
          "type": "period"
        }
      ]
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": [
        {
          "type": "object",
          "properties": {
            "alias": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "rules": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "number"
                  },
                  "delegate_to": {
                    "type": "number"
                  },
                  "start_date": {
                    "type": "string"
                  },
                  "end_date": {
                    "type": [
                      "string",
                      "null"
                    ]
                  },
                  "type": {
                    "type": "string",
                    "enum": [
                      "period",
                      "permanent"
                    ]
                  }
                }
              }
            }
          }
        },
        {
          "type": "object",
          "properties": {
            "alias": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "rules": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "number"
                  },
                  "delegate_to": {
                    "type": "number"
                  },
                  "start_date": {
                    "type": "string"
                  },
                  "end_date": {
                    "type": [
                      "string",
                      "null"
                    ]
                  },
                  "type": {
                    "type": "string",
                    "enum": [
                      "period",
                      "permanent"
                    ]
                  }
                }
              }
            }
          }
        }
      ]
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

User Store All
PUT/users/{user}/delegation-rules/all

Store delegation rules for all categories

Example URI

PUT https://rest.monportailrh.com/users/1/delegation-rules/all
URI Parameters
HideShow
user
number (required) Example: 1
Request
HideShow

  • Permissions

    delegation_rules.admin
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
Body
[
  {
    "delegate_to": 0,
    "start_date": "2020-01-01",
    "end_date": "2020-01-01",
    "type": "period"
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}
Response  201
HideShow
Headers
Content-Type: application/json
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

User Store For Category
PUT/users/{user}/delegation-rules/{category}

Store delegation rules for category

Example URI

PUT https://rest.monportailrh.com/users/1/delegation-rules/form
URI Parameters
HideShow
user
number (required) Example: 1
category
form,other (required) Example: form

Action category alias.

Request
HideShow

  • Permissions

    delegation_rules.admin
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>
Body
[
  {
    "delegate_to": 0,
    "start_date": "2020-01-01",
    "end_date": "2020-01-01",
    "type": "period"
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}
Response  201
HideShow
Headers
Content-Type: application/json
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 401
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 403
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 404
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  406
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Short description of error reason",
  "status_code": 406
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Descriptive error message",
  "status_code": 422,
  "errors": [
    "Error message",
    "Hello, world!"
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Internal Error",
  "status_code": 500
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "status_code": {
      "type": "number"
    }
  }
}

Generated by aglio on 29 Dec 2021