Troubleshooting

12min
Overview
The guide helps developers troubleshoot app and solutions errors using the following APIsL
﻿GetLogs: Retrieves a list of changes made to an app or solution with a given listingId.
﻿GetVersionsDiff: Retrieves the fileId containing the diff between two versions of an app or a solution. 
﻿GetPermissionDiff: Retrieves the permissions difference by versionId and tenantId
﻿GetDiffStatus: Retrieves version or permission diff by statusId
﻿GetOnboardingActivity: Retrieves detailed onboarding logs for a given date range
Retrieve List of Changes
Endpoint: GET /developer/logs/{listingId}﻿
Path Parameters
Parameter
Description
listingId
path
The app or solution listingId.
type*
query
Specifies the type of log.
Available values: APP, SOLUTION
The following returns the event logs for the vehicle-trackers app. 
Example Response
{
    "data": {
        "events": [
            {
                "aggregateId": "app:fb9369b9-5966-57b1-8a40-a409e8531aad",
                "timeStamp": "2023-10-13T04:29:05.035+00:00",
                "type": "AppRegistered",
                "eventData": "{\"appId\":\"app:fb9369b9-5966-57b1-8a40-a409e8531aad\",\"listingId\":\"vehicle-trackers\",\"appVersionId\":\"appversion:4cd20375-cf4d-52c1-b088-1903c46e76c4\",\"coreosAppUrn\":\"platform:app:fb9369b9-5966-57b1-8a40-a409e8531aad\",\"name\":\"vehicle-tracker\",\"urlPath\":\"vehicle-trackers\",\"organizationId\":\"af86b55e-45c9-41ee-95f7-d335d366022f\",\"organizationTeamId\":\"87dd5441-e8c4-4171-ba24-79f47992ba9b\",\"organizationDomain\":\"dpdevsb1\",\"organizationDns\":\"dpdevsb1.sandbox.getos1.com\",\"displayName\":\"Vehicle Tracker\",\"appVersion\":\"1.0.9\",\"clientId\":\"platform:app:service:fb9369b9-5966-57b1-8a40-a409e8531aad\",\"clientSecret\":{\"iv\":\"71c8ddb9f0b6715c9a3e15f2c9107b0d\",\"encryptedText\":\"37487f91ec18bb8b6138fac0a94bcb45fec0279bce9f91195adc44ca7433f84705035772\"},\"phase\":\"DEVELOPMENT\",\"appType\":\"WEB\",\"appDescription\":\"A vehicle tracker that allows you to track your vehicles.\",\"isMarketplaceCompatible\":false,\"isPrivate\":true,\"isConsoleCompatible\":true,\"isActive\":true,\"isDeleted\":false,\"icon\":[{\"id\":{\"fileId\":\"7adcf59e-c5df-418f-8645-e82f2a5231b6\"},\"attributes\":{\"fileName\":\"default_icon.png\",\"filePath\":\"/\",\"fileDescription\":\"Default Icon for Applications\",\"fileUrl\":\"https://cdn.getos1.com/7adcf59e-c5df-418f-8645-e82f2a5231b6-default_icon.png\"}}],\"privacy\":{\"type\":\"PRIVATE\",\"allow\":[\"*\"]},\"appState\":{\"createApp\":\"scheduled\",\"subscribeApp\":\"scheduled\",\"grantPerimssions\":\"scheduled\"},\"urlLinks\":[{\"name\":\"relativePath\",\"url\":\"vehicle-trackers\"},{\"name\":\"admin\",\"url\":\"admin\"},{\"name\":\"gitInfo\",\"url\":\"https://github.com/your-org/your-repo\"},{\"name\":\"interface\",\"url\":\"/\"},{\"name\":\"server\",\"url\":\"your-kubernetes-cluster.svc.cluster.local\"},{\"name\":\"setting\",\"url\":\"settings\"},{\"name\":\"stackId\",\"url\":\"*\"},{\"name\":\"userGuide\",\"url\":\"docs\"}],\"categories\":[\"vehicle\",\"tracking\"],\"createdAt\":\"2023-10-13T04:29:04.195Z\",\"shortDescription\":\"A vehicle tracker that allows you to track your vehicles.\",\"longDescription\":\"Dig deep into the details of your vehicle maintenance schedules as well as locations. Receive notifications when a vehicle hits a maintenance milestone.\",\"appClassification\":\"STANDARD\",\"appNavigation\":{\"menuItems\":[{\"id\":\"30483c6c-ab64-4e30-8e47-3184d3aa5fbc\",\"parentId\":\"\",\"displayName\":\"Inventory\",\"displayOrder\":4,\"relativePath\":\"inventory\"}]},\"hosting\":\"PLATFORM\",\"_event_meta\":{\"schemaVersion\":\"0.0.1\",\"eventType\":\"AppRegistered\",\"producer\":\"Application Service\",\"keyField\":\"appId\"},\"requestId\":\"d9e7ebe6-0530-4de8-a21a-015ef304a23c\",\"eventType\":\"AppRegistered\",\"createdTime\":\"2023-10-13T04:29:04.191Z\",\"version\":0}",
                "eventType": "AppRegistered"
            }
        ]
    },
    "request": {
        "url": "/developer/logs/vehicle-trackers?type=APP",
        "method": "GET",
        "params": {
            "listingId": "vehicle-trackers"
        },
        "query": {
            "type": "APP"
        },
        "body": {}
    }
}
{
    "data": {
        "events": [
            {
                "aggregateId": "app:fb9369b9-5966-57b1-8a40-a409e8531aad",
                "timeStamp": "2023-10-13T04:29:05.035+00:00",
                "type": "AppRegistered",
                "eventData": "{\"appId\":\"app:fb9369b9-5966-57b1-8a40-a409e8531aad\",\"listingId\":\"vehicle-trackers\",\"appVersionId\":\"appversion:4cd20375-cf4d-52c1-b088-1903c46e76c4\",\"coreosAppUrn\":\"platform:app:fb9369b9-5966-57b1-8a40-a409e8531aad\",\"name\":\"vehicle-tracker\",\"urlPath\":\"vehicle-trackers\",\"organizationId\":\"af86b55e-45c9-41ee-95f7-d335d366022f\",\"organizationTeamId\":\"87dd5441-e8c4-4171-ba24-79f47992ba9b\",\"organizationDomain\":\"dpdevsb1\",\"organizationDns\":\"dpdevsb1.sandbox.getos1.com\",\"displayName\":\"Vehicle Tracker\",\"appVersion\":\"1.0.9\",\"clientId\":\"platform:app:service:fb9369b9-5966-57b1-8a40-a409e8531aad\",\"clientSecret\":{\"iv\":\"71c8ddb9f0b6715c9a3e15f2c9107b0d\",\"encryptedText\":\"37487f91ec18bb8b6138fac0a94bcb45fec0279bce9f91195adc44ca7433f84705035772\"},\"phase\":\"DEVELOPMENT\",\"appType\":\"WEB\",\"appDescription\":\"A vehicle tracker that allows you to track your vehicles.\",\"isMarketplaceCompatible\":false,\"isPrivate\":true,\"isConsoleCompatible\":true,\"isActive\":true,\"isDeleted\":false,\"icon\":[{\"id\":{\"fileId\":\"7adcf59e-c5df-418f-8645-e82f2a5231b6\"},\"attributes\":{\"fileName\":\"default_icon.png\",\"filePath\":\"/\",\"fileDescription\":\"Default Icon for Applications\",\"fileUrl\":\"https://cdn.getos1.com/7adcf59e-c5df-418f-8645-e82f2a5231b6-default_icon.png\"}}],\"privacy\":{\"type\":\"PRIVATE\",\"allow\":[\"*\"]},\"appState\":{\"createApp\":\"scheduled\",\"subscribeApp\":\"scheduled\",\"grantPerimssions\":\"scheduled\"},\"urlLinks\":[{\"name\":\"relativePath\",\"url\":\"vehicle-trackers\"},{\"name\":\"admin\",\"url\":\"admin\"},{\"name\":\"gitInfo\",\"url\":\"https://github.com/your-org/your-repo\"},{\"name\":\"interface\",\"url\":\"/\"},{\"name\":\"server\",\"url\":\"your-kubernetes-cluster.svc.cluster.local\"},{\"name\":\"setting\",\"url\":\"settings\"},{\"name\":\"stackId\",\"url\":\"*\"},{\"name\":\"userGuide\",\"url\":\"docs\"}],\"categories\":[\"vehicle\",\"tracking\"],\"createdAt\":\"2023-10-13T04:29:04.195Z\",\"shortDescription\":\"A vehicle tracker that allows you to track your vehicles.\",\"longDescription\":\"Dig deep into the details of your vehicle maintenance schedules as well as locations. Receive notifications when a vehicle hits a maintenance milestone.\",\"appClassification\":\"STANDARD\",\"appNavigation\":{\"menuItems\":[{\"id\":\"30483c6c-ab64-4e30-8e47-3184d3aa5fbc\",\"parentId\":\"\",\"displayName\":\"Inventory\",\"displayOrder\":4,\"relativePath\":\"inventory\"}]},\"hosting\":\"PLATFORM\",\"_event_meta\":{\"schemaVersion\":\"0.0.1\",\"eventType\":\"AppRegistered\",\"producer\":\"Application Service\",\"keyField\":\"appId\"},\"requestId\":\"d9e7ebe6-0530-4de8-a21a-015ef304a23c\",\"eventType\":\"AppRegistered\",\"createdTime\":\"2023-10-13T04:29:04.191Z\",\"version\":0}",
                "eventType": "AppRegistered"
            }
        ]
    },
    "request": {
        "url": "/developer/logs/vehicle-trackers?type=APP",
        "method": "GET",
        "params": {
            "listingId": "vehicle-trackers"
        },
        "query": {
            "type": "APP"
        },
        "body": {}
    }
}
﻿
﻿
﻿Async Response﻿
The Get Versions Diff APIs support asynchronous responses under specific conditions. This enhancement ensures efficient processing when comparing different versions between two solutions. For comparisons between two applications, the response remains synchronous. 
Retrieve Version Diffs
Developers can use the following endpoint to get the HTML diff. 
Endpoint: GET /developer/versionsdiff/{versionId1}/{versionId2}﻿
Path Parameters
Parameter
Description
versionId1
The first version of the app or solution.
versionId2
The second version of the app or solution.
type
query
Specifies the type of version IDs.
Available values: APP, SOLUTION
Response details
App types
Different types
Solution types
If versionId1 and versionId2 are both app types, then the API returns an HTML diff. 
If versionId1 & versionId2 are different types, then the API returns a statusId.
JSON
{
    "statusId": "d41aa81e-c669-461f-a45c-06dadfc22c12"
}
{
    "statusId": "d41aa81e-c669-461f-a45c-06dadfc22c12"
}
﻿
If versionId1 & versionId2 are both solution types, then the API returns a statusId.
JSON
{
    "statusId": "d41aa81e-c669-461f-a45c-06dadfc22c12"
}
{
    "statusId": "d41aa81e-c669-461f-a45c-06dadfc22c12"
}
﻿
﻿
Retrieve Permission Diff
Developers can use the following endpoint to get the HTML diff. 
Endpoint: GET /developer/permissionsdiff/{tenantId}/{versionId}﻿
Path Parameters
Parameter
Description
tenantId
The tenant of the app or solution.
versionId
The version of the app or solution.
Response details
App types
Different types
Solution types
If the versionId is an app type, then the API returns an HTML diff. 
If the tenantId and versionId are different types, then the API returns the following JSON:
JSON
{
    "response": {
        "statusCode": 400,
        "message": "version id does not belong to app or solution",
        "error": "Bad Request"
    },
    "status": 400,
    "options": {},
    "message": "version id does not belong to app or solution",
    "name": "BadRequestException"
}

{
    "response": {
        "statusCode": 400,
        "message": "version id does not belong to app or solution",
        "error": "Bad Request"
    },
    "status": 400,
    "options": {},
    "message": "version id does not belong to app or solution",
    "name": "BadRequestException"
}
﻿
If tenantId & versionId are both solution types, then the API returns a statusId.
JSON
{
    "statusId": "d41aa81e-c669-461f-a45c-06dadfc22c12"
}
{
    "statusId": "d41aa81e-c669-461f-a45c-06dadfc22c12"
}
﻿
Retrieve Version or Permission Diff Status
Endpoint: GET /developer/diff/{statusId}﻿
Developers can use this endpoint and pass the statusId to get the HTML diff for solutions.
Path Parameters
Parameter
Description
statusId
The unique Id of the diff or permission status. 
Response details
Upon success, the API will return a 200 status with an HTML diff. 
However, if there is no diff, then the the API returns a NOT FOUND or FAILURE status. A failure can occur if the solutionId provided does not belong to any solution or an error occurred while creating the file.
Retrieve App and Solution Onboarding Activity Logs
Endpoint: GET /developer/onboarding/logs﻿
Developers can use the GetOnboardingActivity retrieve detailed onboarding logs for a given date range based on the following parameters:
 tenantId: The id for the tenant.
itemId: The appId or solutionId.
versionId: The appversion or solutionversion
Example request
The following example requests logs using a tenantId and date range. 
Curl
curl --location 'https://api.os1.delhivery.com/developer/onboarding/logs?tenantId=OS1Dev&from=2024-05-10&to=2024-05-30' \
--header 'x-developerplatform-access: YOUR_ACCESS_TOKEN'
curl --location 'https://api.os1.delhivery.com/developer/onboarding/logs?tenantId=OS1Dev&from=2024-05-10&to=2024-05-30' \
--header 'x-developerplatform-access: YOUR_ACCESS_TOKEN'
﻿
Example response
The response contains an array of logs with two onboarding activity objects for the OS1Dev tenant within the specified date range. 
The first activity log shows a FAILED status due to the Solution manifest file missing, while the second object represents a successful solution onboarding.  
JSON
{
  "logs": [
    {
      "tenantId": "OS1Dev",
      "itemId": "solution:628cae37-d549-40c1-a066-ab530fa2ae51",
      "versionId": "solutionversion:23c74dbd-b197-4525-ac82-e75e07c125bf",
      "timestamp": "2024-04-27T14:15:30.000Z",
      "statusId": "3f0183bc-22e1-4552-bfae-c9n5j7a6p2q9",
      "status": "FAILED",
      "onboardingType": "solution",
      "requestedBy": {
        "userId": "v296km174",
        "email": "[email protected]"
      },
      "error": "Solution manifest file is invalid"
    },
    {
      "tenantId": "OS1Dev",
      "itemId": "solution:628cae37-d549-40c1-a066-ab530fa2ae51",
      "versionId": "solutionversion:7f93c1e5-9a2d-4b8c-9d3e-6h8j4k2l7m5",
      "timestamp": "2024-04-28T09:45:00.000Z",
      "statusId": "8a1p6f9q-4r3s-4t5u-6v7w-8x9y0z1a2b3",
      "status": "COMPLETED",
      "onboardingType": "solution",
      "requestedBy": {
        "userId": "v296km174",
        "email": "[email protected]"
      },
      "error": null
    }
  ]
}
{
  "logs": [
    {
      "tenantId": "OS1Dev",
      "itemId": "solution:628cae37-d549-40c1-a066-ab530fa2ae51",
      "versionId": "solutionversion:23c74dbd-b197-4525-ac82-e75e07c125bf",
      "timestamp": "2024-04-27T14:15:30.000Z",
      "statusId": "3f0183bc-22e1-4552-bfae-c9n5j7a6p2q9",
      "status": "FAILED",
      "onboardingType": "solution",
      "requestedBy": {
        "userId": "v296km174",
        "email": "jane.smith@acme.com"
      },
      "error": "Solution manifest file is invalid"
    },
    {
      "tenantId": "OS1Dev",
      "itemId": "solution:628cae37-d549-40c1-a066-ab530fa2ae51",
      "versionId": "solutionversion:7f93c1e5-9a2d-4b8c-9d3e-6h8j4k2l7m5",
      "timestamp": "2024-04-28T09:45:00.000Z",
      "statusId": "8a1p6f9q-4r3s-4t5u-6v7w-8x9y0z1a2b3",
      "status": "COMPLETED",
      "onboardingType": "solution",
      "requestedBy": {
        "userId": "v296km174",
        "email": "jane.smith@acme.com"
      },
      "error": null
    }
  ]
}
﻿
﻿
﻿
﻿
Parameter	Description
listingId path	The app or solution listingId.
type* query	Specifies the type of log. Available values: APP, SOLUTION
Parameter	Description
versionId1	The first version of the app or solution.
versionId2	The second version of the app or solution.
type query	Specifies the type of version IDs. Available values: APP, SOLUTION
Parameter	Description
tenantId	The tenant of the app or solution.
versionId	The version of the app or solution.
Parameter	Description
statusId	The unique Id of the diff or permission status.
Updated 15 May 2024
Did this page help you?
Managing App and Solution Artifacts
SDK Overview
Troubleshooting

Overview

Retrieve List of Changes

Retrieve Version Diffs

Retrieve Permission Diff

Retrieve Version or Permission Diff Status

Retrieve App and Solution Onboarding Activity Logs

﻿

﻿
