POST Relation
Some tooltip text!
• 5 minutes to read
• 5 minutes to read
POST /api/v1/Relation
Creates a new ContactRelationEntity
Calls the Relation agent service SaveContactRelationEntity.
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/Relation?$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 ContactRelationEntity to be saved.
| Property Name | Type | Description |
|---|---|---|
| SourceContactId | Integer | Id of the source contact. The value is mandatory. |
| SourcePersonId | Integer | Id of the source person. The value is not mandatory. The person must belong to the source contact. |
| DestinationContactId | Integer | Id of the destination contact. The value is mandatory. |
| DestinationPersonId | Integer | Id of the destination person. The value is not mandatory. The person must belong to the destination contact. |
| RelationId | Integer | Primary key |
| Comment | String | Comment for relation |
| RelationDefinitionId | Integer | Reference to definition |
| Reversed | Integer | Is direction reversed relative to definition |
| UpdatedDate | String | Last updated when in UTC. |
| CreatedDate | String | Registered when in UTC. |
| CreatedBy | Associate | Carrier object for Associate. Services for the Associate Carrier is available from the |
| UpdatedBy | Associate | Carrier object for Associate. Services for the Associate Carrier is available from the |
| SourceContactName | String | Name of the source contact. |
| SourcePersonName | String | Name of the source person. |
| DestinationContactName | String | Name of the destination contact. |
| DestinationPersonName | String | Name of the destination person. |
| ActiveText | String | Active text for the relation. |
| PassiveText | String | Passive text for the relation. |
Response:
OK
| Response | Description |
|---|---|
| 200 | OK |
Response body: ContactRelationEntityWithLinks
| Property Name | Type | Description |
|---|---|---|
| SourceContactId | int32 | Id of the source contact. The value is mandatory. |
| SourcePersonId | int32 | Id of the source person. The value is not mandatory. The person must belong to the source contact. |
| DestinationContactId | int32 | Id of the destination contact. The value is mandatory. |
| DestinationPersonId | int32 | Id of the destination person. The value is not mandatory. The person must belong to the destination contact. |
| RelationId | int32 | Primary key |
| Comment | string | Comment for relation |
| RelationDefinitionId | int32 | Reference to definition |
| Reversed | int32 | Is direction reversed relative to definition |
| UpdatedDate | date-time | Last updated when in UTC. |
| CreatedDate | date-time | Registered when in UTC. |
| CreatedBy | Associate | Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent. |
| UpdatedBy | Associate | Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent. |
| SourceContactName | string | Name of the source contact. |
| SourcePersonName | string | Name of the source person. |
| DestinationContactName | string | Name of the destination contact. |
| DestinationPersonName | string | Name of the destination person. |
| ActiveText | string | Active text for the relation. |
| PassiveText | string | Passive text for the relation. |
| 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/Relation
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: en
Content-Type: application/json; charset=utf-8
{
"SourceContactId": 721,
"SourcePersonId": 14,
"DestinationContactId": 287,
"DestinationPersonId": 674,
"RelationId": 376,
"Comment": "sed",
"RelationDefinitionId": 250,
"Reversed": 824,
"UpdatedDate": "2010-03-28T16:32:47.3996115+02:00",
"CreatedDate": "2013-01-26T16:32:47.3996115+01:00",
"CreatedBy": null,
"UpdatedBy": null,
"SourceContactName": "Padberg Group",
"SourcePersonName": "Fadel-Heaney",
"DestinationContactName": "Kohler LLC",
"DestinationPersonName": "Marvin Inc and Sons",
"ActiveText": "maiores",
"PassiveText": "voluptatem"
}
Sample response
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"SourceContactId": 54,
"SourcePersonId": 397,
"DestinationContactId": 99,
"DestinationPersonId": 861,
"RelationId": 700,
"Comment": "dolores",
"RelationDefinitionId": 937,
"Reversed": 866,
"UpdatedDate": "1998-05-03T16:32:47.3996115+02:00",
"CreatedDate": "2022-02-23T16:32:47.3996115+01:00",
"CreatedBy": null,
"UpdatedBy": null,
"SourceContactName": "Cronin LLC",
"SourcePersonName": "Schmitt-McKenzie",
"DestinationContactName": "Hane LLC",
"DestinationPersonName": "Hackett Group",
"ActiveText": "expedita",
"PassiveText": "eligendi",
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.String",
"FieldLength": 275
}
},
"_Links": {
"Self": "https://www.example.com/api/v1/project/321",
"Archive": "https://www.example.com/api/v1/project"
}
}