Page Comparison

Excerpt

Creates a new entity/account as a child of another entity in the Rubiq database, with fields specified in a contract between the calling application and the Rubiq API. The parent-child relationship between the entities must be previously established in Rubiq Cloud.

Endpoint ID:

1005

Method:

Status

colour	Green
title	POST

URL:

/userentity/dp-keyid/{dpentity-keyid}/child/{contract-id}

/userentity/ext-key/{ext-key}/{ext-type}/child/{contract-id}

dp-key

dialogportal™ master key entity-id

Rubiq entity ID that uniquely identifies account that will be the parent of the new child's parent entity

ext-key

External key that uniquely identifies account that will be the parent of the identifies the new child's parent entity

ext-type

Type of external key

contract-id

Identifies the type of child to create and the set of contract fields passed in the request body

Request body:

JSON data with properties corresponding to the fields in the specified contract

Code Block

title	Example 1 - Contract specifies first name, last name and gender:

{
	"firstName": "John",
	"lastName": "Doe",
	"gender": "Male"
}

Span

style	white-space:pre

Response body:

JSON data with key(s) and data for the newly created

account and data for the account

child entity. The result will always hold the

dialogportal™ master key

Rubiq entity ID, and if the app making the request is configured to use a specific external key, this key is also included in the response.

Code Block

title	Example 1 – App setting specifies no specific key:

{
	"

dpKey

id": 123456
	"firstName": "John",
	"lastName": "Doe",
	"gender": "Male"
}

Code Block

title	Example 2 – App setting specifies external key type:

{
	"

dpKey

id": 123456,
	"extKeyType": 12,
	"extKey": "key",
	"firstName": "John",
	"lastName": "Doe",
	"gender": "Male"
}

Status codes:

201

Child was created with success

303

Child already exists, redirected to “Get Account Data”

400

Request is valid but data validation failed

...

Versions Compared

Old Version 2

New Version Current

Key