Upload Application Schema

Integrating

POST

https://s360-apiqa.detsandbox.com/app/design/v1/application-schema/service/{serviceId}/{version}

Last modified:2024-09-26 11:41:36

OperationId:UploadApplicationSchema

Overview

During design time, Application Workspace shall upload the application object schema to the Service 360. The operation will upsert the schema into the Service 360 schema repository.

Remark:
1.
Service 360 will not maintain the history of the schema.
2.
appData element in this document is a mocked data.
3.
Application Workspace shall flag the data object in appData element which element is a document object by adding them in the appAttr.documents element. The appAttr.documents could contain zero or more documents object in flatten format.

Request

Authorization

Add parameter in header

X-API-Key

Example:

X-API-Key: ********************

Path Params

Header Params

Body Params application/json

Example

{
  "appData": {
    "InvestorProfile": {
      "FirstName": "",
      "LastName": "",
      "BirthDate": ""
    },
    "BusinessInformation": {
      "Passport": {
        "docType": "Passport",
        "files": []
      },
      "LicenseValidityStartDate": "",
      "LicenseValidityEndDate": "",
      "LegalDocuments": [
        {
          "NOC": {
            "docType": "NOC",
            "files": []
          },
          "EID": {
            "docType": "EID",
            "files": []
          }
        }
      ],
      "NumberofPartners": 0
    },
    "BusinessActivities": [
      {
        "BusinessActivityValue": "",
        "NumberofBranches": ""
      }
    ],
    "BusinessCountries": [
      ""
    ]
  },
  "appAttr": {
    "documents": [
      "BusinessInformation.Passport",
      "BusinessInformation.LegalDocuments.NOC",
      "BusinessInformation.LegalDocuments.EID"
    ]
  }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://s360-apiqa.detsandbox.com/app/design/v1/application-schema/service//' \
--header 'X-Request-Id: {% faker datatype.uuid %}' \
--header 'api_key: 5k5a9rnknaj87kthytganapc' \
--header 'Content-Type: application/json' \
--header 'X-API-Key;' \
--data-raw '{
  "appData": {
    "InvestorProfile": {
      "FirstName": "",
      "LastName": "",
      "BirthDate": ""
    },
    "BusinessInformation": {
      "Passport": {
        "docType": "Passport",
        "files": []
      },
      "LicenseValidityStartDate": "",
      "LicenseValidityEndDate": "",
      "LegalDocuments": [
        {
          "NOC": {
            "docType": "NOC",
            "files": []
          },
          "EID": {
            "docType": "EID",
            "files": []
          }
        }
      ],
      "NumberofPartners": 0
    },
    "BusinessActivities": [
      {
        "BusinessActivityValue": "",
        "NumberofBranches": ""
      }
    ],
    "BusinessCountries": [
      ""
    ]
  },
  "appAttr": {
    "documents": [
      "BusinessInformation.Passport",
      "BusinessInformation.LegalDocuments.NOC",
      "BusinessInformation.LegalDocuments.EID"
    ]
  }
}'

Responses

🟢200Success

application/json

Body

Example

{
    "status": 200,
    "externalId": "outsystem-external-id-12343",
    "esbUUID": "92037c84-70f3-4f17-b840-d0e038e506b7",
    "desc": {
        "code": "ESB-S360-S0000",
        "en": "Success",
        "ar": "نجاح"
    }
}

Modified at 2024-09-26 11:41:36

Get Reference Data from Entity

Upload Application Schema

Overview#

Request

Request samples

Responses

Overview