POST ForeignApp

• 4 minutes to read
 • 4 minutes to read 
POST /api/v1/ForeignApp

Creates a new ForeignAppEntity

Calls the ForeignSystem agent service SaveForeignAppEntity.

Query String Parameters

Parameter Name Type Description
$select string Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category" Default = show all fields. 
POST /api/v1/ForeignApp?$select=name,department,category/id

Request Headers

Parameter Name Description
Authorization Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type.
X-XSRF-TOKEN If not using Authorization header, you must provide XSRF value from cookie or hidden input field
Content-Type Content-type of the request body: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded, application/json-patch+json, application/merge-patch+json
Accept Content-type(s) you would like the response in: application/json, text/json, application/xml, text/xml, application/json-patch+json, application/merge-patch+json
Accept-Language Convert string references and multi-language values into a specified language (iso2) code.
SO-Language Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
SO-Culture Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
SO-TimeZone Specify the timezone code that you would like date/time responses converted to.
SO-AppToken The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Request Body: newEntity

The ForeignAppEntity to be saved.

Property Name Type Description
ForeignAppId Integer Primary key
Name String Name of foreign application
CreatedDate String Registered when in UTC.
UpdatedDate String Last updated when in UTC.
CreatedBy Associate The person that created the foreign application.
UpdatedBy Associate The person that last updated this foreign application.
Devices Array The devices that belong to this foreign app.

Response:

OK

Response Description
200 OK

Response body: ForeignAppEntityWithLinks

Property Name Type Description
ForeignAppId int32 Primary key
Name string Name of foreign application
CreatedDate date-time Registered when in UTC.
UpdatedDate date-time Last updated when in UTC.
CreatedBy Associate The person that created the foreign application.
UpdatedBy Associate The person that last updated this foreign application.
Devices array The devices that belong to this foreign app.
TableRight TableRight The carrier's table right
FieldProperties object Field property dictionary mapping field names to field access rights.
_Links object

Sample request

POST /api/v1/ForeignApp
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: en
Content-Type: application/json; charset=utf-8

{
  "ForeignAppId": 902,
  "Name": "Marvin, Kilback and Schaefer",
  "CreatedDate": "1999-12-05T16:32:47.5402031+01:00",
  "UpdatedDate": "2006-09-06T16:32:47.5402031+02:00",
  "CreatedBy": null,
  "UpdatedBy": null,
  "Devices": [
    {
      "ForeignDeviceId": 129,
      "Name": "Rowe-Jaskolski",
      "CreatedDate": "2006-09-07T16:32:47.5402031+02:00",
      "UpdatedDate": "2022-01-09T16:32:47.5402031+01:00",
      "AssociateFullName": "Dr. Roger Glover DDS",
      "CreatedBy": "magni",
      "UpdatedBy": "consequatur",
      "DeviceIdentifier": "veniam",
      "ForeignAppId": 418
    }
  ]
}

Sample response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "ForeignAppId": 738,
  "Name": "Huels-Gottlieb",
  "CreatedDate": "2007-09-17T16:32:47.5402031+02:00",
  "UpdatedDate": "2021-01-12T16:32:47.5402031+01:00",
  "CreatedBy": null,
  "UpdatedBy": null,
  "Devices": [
    {
      "ForeignDeviceId": 185,
      "Name": "Parker-Rice",
      "CreatedDate": "2016-02-26T16:32:47.5402031+01:00",
      "UpdatedDate": "2020-02-09T16:32:47.5402031+01:00",
      "AssociateFullName": "Rowan Christiansen",
      "CreatedBy": "voluptatem",
      "UpdatedBy": "placeat",
      "DeviceIdentifier": "numquam",
      "ForeignAppId": 760,
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.String",
          "FieldLength": 378
        }
      }
    }
  ],
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.Int32",
      "FieldLength": 302
    }
  },
  "_Links": {
    "Self": "https://www.example.com/api/v1/contact/321",
    "Archive": "https://www.example.com/api/v1/contact"
  }
}