Responses

FowApi supports OAS3. For this reason, it contains a static api schema. In the schema, the data part changes dynamically based on the endpoint. But the general pattern does not change.

Name	Type	Required	Description
Success	boolean	✅	Information about if proccess resulted successfully or not.
Key	string	✅	Type of response. Also each error has their own key. It's more like error code.
Data	object / Generic<T>	❕	Contains main data of response. Data can be null with some unsuccessful requests.
Meta	object	❌	Metadata about response, like pagination page counts or depricated elements etc.
Message	string	❕	Message about request. Mostly unseuccessful requests have message about it.
IsUserFriendlyMessage	boolean	❌	Indicates if Message comes from resources and readable by directly users or not.

{
  "success": true,
  "items": {
    "totalCount": 1,
    "items": [
      {
        "fullName": "John Doe",
        "firstName": "John",
        "lastName": "Doe",
        "ownerId": 158,
        "uniqueNumber": "720596",
        "id": "3a92791d-e52e-4c5b-9d93-f5c8f8fbbe32",
        "owner": {
          "userName": "furkan.gungor",
          "name": "Furkan",
          "surname": "Güngör",
          "emailAddress": "furkan.gungor@bilgeadam.com",
          "isActive": true,
          "fullName": "Furkan Güngör",
          "creationTime": "2021-10-07T07:43:00.373Z",
          "tenantId": 93,
          "isAuthorizeDisable": false,
          "id": 158
        },
        "periodId": "cc4ec2a5-4753-4379-bcec-ec1adfbb9540",
        "period": {
          "name": "2021-2022",
          "startDate": "2021-01-01T00:00:00Z",
          "endDate": "2024-12-31T00:00:00Z",
          "modelId": "00000000-0000-0000-0000-000000000000",
          "isChangedLastModificationTime": false,
          "isChangedLastModifierUserId": false,
          "creatorUserId": 158,
          "creationTime": "2021-10-07T07:43:22.319Z",
          "isDeleted": false,
          "lastModifierUserId": 158,
          "lastModificationTime": "2021-12-27T12:31:14.998Z",
          "isRunAutomation": true,
          "isRunHandlers": true,
          "id": "cc4ec2a5-4753-4379-bcec-ec1adfbb9540"
        },
        "ownerGroupId": "a2c5cfaf-13b5-4194-b3f3-2fe7f385a7d4",
        "ownerGroup": {
          "userGroupName": "devcompany",
          "isActive": false,
          "tenantId": 93,
          "managerId": 158,
          "modelId": "00000000-0000-0000-0000-000000000000",
          "isChangedLastModificationTime": false,
          "isChangedLastModifierUserId": false,
          "creationTime": "2021-10-07T07:42:58.339Z",
          "isDeleted": false,
          "lastModifierUserId": 158,
          "lastModificationTime": "2021-12-21T11:42:46.109Z",
          "isRunAutomation": true,
          "isRunHandlers": true,
          "id": "a2c5cfaf-13b5-4194-b3f3-2fe7f385a7d4"
        },
        "date": "2022-09-30T12:43:00Z",
        "statusId": "7a12f534-4ff6-4aac-827c-c9816b0a5cef",
        "status": {
          "categoryId": "5cd13a77-9fef-48e7-8488-9c69860ebdc9",
          "code": "New",
          "name": "New",
          "orderIndex": 1,
          "type": "System",
          "modelId": "00000000-0000-0000-0000-000000000000",
          "isChangedLastModificationTime": false,
          "isChangedLastModifierUserId": false,
          "creatorUserId": 158,
          "creationTime": "2021-10-07T07:43:22.567Z",
          "isDeleted": false,
          "lastModificationTime": "2021-10-07T07:43:22.567Z",
          "isRunAutomation": true,
          "isRunHandlers": true,
          "id": "7a12f534-4ff6-4aac-827c-c9816b0a5cef"
        },
        "creationTime": "2022-09-14T13:23:49.899Z",
        "lastModificationTime": "2022-09-14T13:23:49.899Z",
        "creatorUserId": 158,
        "lastModifierUserId": 158,
        "creationUser": {
          "userName": "furkan.gungor",
          "name": "Furkan",
          "surname": "Güngör",
          "emailAddress": "furkan.gungor@bilgeadam.com",
          "isActive": true,
          "fullName": "Furkan Güngör",
          "creationTime": "2021-10-07T07:43:00.373Z",
          "tenantId": 93,
          "isAuthorizeDisable": false,
          "id": 158
        },
        "lastModificationUser": {
          "userName": "furkan.gungor",
          "name": "Furkan",
          "surname": "Güngör",
          "emailAddress": "furkan.gungor@bilgeadam.com",
          "isActive": true,
          "fullName": "Furkan Güngör",
          "creationTime": "2021-10-07T07:43:00.373Z",
          "tenantId": 93,
          "isAuthorizeDisable": false,
          "id": 158
        },
        "stage": "Open",
        "labels": [],
        "authorizeLevel": "AuthorizedOnly",
        "authorizeIds": [
          "158",
          "a2c5cfaf-13b5-4194-b3f3-2fe7f385a7d4"
        ],
        "customFieldString1": "Software Developer",
        "customFieldMultipleSelect1": [],
        "customFieldMultipleSelect2": [],
        "customFieldMultipleSelect3": [],
        "customFieldMultipleSelect4": [],
        "customFieldMultipleSelect5": [],
        "customFieldMultipleSelect6": [],
        "customFieldMultipleSelect7": [],
        "customFieldMultipleSelect8": [],
        "customFieldMultipleSelect9": [],
        "customFieldMultipleSelect10": []
      }
    ]
  }
}