POST Session

Creates a new Session.

Request Information

URI Parameters

None.

Body Parameters

Login parameters:
- "IdentityRepositoryName" (area)
- "UserName"
- "Password" (optional)
- "Source" (optional)

Dictionary of string [key] and Object [value]

Request Formats

application/json, text/json

Sample:
{
  "Key 1": {},
  "Key 2": {}
}

application/xml, text/xml

Sample:
<ArrayOfKeyValueOfstringanyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
  <KeyValueOfstringanyType>
    <Key>Key 1</Key>
    <Value />
  </KeyValueOfstringanyType>
  <KeyValueOfstringanyType>
    <Key>Key 2</Key>
    <Value />
  </KeyValueOfstringanyType>
</ArrayOfKeyValueOfstringanyType>

application/x-www-form-urlencoded

Sample:

Response Information

Resource Description

The created Session resource.
The "Location" Header in the HttpResponseMessage contains the new resource URL.

Session
NameDescriptionTypeAdditional information
Id

string

None.

Token

string

None.

CreationDate

date

None.

Timestamp

date

None.

CurrentPosition

NamedReference

None.

CurrentOrganization

NamedReference

None.

CurrentUnit

NamedReference

None.

CurrentBlock

NamedReference

None.

CurrentAssignment

NamedReference

None.

IsTenantAdministrator

Collection of string

None.

CurrentAdministratedTenants

Collection of NamedReference

None.

MultiPosition

boolean

None.

DomainPermissions

Permissions

None.

IdentityReference

NamedReference

None.

Language

string

None.

Source

string

None.

TenantId

string

None.

SystemSession

boolean

None.

SystemUserSession

boolean

None.

NotificationKey

string

None.

Concurrent

boolean

None.

ExpertMode

boolean

None.

Partition

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": "sample string 1",
  "Token": "sample string 2",
  "CreationDate": "2024-04-25T23:46:20.1305887+02:00",
  "Timestamp": "2024-04-25T23:46:20.1305887+02:00",
  "CurrentPosition": {
    "Name": "sample string 1",
    "Url": "sample string 2",
    "Type": 0
  },
  "CurrentOrganization": {
    "Name": "sample string 1",
    "Url": "sample string 2",
    "Type": 0
  },
  "CurrentUnit": {
    "Name": "sample string 1",
    "Url": "sample string 2",
    "Type": 0
  },
  "CurrentBlock": {
    "Name": "sample string 1",
    "Url": "sample string 2",
    "Type": 0
  },
  "CurrentAssignment": {
    "Name": "sample string 1",
    "Url": "sample string 2",
    "Type": 0
  },
  "IsTenantAdministrator": [
    "sample string 1",
    "sample string 2"
  ],
  "CurrentAdministratedTenants": [
    {
      "Name": "sample string 1",
      "Url": "sample string 2",
      "Type": 0
    },
    {
      "Name": "sample string 1",
      "Url": "sample string 2",
      "Type": 0
    }
  ],
  "MultiPosition": true,
  "DomainPermissions": 0,
  "IdentityReference": {
    "Name": "sample string 1",
    "Url": "sample string 2",
    "Type": 0
  },
  "Language": "sample string 7",
  "Source": "sample string 8",
  "TenantId": "sample string 9",
  "SystemSession": true,
  "SystemUserSession": true,
  "NotificationKey": "sample string 12",
  "Concurrent": true,
  "ExpertMode": true,
  "Partition": "sample string 15"
}

application/xml, text/xml

Sample:
<Session xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.openworkbpm.com/schema">
  <Concurrent>true</Concurrent>
  <CreationDate>2024-04-25T23:46:20.1305887+02:00</CreationDate>
  <CurrentAdministratedTenants>
    <NamedReference>
      <Type>Undefined</Type>
      <Url>sample string 2</Url>
      <Name>sample string 1</Name>
    </NamedReference>
    <NamedReference>
      <Type>Undefined</Type>
      <Url>sample string 2</Url>
      <Name>sample string 1</Name>
    </NamedReference>
  </CurrentAdministratedTenants>
  <CurrentAssignment>
    <Type>Undefined</Type>
    <Url>sample string 2</Url>
    <Name>sample string 1</Name>
  </CurrentAssignment>
  <CurrentBlock>
    <Type>Undefined</Type>
    <Url>sample string 2</Url>
    <Name>sample string 1</Name>
  </CurrentBlock>
  <CurrentOrganization>
    <Type>Undefined</Type>
    <Url>sample string 2</Url>
    <Name>sample string 1</Name>
  </CurrentOrganization>
  <CurrentPosition>
    <Type>Undefined</Type>
    <Url>sample string 2</Url>
    <Name>sample string 1</Name>
  </CurrentPosition>
  <CurrentUnit>
    <Type>Undefined</Type>
    <Url>sample string 2</Url>
    <Name>sample string 1</Name>
  </CurrentUnit>
  <DomainPermissions>Undefined</DomainPermissions>
  <ExpertMode>true</ExpertMode>
  <Id>sample string 1</Id>
  <IdentityReference>
    <Type>Undefined</Type>
    <Url>sample string 2</Url>
    <Name>sample string 1</Name>
  </IdentityReference>
  <IsTenantAdministrator xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </IsTenantAdministrator>
  <Language>sample string 7</Language>
  <MultiPosition>true</MultiPosition>
  <NotificationKey>sample string 12</NotificationKey>
  <Partition>sample string 15</Partition>
  <Source>sample string 8</Source>
  <SystemSession>true</SystemSession>
  <SystemUserSession>true</SystemUserSession>
  <TenantId>sample string 9</TenantId>
  <Timestamp>2024-04-25T23:46:20.1305887+02:00</Timestamp>
  <Token>sample string 2</Token>
</Session>